Upgrading Commander

This topic provides information to upgrade a previous version of Commander.

Note: If you need help with the upgrade process, contact Customer Support.

Before you begin the upgrade process

  • Review Supported upgrade paths to see whether a direct upgrade from your currently installed version is supported.
  • Review Changes affecting upgrading users to understand any Commander user interface and operational changes that the newer release may introduce for users
  • Process any in-flight service requests before upgrading.
  • Back up Commander and its database before upgrading. See the Knowledge Base article Microsoft SQL Maintenance Planning for Embotics vCommander.

    Notes:  

    • We recommend performing the upgrade during a maintenance window, as Commander will be unavailable during the upgrade process. Depending on the database size and content, the upgrade process may take a significant amount of time.
    • You can only upgrade from a database of the same type. If you want to change from the default to SQL server or vice versa, you must uninstall and reinstall Commander, in which case all your system and user data is overwritten.
  • If you use the VM Access Proxy (formerly the Console Proxy), see Upgrade and Redeploy the Commander VM Access Proxy to ensure that you perform the steps for both upgrade tasks in the proper order.
  • If you added one or more Kubernetes clusters as cloud accounts in version 7.0.1, remove them prior to upgrade. You can safely re-add them after upgrade.
  • If you added plug-in workflow steps to a 7.0.1 vCommander installation, you must remove them prior to upgrade. After upgrade, download the latest plug-in workflow steps from https://github.com/Embotics/Plug-in-Workflow-Steps. These plug-in steps are compatible with vCommander release 7.0.2 or higher. Then, install the new plug-in step packages.
  • If you were managing Azure Classic (also known as Azure Service Manager), we recommend removing the cloud account before upgrade. If you don't remove the cloud account before upgrade, it will be removed as part of the upgrade, along with any deployment destinations targeting it. Azure Classic is no longer supported as a cloud platform.

Supported upgrade paths

Consult the following table to see whether a direct upgrade from your currently installed version is supported:

Current installed version Direct upgrade supported to

8.0.x

8.1.x, 8.2.x, 8.3.x

7.5.x

8.0.x

7.1.x

7.5.x

7.0.x

7.1.x

6.1.x

7.0.x, 7.1.x

Caution: Billing Data Reset (from release 7.5.x to 8.0.x)

    Upon upgrade to 8.0.x, all your existing AWS and GCP costing data will be reset to be able to determine the charge type for each record. Azure costing data will also be reset, but all charges will be listed as Resource Usage.

    For AWS and Azure, this data reset may take some time, depending on the amount of billing data you have. You can't use Costing features such as Cost Analytics and Costing Reports during billing data reset.

    For AWS, Commander will do the following:

    1. Check how many days of billing records exist (find the oldest date of billing data).
    2. Delete all the existing AWS billing records.
    3. Try to reset all the data from the S3 bucket (as far back as the oldest date of data that existed before the upgrade). If there’s a purge policy on the S3 bucket, there's a chance that not all the deleted data in Commander can be reset.

    If the reset task fails, you may still be able to retrieve your costing data manually using a system property (embotics.billing.retrieval.windowsize) to set the number of days worth of billing data to fetch. If you have a nightly scheduled billing retrieval task, be sure to retrieve the data manually before your nightly scheduled task runs. After you've retrieved the data, return the system property back to the previous setting.

    If you need help with manual billing retrieval, contact Customer Support.

Changes to system requirements

As of version 8.1, the following changes were made to the Commander system requirements:

  • Microsoft Windows Server 2012 R2 and Windows Server 2012: Support for Microsoft Windows Server 2012 R2 and Windows Server 2012 has been removed.
  • Microsoft SQL Server 2012: Our support for Microsoft SQL Server 2012 now requires SP4.

    Note: As of Release 8.1, Microsoft Windows Server 2019 and Microsoft SQL Server 2019 are now supported for use with Commander.

It's also recommended that you review the System Requirements before upgrading. See also Deprecated and Removed Features and Platforms.

Changes affecting upgrading users

The following changes were made in version 8.3:

Performing the upgrade

To upgrade from a previous version:

  1. Back up the Commander database.
  2. To keep a copy of your configuration, record the values of any system properties that you customized for your current Commander installation. (Commander system properties have the format "-Dembotics.<setting>=<value>" and are used to tweak Commander default settings.)
  3. Double-click the installation executable.
  4. In the Installation wizard, click Next.
  5. Accept the terms of the license agreement and click Next.
  6. Review the customer experience information, then click Next.
  7. Select Upgrade to the new version (system and user data will be preserved) and click Next.
  8. Review the upgrade-related warnings, enable Continue Upgrade to confirm the upgrade, and click Next.
  9. Review the Pre-installation Summary and click Install.
  10. Follow the wizard and, if required, edit any of the fields that appear in the displayed pages and click Next.

    For more information, see the Installation Table.

  11. Click Done when you're finished.
  12. After the upgrade is completed, the Commander Windows service restarts. Once the service is started, it typically takes about five minutes before the application is fully initialized and available for use.
  13. Launch Commander at https://<server hostname or IP address> using your browser and the credentials you normally use.

    If you specified a non-default vCommander port, the URL to access Commander is
    https://<server hostname or IP address>:<port>.

    Best Practice: After upgrading, always clear your browser cache to ensure that drop-down menus, directory trees and images display properly.

    Note: A Database Maintenance scheduled task is scheduled to run once on the Saturday following the upgrade, at 2:00 a.m. This task creates database indexes which speed up cloud account reconnection and Commander service restart. Once the scheduled task has run successfully, the task is automatically deleted. It's not possible to delete this task manually. You can change the time when this scheduled task runs. See Configuring the Database Maintenance task schedule.