Skip to content

Nodes

The Nodes menu has three sub-menus in the navigation on the left.

Nodes Symbol Nodes > View is the default view of the Management System. It displays all registered nodes in a node list. You can filter, group and add nodes here. It mainly serves an organizational purpose and does not impact the functionality of the nodes.

Nodes can be managed in the node details view, which is reached by selecting a node of the node list. You can remove and edit nodes here.

Available updates for nodes can be found in the Nodes Symbol Nodes > Updates.

Performed node updates can be viewed in the Nodes Symbol Nodes > Update Log. When an update is performed, the update log also shows the current progress of the update.

Nodes View

Node list

The topics covered in this chapter are mainly means of organization and have no impact on the functionality of the nodes and their workloads. Select Nodes Symbol Nodes > View in the navigation on the left to display the list of registered nodes.

Note

Operational functions of the nodes are located in the node details view in the node details.

Filtering and grouping the node list

The node list supports filtering and grouping to help you quickly locate and organize nodes based on relevant attributes. These features improve navigation and provide a structured view of large node inventories.

Nodes filter and group

Item Description
Search nodes (1) Use the search nodes field to find matching text across all columns in the node list.
Filter (2) You can filter the node list using different filters to narrow down the displayed nodes according to your needs.
The following list provides an overview of all available filter categories:
  • Use the connection icon Connection icon to display online or offline nodes.
  • Use the Workload DNA or Node DNA icon to filter nodes by their workload DNA state or node DNA state.
  • Use the production mode icon Production mode icon to display nodes with production mode enabled or disabled.
A blue small number numeric cycle next to a filter icon indicates the number of selected filters for that filter category.
Select an icon of a filter category, then select clear filter Reset to clear the selected filter.
Group (3) You can group the nodes to organize the node list according to your needs.
Select the group by icon Group by icon to configure up to three grouping levels. Nodes can be grouped by Node version, Device type, Secure boot, Timezone, labels or by Node DNA metadata.
For more information about labels refer to Labels.
For more information about Node DNA metadata refer to Nerve DNA
Options (4) Select the more options Options icon to collapse all collapse or expand all expand the node list.
Select the options Options icon and than clear filter Reset all to clear all filters.

Adding a node

Nodes can only be added to the Management System if they have been configured in the Local UI, as the serial number and secure ID of the node are required. Refer to Node configuration before continuing.

Nodes running version 3.0 or later can be added entirely through the Local UI. For nodes running earlier versions, add them to the node list by following the steps below:

  1. Select Nodes Symbol Nodes > View in the navigation on the left.
  2. Select the more options Options icon.
  3. Select Node Add Node.

    Add new node

  4. Enter the following information.

    Add new node

    Item Description
    Name (1) Enter the name for the node that will make it easy to identify.
    Secure ID (2) Enter the secure ID that is generated when the node is configured in the Local UI. Refer to Node configuration for more information.
    Serial Number (3) Enter the serial number of the Nerve Device that was defined during node configuration.
  5. Select Save.

Note

The Nerve Device Name is recognized automatically, so the corresponding field is filled out with the value received from the node. Ensure that the added device for the node is qualified for the Management System. For more information refer to the Device Guide.

The node now appears in the node list and can be worked with. At first, the node is marked as offline. It can take up to a minute until the node is shown as online in the Management System. The Management System refreshes automatically.

Moving a node from one folder to another

Moving nodes in the node list is very straightforward and intuitive and possible by drag and drop when at least one label is selected for grouping.

Besides drag and drop, the nodes can be moved to another folder by reassigning the labels manually in the node details Labels tab.

Note

Not all properties used for grouping can be modified. For example, Device Type, Secure Boot, Time Zone, and Node Version are fixed properties. Therefore, drag-and-drop for these folders does not work.

  1. Select Nodes Symbol Nodes > View in the navigation on the left.
  2. Select the group by icon Group by icon.
  3. Select at least one label (Maximum 3 grouping levels).
    The node list is grouped by the selected label value.
  4. Expand the node list using the options Option expand all expand all in the upper right corner of the list.

    Expand node list

  5. Choose the node to move.

  6. Drag and drop the node to the desired label value. The management system unassigns and assigns the label automatically from the moved node.

    Drag and Drop

