Networking NMX Manager (NMX-M) Documentation

Installation Procedure

The NMX-M installation process is now simplified using a one-click shell script that ensures full air-gapped support. The below are detailed instructions on how to seamlessly install NMX-M on your dedicated machines. 

Make sure that NMX-M is being deployed in a secure environment.

The NMX-M package is distributed as a single tarball: NMX-M-<VERSION>.tar.gz.

Within this tarball, there are 2 tar archives: the VM image tar, and another tarball containing the NMX-M installation package. Untar the tar ball using tar -xvf NMX-M-<VERSION>.tar.gz.

Installing the VM Image

To install the VM image, follow the steps below: 

  1. Extract NMX-MGR-<VERSION>-KVM.tar.gz

  2. Mount the VM image ( .qcow2 file) using the appropriate KVM commands

    Example: Copy the Base image to  - /var/lib/libvirt/images/ 

    virt-install --connect qemu:///system --ram 512000 -n ubuntu1 --os-type linux --os-variant generic --vcpus=48 --disk path=/var/lib/libvirt/images/ubuntu-24.04-nmx-base.qcow2,format=qcow2,device=disk,bus=virtio --vnc --noautoconsole --import --network=bridge=br0,model=virtio,mac=<MAC> --check all=off
    


  3. Log in to the nvidia user account on each of the three servers using the default password Nmx@123

  4. Upon first login, you will be prompted to set a new password.
    Use the same new password on all three servers.
    Note: Changing the password will automatically log you out.

  5. Re-login as the nvidia user using the new password on only one of the servers.
    The remaining installation steps will be performed only on this server.

Installing NMX Manager (NMX-M)

To install the NMX Manager (NMX-M) software package, follow the steps below:

  1. Copy the `NMX-MGR-M-<VERSION>.tar.gz ` file to one of the VMs. Once the tarball is in place, execute the following command to extract its contents:

    tar -xzf NMX-MGR-M-*.tar.gz

  2. Navigate to the created `NMX-M` directory:

    cd NMX-M

  3. Ensure you are in sudo mode before proceeding with the installation.  

    sudo su

  4. Run the installation script: 

    ./install.sh
    


  5. Install the required tools. The installation script will begin by installing all the necessary tools to support the installation. This includes:

    •    Ansible
    •    kubectl
    •    zarf
    •    helm

  6. Configure the Kubernetes Cluster. You will be required to specify the IP addresses of three server Virtual Machines (VMs). Please note that exactly three VMs are required for this configuration. server1 should be the IP address of the VM where the installation is currently being executed.

  7. Additionally, during the setup process, you will be required to enter the SSH password.

  8. Install RKE2. The script will proceed by running the RKE2 (Rancher Kubernetes Engine 2) installation.

  9. Register the services:To configure mTLS and register the services manually - see the (85.1.2000-PG) NMX Services Registration page.To configure mTLS and register the services automatically - see the (85.1.2000-PG) Bring-Up page.

  10. Set the API user passwords. You will be asked twice to set passwords for the API users `ro-user ` and `rw-user`. Each password must be at least 8 characters long and include a mix of letters and numbers.

  11. The script installs the infrastructure components.

  12. The script installs the NMX-M Microservices.

If the installation encounters an error, the script allows you to resume from the last successful step.


Last updated: