Autonomous Link Maintenance (ALM) Plugin
The primary objective of the Autonomous Link Maintenance (ALM) plugin is to enhance cluster availability and improve the rate of job completion. This objective is accomplished by utilizing machine learning (ML) models to predict potential link failures. The plugin then isolates the expected failing links, implements maintenance procedures on them, and subsequently restores the fixed links to their original state by removing the isolation.
The ALM plugin performs the following tasks:
Collects telemetry data from UFM and employs ML jobs to predict which ports need to be isolated/de-isolated
Identifies potential link failures and isolates them to avert any interruption to traffic flow
Maintains a record of maintenance procedures that can be executed to restore an isolated link
After performing the required maintenance, the system verifies if the links can be de-isolated and restored to operational status (brought back online)
The ALM plugin operates in the following two distinct modes:
Shadow mode
Collects telemetry data, runs ML prediction jobs, and saves the predictions to files.
Active mode
Collects telemetry data, runs ML prediction jobs, and saves the predictions to files.
Automatically isolates and de-isolates based on predictions.
It is essential to note that a subset of the links must be specified in the allow list to enable this functionality.
The Autonomous Link Maintenance (ALM) plugin can be deployed using the following methods:
On the UFM Appliance
On the UFM Software
To deploy the plugin, follow these steps:
Download the ufm-plugin-alm-image from the NVIDIA License Portal (NLP).
Load the downloaded image onto the UFM server. This can be done either by using the UFM GUI by navigating to the Settings -> Plugins Management tab or by loading the image via the following instructions:
Log in to the UFM server terminal.
Run:
docker load -I <path_to_image>
After successfully loading the plugin image, the plugin should become visible within the plugins management table within the UFM GUI. To initiate the plugin’s execution, simply right-click on the respective in the table.
![ALM-version-1-modificationdate-1714386962740-api-v2.png](https://docscontent.nvidia.com/dims4/default/b49bcf5/2147483647/strip/true/crop/953x399+0+0/resize/953x399!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2FALM-version-1-modificationdate-1714386962740-api-v2.png)
The supported InfiniBand hardware technologies are HDR, Beta on NDR.
The ALM plugin collects data from the UFM Enterprise appliance in the following two methods:
Low-frequency collection: This process occurs every 7 minutes and gathers data for the following counter: hist0, hist1, hist2, hist3, hist4, phy_effective_errors, phy_symbol_errors
High-frequency collection : This process occurs every 10 seconds and gathers data for the following counters: phy_state,logical_state,link_speed_active,link_width_active,fec_mode_active, raw_ber,eff_ber,symbol_ber,phy_raw_errors_lane0,phy_raw_errors_lane1,phy_raw_errors_lane2, phy_raw_errors_lane3,phy_effective_errors,phy_symbol_errors,time_since_last_clear, hist0,hist1,hist2,hist3,hist4,switch_temperature,CableInfo.temperature,link_down_events, plr_rcv_codes,plr_rcv_code_err,plr_rcv_uncorrectable_code,plr_xmit_codes,plr_xmit_retry_codes, plr_xmit_retry_events,plr_sync_events,hi_retransmission_rate,fast_link_up_status, time_to_link_up,status_opcode,status_message,down_blame,local_reason_opcode, remote_reason_opcode,e2e_reason_opcode,num_of_ber_alarams,PortRcvRemotePhysicalErrorsExtended, PortRcvErrorsExtended,PortXmitDiscardsExtended,PortRcvSwitchRelayErrorsExtended,PortRcvConstraintErrorsExtended, VL15DroppedExtended,PortXmitWaitExtended,PortXmitDataExtended,PortRcvDataExtended,PortXmitPktsExtended, PortRcvPktsExtended,PortUniCastXmitPktsExtended,PortUniCastRcvPktsExtended,PortMultiCastXmitPktsExtended,PortMultiCastRcvPktsExtended
The collected counters can be configurable and customized to suit your requirements. The counters can be found at /opt/ufm/conf/plugins/alm/counters.cfg
The ALM configuration is used for controlling isolation/de-isolation. The configuration can be found under /opt/ufm/cyber-ai/conf/cyberai.cfg.
Name |
Section name |
Description |
mode |
Prediction |
The mode can be either "active" or "shadow." In active mode, the ALM will enforce isolation/deisolation rules on all ports which predict to fail except those listed in the "expect" list. In shadow mode, the ALM will enforce isolation/deisolation rules on the ports listed in the "except" list, and predict to fail. |
except_list |
Prediction |
Includes the ports that receive the opposite treatment compared to the mode. the expect list saved in location /opt/ufm/files/conf/plugin/alm/predict.csv Format: port_guid,port_number 0x1070fd03001769b4,1 0x1070fd03001769b4,3 |
mode |
NOC |
The mode can be either "active" or "shadow." In active mode, the ALM will enforce isolation/deisolation rules on all ports that considered as out of nominal condition except those listed in the "expect" list. In shadow mode, the ALM will enforce isolation/deisolation rules on the ports listed in the "except" list. |
except_list |
NOC |
Includes the ports that receive the opposite treatment compared to the mode. the expect list saved in location /opt/ufm/files/conf/plugin/alm/noc.csv Format: port_guid,port_number 0x1070fd03001769b4,1 0x1070fd03001769b4,3 |
max_per_hour |
Isolation |
The maximum number of ports that can be isolated in a hour |
max_per_week |
Isolation |
Maximum number of ports that can be isolated in a week |
max_per_month |
Isolation |
Maximum number of the ports that can be isolated in a month |
min_links_per_switch_pair |
Isolation |
Minimum links between two switches to perform isolation |
min_active_ports_per_switch |
Isolation |
Minimum number of active ports per switch before perform isolation |
Deisolation_time |
DeIsolation |
The waiting time before deisolate the isolated port |
max_per_hour |
DeIsolation |
The maximum number of deisolated port per hour |
absolute_threshold_of_isolated_ports |
Isolation |
The maximum number of ports than can be isolated in one sample |
After the successful deployment of the plugin, a new item is shown in the UFM side menu for the ALM plugin:
![image-2024-4-18_15-18-9-version-1-modificationdate-1714386977783-api-v2.png](https://docscontent.nvidia.com/dims4/default/fd66c44/2147483647/strip/true/crop/194x493+0+0/resize/194x493!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2Fimage-2024-4-18_15-18-9-version-1-modificationdate-1714386977783-api-v2.png)
Current State
This page displays a table presenting the current cluster status, outlining the following counts:
Number of ports
Number of isolated ports
Number of ports in active/shadow prediction mode
Number of ports in active/shadow NOC mode
Number of ports out of NOC
![image-2024-4-18_15-31-51-version-1-modificationdate-1714386978077-api-v2.png](https://docscontent.nvidia.com/dims4/default/10e73f4/2147483647/strip/true/crop/928x451+0+0/resize/928x451!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2Fimage-2024-4-18_15-31-51-version-1-modificationdate-1714386978077-api-v2.png)
Events Summary
This page displays a table presenting a port count summary, outlining the following counts:
Number of isolated ports in the past hour, week, and month for ‘host to switch’ and ‘switch to switch’.
Number of de-isolated ports in the past hour, week, and month for ‘host to switch’ and ‘switch to switch’.
Number of isolation actions not taken from prediction by ALM in the past hour, week, and month for ‘host to switch’ and ‘switch to switch’.
Number of isolation actions not taken from NOC by ALM in the past hour, week, and month for ‘host to switch’ and ‘switch to switch’.
![image-2024-4-18_15-26-46-version-1-modificationdate-1714386978450-api-v2.png](https://docscontent.nvidia.com/dims4/default/8dff661/2147483647/strip/true/crop/939x397+0+0/resize/939x397!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2Fimage-2024-4-18_15-26-46-version-1-modificationdate-1714386978450-api-v2.png)
Port Level Status
This page displays a table presenting the cluster ports.
![image-2024-4-18_16-33-9-version-1-modificationdate-1714386979040-api-v2.png](https://docscontent.nvidia.com/dims4/default/ad2d78d/2147483647/strip/true/crop/1388x534+0+0/resize/1388x534!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2Fimage-2024-4-18_16-33-9-version-1-modificationdate-1714386979040-api-v2.png)
Model Performance
Different metrics can measure the performance and accuracy of the ALM model, these metrics will be exposed to the user through the table as follows
![image-2024-4-20_22-3-17-version-1-modificationdate-1714386979310-api-v2.png](https://docscontent.nvidia.com/dims4/default/06c1f01/2147483647/strip/true/crop/1830x467+0+0/resize/1440x367!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2Fimage-2024-4-20_22-3-17-version-1-modificationdate-1714386979310-api-v2.png)
Configuration
This page displays ALM plugin configuration update method.
The ALM configuration is divided into four sections:
General Configurations
![image-2024-4-19_23-46-31-version-1-modificationdate-1714386979573-api-v2.png](https://docscontent.nvidia.com/dims4/default/1507528/2147483647/strip/true/crop/1028x684+0+0/resize/1028x684!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2Fimage-2024-4-19_23-46-31-version-1-modificationdate-1714386979573-api-v2.png)
Prediction Mode
![image-2024-4-19_23-48-10-version-1-modificationdate-1714386979887-api-v2.png](https://docscontent.nvidia.com/dims4/default/00281db/2147483647/strip/true/crop/1020x287+0+0/resize/1020x287!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2Fimage-2024-4-19_23-48-10-version-1-modificationdate-1714386979887-api-v2.png)
NOC Mode
![image-2024-4-19_23-48-40-version-1-modificationdate-1714386980283-api-v2.png](https://docscontent.nvidia.com/dims4/default/2d5801d/2147483647/strip/true/crop/1019x284+0+0/resize/1019x284!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2Fimage-2024-4-19_23-48-40-version-1-modificationdate-1714386980283-api-v2.png)
ML Model Configurations
![image-2024-4-19_23-49-13-version-1-modificationdate-1714386980607-api-v2.png](https://docscontent.nvidia.com/dims4/default/2ee0e68/2147483647/strip/true/crop/1018x187+0+0/resize/1018x187!/quality/90/?url=https%3A%2F%2Fk3-prod-nvidia-docs.s3.us-west-2.amazonaws.com%2Fbrightspot%2Fconfluence%2F00000190-2bc7-d1d5-a3b6-fbef25350000%2Fimages%2Fdownload%2Fattachments%2F2756305513%2Fimage-2024-4-19_23-49-13-version-1-modificationdate-1714386980607-api-v2.png)
The table presented below displays the names and descriptions of ALM jobs. These jobs are designed to predict the ports that require isolation/de-isolation. Upon enabling the ALM plugin, these ALM jobs run periodically.
ALM Job Name |
Description |
Frequency |
Port_hist |
By using the low frequency bit error histogram counters, the ALM job identifies the ports that will be monitored at high frequency in the next time interval. The job generates an output file that is later read by the high frequency telemetry monitoring job. It prioritizes links that are more susceptible to failure. |
7 mins |
Low_freq_predict |
Predicts the likelihood of a port failure by analyzing input data from low frequency telemetry, while only utilizing physical layer counters. The prediction works for isolated ports as well. The resulting output from this task serves as a critical input for determining whether to isolate or de-isolate ports. |
7 mins |