Upgrading Nexus Dashboard

Prerequisites and Guidelines

Before you upgrade your existing Nexus Dashboard cluster:

  • Ensure that you have read the target release's Release Notes for any changes in behavior, guidelines, and issues that may affect your upgrade.

    The upgrade process is the same for all Nexus Dashboard form factors. However, if your existing cluster is deployed using physical servers, VMware ESX, Linux KVM, Azure, or AWS, you will use the target release's ISO image (nd-dk9.<version>.iso) to upgrade; if your existing cluster is deployed in Red Hat Enterprise Linux, you will use the RHEL-specific image (nd-rhel-<version>.tar).

  • Ensure that you have read the Release Notes and upgrade guides for any services you run in the existing cluster and plan to run on the target release for service-specific changes in behavior, guidelines, and issues that may affect your upgrade.

    You can find the service-specific documents at the following links:

  • If you are upgrading a physical Nexus Dashboard cluster, ensure that the nodes have the minimum supported CIMC version for the target Nexus Dashboard release.

    Supported CIMC versions are listed in the Nexus Dashboard Release Notes for the target release.

    CIMC upgrade is described in detail in the "Troubleshooting" sections of the Nexus Dashboard User Guide.

  • If you are upgrading a virtual Nexus Dashboard cluster deployed in VMware ESX, ensure that the ESX version is still supported by the target release.

    Supported ESX versions are listed in the Prerequisites and Guidelines section for VMware deployments.


    Note

    If you need to upgrade the ESX server, you must do that before upgrading your Nexus Dashboard to the target release:

    1. Upgrade one of the ESX hosts as you typically would with your existing Nexus Dashboard node VM running.

    2. After the host is upgraded, ensure that the Nexus Dashboard cluster is still operational and healthy.

    3. Repeat the upgrade on the other ESX hosts one at a time.

    4. After all ESX hosts are upgraded and the existing Nexus Dashboard cluster is healthy, proceed with upgrading your Nexus Dashboard to the target release as described in the following section.

  • You must perform configuration backups of your Nexus Dashboard and services before the upgrade to safeguard data and minimize any potential risk before proceeding with the upgrade.

  • You must be running Nexus Dashboard release 2.2(1) or later to upgrade directly to release 3.0(1).


    Note

    Additional upgrade path and minimum version requirements may depend on the specific services you have installed in your cluster. Check the service-specific Release Notes and Upgrade Guides linked above for more information.

  • You must disable all services running in the cluster before upgrading to release 3.0(1) or later.


    Note

    After you have upgraded your Nexus Dashboard to release 3.0(1) or later, you must also upgrade all existing services to the versions compatible with the new Nexus Dashboard version.

    When upgrading the services, you must not re-enable the existing versions that you had disabled prior to the Nexus Dashboard upgrade.

    You must also not delete the existing versions of the service, which may now display an App Version not compatible. Upgrade required. error:

  • You must have valid DNS and NTP servers configured and reachable by all cluster nodes.

  • Ensure that your current Nexus Dashboard cluster is healthy.

    You can check the system status on the Overview page of the Nexus Dashboard's Admin Console or by logging in to one of the nodes as rescue-user and ensuring that the acs health command returns All components are healthy.

  • Ensure that no configuration changes are made to the cluster, such as adding worker or standby nodes, while the upgrade is in progress.

  • Nexus Dashboard does not support platform downgrades.

    If you want to downgrade to an earlier release, you will need to deploy a new cluster and reinstall the services.

Upgrading Nexus Dashboard

This section describes how to upgrade an existing Nexus Dashboard cluster.


Note

The following steps illustrate the upgrade workflow from Nexus Dashboard release 2.2.2. If you are upgrading from release 2.3(x), the UI may differ slightly but the upgrade workflow and functionality remains the same.

Before you begin

Procedure

Step 1

Download the Nexus Dashboard image.

  1. Browse to the Software Download page.

    https://software.cisco.com/download/home/286327743/type/286328258

  2. Choose the Nexus Dashboard version you want to download.

  3. Download the Cisco Nexus Dashboard image for your target release.

    Note

     

    • If your Nexus Dashboard is deployed in Red Hat Enterprise Linux, you must download the .tar image (nd-rhel-<version>.tar) to perform the upgrade.

      More information about RHEL deployments is available in Deploying in Existing Red Hat Enterprise Linux Installation.

    • For all other form factors, you must download the .iso image (nd-dk9.<version>.iso) to perform the upgrade.

      For example, even if you used the virtual form factors, such as the .ova image for deploying in VMware ESX, or a cloud provider's marketplace for initial cluster deployment, you must still use the .iso image for upgrades.

  4. (Optional) Host the image on a web server in your environment.

    When you upload the image to your Nexus Dashboard cluster, you will have an option to provide a direct URL to the image.