The assigned label has been updated and the node is now displayed in the folder corresponding to its newly assigned label.

Result

Columns of the node list

The node list displays node information in a table format. The section below explains the purpose of each column.

Result

Item Description
Name (1) This is the name of the node.
Indicators (2) The icons provide a quick visual overview of the current node state. Hover over an icon to view more detailed information about the corresponding status.

connection icon The Connection icon's color indicates the node's status:
circle icon The node is online.
circle icon The node is offline.

DNA iconWorkloads icon The Workload DNA icon's colors indicate the status of the workload DNA.
DNANode The Node DNA icon's colors indicate the status of the node DNA.
circle icon Initial - not yet applied
circle icon Applied
circle icon Canceling
circle icon Modified
circle icon Reconfiguring
circle icon Undefined
circle icon n/a

production mode icon The Production mode icon's color indicates whether production mode is enabled or not:
circle icon The production mode is enabled.
circle icon The production mode is disabled.
Serial Number (3) This is the serial number of the node that was defined during node configuration.
Node Version (4) This is the version of the node reflecting the version of the Nerve software.
Device Type (5) This is the device the node is hosted on.
IP Address (6) This is the IP address of the node.
Last System Start (7) This is the latest date the node was started in the format DD/MM/YYYY, hh:mm:ss.
Last Seen (8) This is the date the node details were last viewed by the logged in user of the Management System in the format DD/MM/YYYY, hh:mm:ss.
Action (9) This column contains icons representing actions. Selecting the Connect Connections icon opens an overlay, through which a remote connection to the node can be established. Refer to Remote Connections for more information.

Managing nodes in the node details

Once nodes are registered in the Management System, they are available in the node list. To manage the details of a node, select the node in the node list. Each node can have different tabs for different options depending on nodes configuration and the user's permissions.

If you select a node the columns Name and Indicators of the node list is viewed. Searching and filtering is also possible.

Overview tab

The overview tab is the main tab containing most of the features available. It is automatically active when a node is selected.

Node Details Overview tab

Item Description
Node name (1) Here is the name of the node shown. You can edit the name of the node by selecting the edit Edit icon.
Serial number, Version and Device type (2) Here the serial number, the version and the device type of the node are shown. The version is also the product version of Nerve installed on the node.
Hover over the device type and select the show image icon Show image icon to show the device image. Hover over the device image (5) and select the hide image icon Hide image icon to hide the device image again.
Indicators (3) The icons provide a quick visual overview of the current node state. Hover over an icon to view more detailed information about the corresponding status. For more information about the colors refer to Columns of the node list.
For more information about DNA refer to DNA tab.
For more information about production mode refer to Production mode.
Tab selector (4) Switch between different tabs to trigger different views. Each node can have different tabs for different options depending on the nodes configuration and the user's permissions. The tabs are:
  • Overview tab
    This is the main tab containing most of the features available. It is automatically active when a node is selected.
  • Logs tab
    This tab contains all settings related to logging and monitoring.
  • DNA tab
    Select this tab to use Nerve DNA.
  • Volumes tab
    Use this tab to manage Docker volumes.
  • Remote Connections tab
    Use this tab to manage remote connections for a node.
  • Labels tab
    Use the tab to assign or unassign labels to a node.
Device image (5) An image of the hardware model is displayed here according to the device type that was selected when the node was configured.
Hover over the device image and select the hide image icon Hide image icon to hide the device image. Hover over the device type (1) in the header and select the show image icon Show image icon to show the device image again.
System metrics (6) Wan address
This is the network address of the node that has been assigned by the DHCP server

