Node Tree#
The Node Tree is the first screen you will see after logging in to the Management System. It presents an overview of all nodes that are connected to the Management System, embedded into tree view elements. Being mainly a means of organization, it has no impact on the functionality of the nodes and their workloads.
There is only one element under the root after the initial setup: Root > Unassigned. All nodes that are registered in the Management System are placed in the Unassigned element by default. From there they can be moved to new elements that have to be created first.
Creating a New Element in the Node Tree#
Before you can move a node out of the Unassigned element, you have to create a new element in the Node Tree. Elements in the Node Tree exclusively serve an organizational purpose.
- Select Node Tree in the left-hand menu.
-
Select the ellipsis menu to the right of Root in the Node Tree.
-
Click Add in the overlay that popped up.
-
Enter the name of the new element under Location name.
-
Click Save.
-
Select APPLY CHANGES (n) in the upper-right corner of the Node Tree.
Note
(n)
is a placeholder for the number of changes made to the Node Tree. If you have performed three changes, you will see(3)
in the button above the Node Tree.
The new element now appears under the Root element.
You can create more elements and modify the Node Tree to your liking. To the right of every created element, you can see an ellipsis menu that opens up an overlay. Here you can add additional elements below the new element, edit the name of the element or delete the new element.
Note
- The order of the tree elements can be modified easily. You can just drag and drop the elements to the position you wish.
- When a tree element is deleted, all of the nodes inside the element will be moved to Unassigned.
Moving a Node from One Tree Element to Another#
Moving nodes in the Node Tree is very straightforward and intuitive and possible by drag and drop. Please make sure that you have created a new tree element before attempting to move a node.
- Select Node Tree in the left-hand menu.
- Expand the tree element of the node you want to move. The default element is Root > Unassigned.
- Choose the node you want to move.
- Drag and drop the node to the newly created element. Elements expand automatically once you hover over them.
-
Select APPLY CHANGES (n) in the upper-right corner of the Node Tree.
Note
(n)
is a placeholder for the number of changes made to the Node Tree. If you have performed three changes, you will see(3)
in the button above the Node Tree.
The node has now been moved to the new element.
Note
A node cannot be moved back to Unassigned once it has been moved to another element.
Managing Nodes in the Node Tree#
Once you have nodes connected to the Management System, you can view their details next to the Node Tree. To view the details of a node, choose a node and click the node name or symbol.
Item | Description |
---|---|
Node name and serial (1) | Here the name and serial number of the node are shown. The serial number is next to the name in brackets. Please note that the serial number of the node is its default name if you have not defined a node name in the registration process. Also, depending on your Nerve Device, the command line tool might extend the serial number to 12 characters. Please make sure to take note of that after registering a Nerve Device. |
System metrics (2) | The system metrics that are available in the local UI dashboard are also visible here:
|
NODE VERSION (3) | The version of the node. This is set to 2.0.0 by default if the node version has not been set in the registration process. |
CREATED (4) | This is the date when the node was added to the Management System. |
WAN ADDRESS (5) | This is the network address of the node that has been assigned by the DHCP server. |
LABELS (6) | Here you can see labels that are assigned to this node. Labels can be set in the registration process and the Management System. See Labels for more information. |
SHOW LOGS (7) | Clicking here will open a new window and show the system logs of the node. The logs are visualized with the Kibana application. However, please note that the logs shown are unfiltered and therefore require expert knowledge due to their number and contents. If clicking here does not show logs in the Kibana application, please contact TTTech Industrial customer support. |
Delete node (8) | Clicking here removes the node from the Management System. The node needs to be registered again after it has been removed. |
Workloads overview (9) | Here you will find workloads that have been deployed to the Nerve Device displayed in tiles. Clicking these tiles leads to a control area in which you can control the workload. If there are no tiles, no workloads have been deployed to the Nerve Device. |
Workload Control#
All workloads that have been deployed to the node are displayed in tiles below the node details in the Node Tree. Clicking these tiles allows you to control the respective workload.
Note
CODESYS workloads can only be controlled from the local UI.
The workload control screen offers the same options for both Virtual Machine workloads and Docker workloads.
Item | Description |
---|---|
Back button (1) | Click here to return to the Node Tree. |
Workload name (2) | This is the name of the workload. The name of the workload version is not displayed here. |
Workload status (3) | The current status of the workload is displayed here. The possible statuses are the following:
|
Control panel (4) | There are five control options for workloads here:
|
Undeploy (5) | Clicking this removes the workload from the node. The tile in the node detail screen disappears. The workload stays in the list of workloads in the Management System and can be deployed again at any time. |
Message window (6) | The message window displays the latest message the workload has sent out. The type of message that is displayed here depends on the workload. Here is a list of messages that are valid for VMs and Docker containers:
For VMs, there is an additional set of messages:
CODESYS workloads have the following set of messages:
|
Usage statistics (7) | Virtual Machine workloads and Docker workloads have their assigned resources they can use. The use of these resources is displayed with bar graphs:
|