Operations

Firmware Management (Cluster Upgrades)

This section describes how to manage different firmware versions and perform cluster upgrades.

The upgrade process involves uploading a new image and then deploying it. As such, the same workflow can be used for cluster firmware downgrades as well.

note.gif

Note blank.gif This release of Nexus Dashboard does not support downgrades. If you want to downgrade to an earlier release, you will need to deploy a new cluster and reinstall the applications.

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.

    Regardless of whether you deployed your cluster using physical servers, VMware ESX OVA, or in Azure or AWS cloud, you will use the target release’s ISO image to upgrade.

  • Ensure that your current Nexus Dashboard cluster is healthy.

    You can check the system status on the System Overview page of the Nexus Dashboard GUI or by logging in to one of the nodes as rescue-user and executing the acs health command.

  • Ensure you backup the existing configuration, as described in Creating Configuration Backups.

  • You must not make any configuration changes to the cluster, such as adding worker or standby nodes, while the upgrade is in progress.

  • This release of Nexus Dashboard does not support downgrades.

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

Adding Images

Before you can upgrade your Nexus Dashboard cluster, you need to make the upgrade image available by adding it using the GUI.

  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 (nd-dk9.<version>.iso).

      note.gif

      Note blank.gif You must download the .iso image for all upgrades, even if you used the VMware ESX .ova, Linux KVM .qcow2, or a cloud provider’s marketplace for initial cluster deployment.

    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.

  2. Navigate to your Nexus Dashboard’s Admin Console.

  3. Add an image.

    503622.jpg

    1. From the main navigation menu, select Operations > Firmware Management.

    2. In the main pane, select the Images tab.

      The page will list any previously added images.

    3. In top right of the main pane, click the Actions menu and select Add Image.

  4. In the Add Firmware Image window that opens, choose whether your image is stored on a remote server or local system.

    1. If specifying a remote image, provide the full URL to the image.

    2. If uploading a local image, click Choose File and select the image file from your local system.

      note.gif

      Note blank.gif If uploading from a local machine, slow upload speeds may cause the session to timeout which can interrupt the transfer. We recommend at least 40Mbps upload speed and increasing the session timeout to 1800 seconds (from the default 1200). You can change session timeout in the Administrative > Security page in your Nexus Dashboard GUI.

  5. Click Upload to upload the image.

    The Images tab will show the image upload progress, wait for it to finish before proceeding to the next section.

Upgrading the Cluster

Before you Begin

You must have the upgrade image already added to the Nexus Dashboard cluster as described in Adding Images.

To upgrade your cluster:

  1. Navigate to your Nexus Dashboard’s Admin Console.

  2. Initiate an update.

    1. From the main navigation menu, select Operations > Firmware Management.

    2. In the main pane, select the Updates tab.

    3. Click Set up Update or Modify Details.

      If this is the first time you are upgrading your cluster, simply click the Setup Update button in the middle of the page.

      If you have previously upgraded the cluster, the last upgrade’s details will be displayed in this page instead of the Setup Update button. In this case, click the Modify Details button at the top right of the screen.

  3. In the Setup/Version Selection screen, select the target version and click Next to proceed.

    If you uploaded multiple images to your Nexus Dashboard, they will be listed here.

  4. In the Setup/Confirmation screen, review the details of the update and click Begin Install to proceed.

    The screen will proceed to the Install tab and you will be able to see the progress of each node.

    The process can take up to 20 minutes and you can navigate away from this screen in the meantime.

  5. Wait for the image installation to complete.

    You can check the installation status by navigating back to Operations > Firmware Management screen and clicking View Details link in the Last Status tile.

    503623.jpg

  6. Click Activate.

    If you navigated away from the installation screen, navigate back to Operations > Firmware Management screen and click View Details link in the Last Status tile.

    503624.jpg

    It may take up to 20 additional minute for all the cluster services to start and the GUI may become unavailable during this process. The page will automatically reload when the process is completed. You can track the activation process in the Activate screen as shown below.

Deleting Images

Nexus Dashboard will retain any firmware images that you upload to it. If at any time you want to remove any of the images (for example, from older upgrades), you can use the following steps:

  1. Navigate to your Nexus Dashboard’s Admin Console.

  2. From the main navigation menu, select Operations > Firmware Management.

  3. In the main pane, select the Images tab.

  4. Click the Actions (…​) menu next to the image you want to delete and select Delete Image.

  5. In top right of the main pane, click the Actions menu and select Delete Image.

  6. In the Confirm Delete prompt, click OK to confirm.

Tech Support

Tech support enables you to collect logs and activities in the system for further troubleshooting by Cisco TAC. Cisco Nexus Dashboard provides best-effort tech support collection and gives ability to download tech support for individual nodes, the whole cluster, or applications. Tech support files are hosted on the Cisco Nexus Dashboard and can be downloaded at any time.