System metrics
The system metrics that are available in the Local UI dashboard are also visible here:
  • CPU
    The percentage here shows how much processing power is being used in total at the moment. This includes CPUs that have been assigned to VMs and Docker containers as well.
  • Memory usage
    Similar to CPU usage, the percentage of memory used in total at the moment is shown here. This includes memory that has been assigned to VMs or Docker containers.
  • Docker used space
    Two things are shown in this graph: The percentage shows how much of the available space for Docker containers is already used. The value shows the amount of space that is free. Docker containers have their dedicated virtual partition.
  • VM used space
    Similar to Docker used space, two things are shown in this graph as well: The percentage shows how much of the available space for virtual machines is already used. The value shows the amount of free space.

    Note that deployed Virtual Machine workloads share a logical volume group with the Nerve Base System. Therefore the percentages and values displayed in this graph are in relation to the total amount of space available of the logical volume group.
Node information (7) Life cycle events
  • Created
    This is the date when the node was added to the Management System in the format DD/MM/YYYY, hh:mm:ss.
  • Last system start
    This is the timestamp of the last node restart in the format DD/MM/YYYY, hh:mm:ss.
Node details
  • Secure boot
    The status of the secure boot and disk encryption.
  • Timezone
    The time zone where the node is registered.
Metadata
The metadata that is defined via the Node DNA is listed here. If no metadata is defined, this section shows "No metadata to show."
For more details refer to Nerve DNA

Labels
Labels that are assigned to this node are listed here. Labels can be assigned in the Labels tab.
For more information about labels refer to Labels.

Capabilities
The capabilities of each node are available as a list in both the Local UI and the Management System. A capability represents a specific feature or a set of features allowing the node to run workloads, to provide logs etc. For more information refer to Node capabilities

Select hide icon Show expand the node information.
Select hide icon Hide collapse the node information.
Node actions (8) Connect Connect
Selecting this icon opens an overlay, through which a remote connection to the node can be established. Refer to Remote Connections for more information.

clean up Remove unused Docker image
Selecting this icon removes unused images from a node. For more information refer to Docker registry.

Reboot node Reboot node
Selecting this icon will reboot the node after a confirmation dialog. Select Yes to initiate the reboot. All running workloads will be stopped. After the reboot, the workloads will return to their previous state. Running workloads will be started. Stopped workloads will stay stopped.

production mode Enable Production mode
Selecting this icon enables or disables the production mode. For more information refer to Production Mode.

delete node Delete node
Selecting this icon removes the node from the Management System after a confirmation dialog. Select Yes to initiate the removal. The node needs to be registered again after removal.
Workloads overview (9) Workloads that have been deployed to the node are listed here.
Use the search workloads field to find matching text across all workloads of the node.

You can filter the workload list to narrow down the displayed workloads according to your needs. The following filters are available:
pause pause icon Workload Status: Filter workloads based on their current status.
Workloads Workload Type: Filter workloads by their type.

Select options Options to toggle between table view and card view for the list of workloads here.
Table view gives the following information on workloads:
  • Workload status
    The symbol here indicates the status of the workload:
    • green play symbol The play icon indicates that the workload is currently running.
    • empty green play symbol The empty play icon indicates that the Docker Compose workload is partially running, meaning that some services are running while others are stopped, starting, or suspended.
    • yellow pause symbol The pause icon indicates that the workload is suspended.
    • black stop symbol The stop icon indicates that the workload is stopped.
    • Triangular warning sign The triangular warning sign indicates that an error has ben encountered.
    • idle icon The hourglass icon indicates that the workload is idle.
  • Workload type
    The symbol of the workload type (CODESYS, Docker, Docker Compose and VM) is displayed here.
  • Name
    This is the name of the workload.
  • Version
    This is the name of the workload version.
  • CPU
    This column shows values for VM and Docker workloads. The percentage here shows the usage of CPU resources in relation to the assigned CPUs.
  • RAM
    Similar to the CPU usage statistic, the percentage here shows the usage of system memory resources in relation to the assigned memory. This column only shows values for Docker workloads.
  • Deployed
    This is the date and time the workload was deployed in the format DD/MM/YYYY, hh:mm::ss.
  • Last state change
    This is the date and time the workload changed from its previous state to its current state, for example when a running workload was stopped. The format is DD/MM/YYYY, hh:mm::ss.
  • Connections
    Selecting the Connect shows the remote connections of the workload. Refer to Remote Connections for more information.