Step 2

Log in to your current Nexus Dashboard GUI as an Administrator user and navigate to the Admin Console.

Step 3

Disable any existing services installed in the cluster.

Note

 

You must disable all services before you upgrade the cluster.

  1. From the main navigation menu, select Services.

  2. In the service's tile, click the Actions (…) menu and choose Disable.

  3. Repeat this step for all other services deployed in the cluster.

Step 4

Delete any existing upgrade images from your cluster.

If this is the first time you're upgrading your cluster, you can skip this step.

If you had previously upgraded your cluster to your current version, you must delete all previous upgrade images.

  1. Navigate to Operations > Firmware Management.

  2. Select the Images tab.

  3. From the actions menu (…) next to an existing upgrade image, choose Delete Image.

  4. Repeat this step for all existing upgrade images.

Step 5

Upload the new image to the cluster.

  1. Navigate to Operations > Firmware Management.

  2. Select the Images tab.

  3. Click Add Image.

Step 6

Select the new image.

  1. In the Add Firmware Image window, select Local.

    Alternatively, if you hosted the image on a web server, choose Remote instead.

  2. Click Select file and select the .iso or .tar image you downloaded in the first step.

    For RHEL deployments, use the .tar file to upgrade. For all other deployment factors, use the .iso file.

    If you chose to upload a remote image, provide the file path for the image on the remote server.

  3. Click Upload to add the image.

    The image will be uploaded to the Nexus Dashboard cluster, unpacked, processed, and made available for the upgrade. The whole process may take several minutes and you will be able to see the status of the process in the Images tab.

Step 7

Wait for the image status to change to Downloaded.

You can check the status of the image download progress in the Images.

Step 8

Set up the update.

  1. Navigate to Operations > Firmware Management.

  2. Select the Updates tab.

  3. Click Set Up Update.

    Note

     

    If you had upgraded your cluster before, the page shows the previous upgrade's details instead. In that case, click the Modify Details button in the top right of the page to provide new upgrade information.

    The Firmware Update screen opens.

Step 9

Start the upgrade.

  1. In the Firmware Update > Version selection screen, select the firmware version you uploaded and click Next.

  2. In the Firmware Update > Confirmation screen, verify the details and click Validate.

    The setup goes through a number of preparation and validation stages to ensure successful upgrade. This may take several minutes to complete.

  3. After the validation is complete, click Install.

    The installation progress window is displayed. You can navigate away from this screen while the update is in progress. To check on the update status at a later time, navigate to the Firmware Management screen and click View Details in the Last Update Status tile.

    This will set up the required Kubernetes images and services but will not switch the cluster to the new version. The cluster will continue to run the existing version until you activate the new image in the next step. This step may take up to 20 minutes.

Step 10

Activate the new image.

If you never navigated away from the upgrade screen, simply click Activate to activate the new image.

Otherwise:

  1. Navigate back to the Operations > Firmware Management screen

  2. In the Last Update Status tile, click Continue.

    In some of the earlier Nexus Dashboard versions, this link may be called View Details instead.

  3. In the Firmware Update > Install screen, click Activate.

    It may take up to 20 additional minutes for all the cluster services to start and the GUI to become available. The page will automatically reload when the process is completed.

Step 11

Upgrade the individual services deployed in the cluster.

Ensure that you have read the upgrade guides specific to the services that you are upgrading:

Note

 

After you have upgraded your Nexus Dashboard to release 3.0(1) or later, you must upgrade all existing services to the versions compatible with the new Nexus Dashboard version.

When upgrading the services, you must not re-enable the existing versions that you had disabled prior to the Nexus Dashboard upgrade.

You must also not delete the existing versions of the service, which may now display an App Version not compatible. Upgrade required. error:

Step 12

(Optional) Migrate to the new UCS-C225-M6 hardware.

Note

 

If you do not plan to replace your Nexus Dashboard nodes with the new UCS-C225-M6 servers, you can skip this step.

To migrate your existing Nexus Dashboard cluster deployed using UCS-C220-M5 hardware, you can simply add a new UCS-C225-M6 node as a stadby node to the existing cluster and fail over one of the older nodes. Then repeat the process one node at a time for the remaining nodes of the older cluster. Adding and using stadby nodes is described in detail in the "Infrastructure Management" chapter of the Nexus Dashboard User Guide.