To collect Tech Support information:

  1. Navigate to your Nexus Dashboard’s Admin Console.

  2. Collect Tech Support.

    503628.jpg

    1. From the main navigation menu, select Operations > Tech Support.

    2. In top right of the main pane, click the Actions menu and select Collect Tech Support.

  3. In the Collect Tech Support window that opens, provide a description.

  4. From the Scope dropdown, select the category for which you want to collect tech support information.

    • System collects Infra tech support information.

    • App Store collects App Store tech support information.

    • Service-specific selections collects tech support information for that specific service.

  5. Click Collect.

    After you begin Tech Support collection, you can see the progress in the same screen.

    If for any reason the tech support collection process fails, you can also obtain the same information by logging into each node as the rescue-user and running one of the acs techsupport collect commands. For more information about specific techsupport collect command options, see Useful Commands.

  6. Download the Tech Support archive.

    After the collection is finished, you can download the archive by clicking Download next it:

If you want to delete an existing Tech Support package, simply select it in the Tech Support screen and choose Delete Tech Support from the Actions menu.

Backup and Restore

This section describes how to back up or restore Nexus Dashboard cluster configuration.

Creating Configuration Backups

  1. Navigate to your Nexus Dashboard’s Admin Console.

  2. Start a back up.

    503630.jpg

    1. From the main navigation menu, select Operations > Backup & Restore.

    2. In the main pane, select the Backup Jobs tab.

    3. In top right of the main pane, click Backup Configuration.

  3. In the Backup Configuration window that opens, provide the Encryption Key and the File Name.

    The encryption key is used to encrypt the archive and must be at least 8 characters long.

  4. Click Download to start the backup.

    note.gif

    Note blank.gif Cisco Nexus Dashboard does not store configuration backups or encryption keys, so you must download and maintain them outside the Nexus Dashboard cluster.

Restoring Configuration

Before you begin

If your current configuration contains one or more of the following settings, you must remove them before restoring any backups:

To restore a configuration backup:

  1. Navigate to your Nexus Dashboard’s Admin Console.

  2. Begin configuration restore.

    503633.jpg

    1. From the main navigation menu, select Operations > Backup & Restore.

    2. In the main pane, select the Restore Jobs tab.

    3. In top right of the main pane, click the Restore Configuration.

      You do not need to select one of the listed backups. You will be asked to upload the configuration backup file in the next screen.

  3. Provide the details.

    1. Provide the Encryption Key.

      This must be the same encryption key that you used when creating the backup.

    2. Click Choose File and select the backup file.

      Cisco Nexus Dashboard does not store configuration backups, so you must upload the backup file before restoring it

      The file must be in .tgz or tar.gz format.

  4. Click Import to start the restore process.

Event Analytics

The Event Analytics page in the Operations category allows you to see the system-wide list of events and alerts in your Nexus Dashboard cluster.

Events

The Events tab enables you to easily access your Nexus Dashboard’s platform-level events and audit logs. The Audit Logs tab displays all events that occur during the cluster operation. In addition to viewing the events and logs directly in the Nexus Dashboard GUI, you can also configure the cluster to stream the events to an external syslog server, as described in Cluster Configuration.

The Events tab includes high severity events that may require your attention to resolve:

503667.jpg
Figure 9. Event Analytics

You can view a summary of all critical events in the list or double-click any specific event for additional information about it. After you have viewed and analyzed an event, you can choose to acknowledge and clear it by clicking the Actions (…​) menu next to the event in the list.

Audit Logs

Nexus Dashboard audit logging is automatically enabled when you first deploy the cluster and captures the operational changes made by the users in the environment.

You can view the audit logs directly in the GUI by selecting Operations > Audit Logs from the main navigation menu.

Note that the logs are not sorted by default; you can sort the list by clicking on any of the column headings.

You can choose to filter the list using the Filter by attributes field and providing a specific attribute and value pair.

503629.jpg
Figure 10. Audit Logs

Additionally, to view detailed information about a specific entry, simply click the entry in the list to open the Details tab.

Exporting Events

Nexus Dashboard can host multiple services one or more of which can generate various events, faults, and alerts. This information is published on and stored using Apache Kafka. While Release 2.1(2) allowed you to view and export cluster-level alerts to an external analyzer, there was no unified method to export all of this type of information to an external events monitoring service.

Beginning with Release 2.2(1), you can configure your cluster to export all platform-level, infrastructure-level, and service-level events to external monitoring and management systems. Each service running on Nexus Dashboard can define exactly which service-level events to aggregate and send to the cluster’s Kafka service to export.

When configuring event streaming, the following restrictions apply:

  • This release supports syslog event exporter only.

  • Events are stored for up to 4 hours by default.

To configure event exporting:

  1. Navigate to your Nexus Dashboard’s Admin Console.

  2. From the main navigation menu, select Infrastructure > Cluster Configuration.

  3. Click the Edit icon in the Syslog tile.

    In the Syslog dialog that opens, click +Add Remote Destinations to add a new server. Then provide the IP address, protocol, and port number for the server and choose whether you want to enable streaming to this syslog server at this time.

← Previous: Services Management 
↑ Up: Cisco Nexus Dashboard User Guide, Release 2.2.x 
Next: Infrastructure Management →