Selecting a workload leads to a control area in which the workload can be controlled. Workload control features depend on the workload type. If there are no tiles or rows of workloads, no workloads have been deployed to the node. Refer to Workload control for more information.

Logs tab

Select this tab for a way to access logging and monitoring dashboards in OpenSearch. Note that data is not collected out of the box with the exception of system logs. Users with the Admin role need to define which logs the node collects. Select enable in the drop-down menu of each category and select Save on the right to start collecting data.

For more detailed information, refer to Logging and monitoring.

The dashboards are split into the following categories:

Category Items and descriptions
System View system logs View System logs
Selecting this will open a new window and show the system logs of the node. The log levels can be defined here. For more information about log levels refer to Log levels The internal node logs are aimed at Nerve service technicians in case of error and failure. Data is stored and visualized with OpenSearch. The amount of logs can be modified through system log settings by Nerve service technicians. Contact customer support for more information.

View system metrics View System logs
Select this to view the node's resource utilization as a whole.
Docker Docker workload logs View System logs
Select this to view application logs sent from Docker workloads on the node to the Management System.

Docker workload metrics View System logs
Select this to view gathered metadata about installed Docker containers, as well as the monitoring of their resource utilization.
Node Trigger from the Management System View System logs
Select this to view logs triggered by the Management System in OpenSearch Dashboard.

Trigger from the Node View System logs
Select this to view logs triggered by the Node in OpenSearch Dashboard.

DNA tab

The DNA tab contains a way to operate workload DNA and node DNA through the Management System UI. Refer to Nerve DNA UI in the Management System for more information on the content of the DNA tab. Also, refer to Nerve DNA for more information on Nerve DNA in general.

Volumes tab

The Volumes tab provides a list of all available Docker volumes on the node. The definition of the Docker volumes takes place during the provisioning of a Docker workload (for more information refer to Provisioning a Docker workload).

Docker Volumes on the node

The list contains the following information:

  • Volume name given during provisioning the Docker workload,
  • The memory Size of the Docker volume.
  • The Workload version to which the Docker volume is assigned to.

The following table gives you an overview which actions you can perform for a Docker volume.

Actions Items and Description
Delete Select the delete icon delete icon to delete volumes from the node which are not assigned to a Docker workload version.
Note that you cannot delete Docker volumes from the node, when they are assigned to a Docker workload version. This is indicated by a gray delete icon delete disabled.
Import To import data to a Docker volume, proceed as follows:
  1. Select the import icon import icon.
  2. Choose the ZIP file you want to import and confirm it with OK.
    • During the import, the import icon turns orange.
    • When the import is successful the icon turns blue again.
    • If a problem occurs during the import, the icon turns red and a notification with a description of the problem appears.
Should your Docker container require a restart to process the imported data please do so manually in the Overview tab or in Workload control.
Export To export data from a Docker volume, proceed as follows:
  1. Select the export icon export icon.
    • During the export, the icon turns orange.
    • The node delivers the Docker volume content to the Management System. When the export is successful the icon turns blue again and a ZIP file is ready for downloading download icon in the column Download link.
    • If a problem occurs during the export, the icon turns red and a notification with a description of the problem appears.
  2. Select the ZIP file to download the export to your workstation.
    Note that the ZIP file is three days available for download.
Cancel Select the cancel icon cancel icon, to cancel the import or export. Note that this function is only available during an import or export.

Remote Connections tab

Remote connections are optional. Remote connections can be configured at any time.
Select screen iconplus icon Add new Remote screen or tunnel iconplus icon Add new Remote Tunnel to configure a remote connection to the node.

Refer to Remote connections for more information and instructions for all remote connection types.

Labels tab

Add labels to the node for easier identification and workload deployment. Note that labels have to be created first before they can be assigned to nodes. Refer to Manage node labels for more information.

Node capabilities

The capabilities of each node are available as a list in both the Local UI and the Management System. A capability represents a specific feature or a set of features allowing the node to run workloads, to provide logs etc. As of now, most nodes share the same list of capabilities. In the future, with increasing modularity in the Nerve solution, the list will differ based on the specific Nerve solution running on the node.

Reach the list of node capabilities in the following locations:

