Appendix - Deploy and Run UFM Plugins

NVIDIA UFM Enterprise Appliance Software User Manual v1.7.0

UFM plugins are service programs that can be dynamically loaded to extend the functionality of UFM Enterprise.

The plugins are Docker containers, and their life cycle is being managed by UFM.

Functions commonly added by optional UFM plugins include:

  • REST-RDMA (REST requests over IB to the UFM server)

  • NDT (NDT topo diff)

  • ALM (Autonomous Link Maintenance)

  • GNMI

The UFM plugin lifecycle is managed by UFM. It is the user's responsibility to pull/load the plugin Docker container image on both master and standby nodes.

  • Add - The plugin’s data is copied to the host. In case UFM is running, it will be started.

  • Disable - The plugin is stopped immediately if UFM is running, and it will not start upon UFM start. However, its data is still accessible via the host.

  • Enable - The plugin is re-started immediately if UFM running or on the next UFM start.

  • Remove - The plugin is stopped, and all its data is removed.

  • Pull the UFM plugin image. Run:

    Copy
    Copied!
                

    docker pull mellanox/ufm-plugin-ndt:1.1.1-17 

  • Alternatively, load the UFM plugin image. Run:

    Copy
    Copied!
                

    image fetch sftp://root:123456@192.168.1.10/tmp/ufm-plugin-ndt_1.1.1-17-docker.img.gz  docker load ufm-plugin-ndt_1.1.1-17-docker.img.gz

  • Review the plugin image.

    Copy
    Copied!
                

    Show docker images  --------------------------------------------------------------------- Image                        Version   Created        Size    Digest --------------------------------------------------------------------- mellanox/ufm-plugin-ndt      1.1.1-17  2 months ago   1.59GB  <none>

  • Deploy the plugin. Run:

    Copy
    Copied!
                

    ufm plugin ndt add tag 1.1.1-17 

  • Review the plugin settings. Run:

    Copy
    Copied!
                

    Show ufm plugin  Plugin ndt:    Enabled:           Yes     Plugin tag:        1.1.1-17     Shared volumes:    /opt/ufm/files/log:/log,/dev:/host_dev     HTTPD port:        8980     HTTPD file:        Present     State:             running     CPU limit:         unlimited 

Warning

The plugin’s Docker container is started/stopped upon UFM start/stop. In case UFM is already running when the plugin is added/enabled, it will be started. While, in case it is disabled/removed, it will be stopped.

For the relevant CLI commands, refer to UFM Plugins and Docker Container.

© Copyright 2023, NVIDIA. Last updated on Mar 7, 2024.