Location Path
Local UI
  1. Log in to the Local UI.
  2. Select Node configuration in the navigation on the left.
  3. Select Capabilities.
Management System
  1. Log in to the Management System
  2. Select Nodes Symbol Nodes > View.
  3. Select a node from the node list.
  4. Select the Overview tab
  5. Select show Show capabilities.

Here is a list of all currently available capabilities:

Capability Description
Virtualization via ACRN The node is running on the ACRN hypervisor.
Virtualization via KVM The node is running on the KVM hypervisor.
Virtualization via Xen The node is running on the Xen hypervisor.
Hypervisor The node supports virtualization using Xen or KVM and provides the following features:
  • vGPU
  • GPU passthrough
  • VM snapshotting
CODESYS PLC The CODESYS application is installed and the execution of CODESYS workloads is possible.
Docker Container Docker container technology is included and the node can run Docker workloads.
Docker Compose Docker Compose technology is included and the node can manage multiple Docker containers under one Docker Compose workload.
Docker Compose Service Control Docker Compose Service Control is available on the node and allows users to manage services, including start, stop, restart, and status monitoring operations.
Audit logs Audit logging is available on the node, providing a record of relevant system and user activities.
Logging via FluentBit A daemon is running on the node that sends logs and metrics to the Management System.
System log filtering Enables filtering of system logs on the node to display only relevant entries.
Management System Registry The node can access and use the Management System Registry to download Docker container images for workload deployment.
Production mode Production mode can be enabled or disabled on the node.
Secure boot Secure boot can be enabled or disabled on the node.
TPM2 is available only when secure boot is present on the node.

Updating a node to a new version

Nodes are updated through the Management System where currently available updates are listed. Note that nodes can only be updated in order, meaning that node versions cannot be skipped. When an update is started, a snapshot of the user data is made and running workloads are stopped. Reverting to the previous version is possible. Workloads remain stopped after an update or revert.

Note

  • Before updating to a newer version, make sure to back up any user created data, e.g. gateway configuration files in the Data Services.
  • By updating a node, the passwords to the Local UI and host access are reset if they have not been changed by the user. Local UI and host access passwords set by the user persist through updates.
  • When updating older versions of nodes, refer to the compatibility matrix in the release notes to make sure if the incremental node update is possible from the used version of the node.
  • Nodes below version 2.1.0 need to be updated manually by installing an image at the node. Refer to Manual image installation for more information.
  1. Navigate to Nodes Symbol Nodes > Updates in the navigation on the left.
  2. Select a node version from the list. Available nodes for the update to the selected version will appear on the right.

    Update Nodes

  3. Tick the checkboxes next to the nodes that will be updated.

  4. Select Update.

    Update Nodes

  5. Select Yes in the pop-up window.

The Management System will display the log screen where the update is shown as in progress. The progress bar here shows the progress of the entire update campaign if more than one node has been selected before. Click the progress bar to see the progress of the update to each node.

Note

There are two possible error states in case the node update fails:

  • Fail
    Support needs to take action. Contact TTTech Industrial customer support by writing an issue through the TTTech Industrial support portal.
  • Not Responding
    In this case, attempt a physical reboot by unplugging the node from power and plugging it back in again. The node should come online with the new version installed. However, the update log will still show the update as In progress. Select the ellipsis menu in the update log and select MARK AS FINISHED to manually mark the node update as finished.

    Mark as finished

Update log

Performed node updates can be viewed in the Nodes Symbol Nodes > Update Log. When an update is performed, the update log also shows the current progress of the update.

Update log

Item Description
Update Operation (1) Indicates the type of update operation that was performed on the node.
Status (2) Displays the current status of the update operation.
Started (3) The timestamp when the update operation started in the format DD/MM/YYYY, hh:mm:ss.
Finished (4) The timestamp when the update operation finished in the format DD/MM/YYYY, hh:mm:ss.

Deleting an update log entry

  1. Select Nodes > Update Log in the menu on the left side.
  2. Select the Delete icon delete icon in the Action column of the update log entry you want to delete.
  3. Select Yes to confirm the deletion.