Skip to main content
This section provides the purpose, elements, and actions performed on the Upgrade pages.

​
Purpose

The Upgrade page helps you keep the Controller and gateways up to date with a rolling selective upgrade process. View controller version information and gateway upgrade requirements, and create or manage upgrade groups so you can upgrade gateways in logical groups and minimize disruption.

​
Elements

Upgrade: Upgrade Plan
  • Controller: Controller version information section showing Current Version and Latest Version.
  • Dry Run: Button to perform a dry run of the upgrade process.
  • Prepare For Software Upgrade: Button to prepare the controller for software upgrade.
  • Gateways Requiring Upgrade: Section showing count of gateways requiring Software Upgrade and Image Upgrade.
  • Prepare For Upgrade: Button to prepare selected gateways for upgrade.
  • Software Upgrade: Card showing current software upgrade progress.
  • View Log: Button to view upgrade logs.
  • Upgrade Group: Button to create a new upgrade group.
  • Show filters: Button to show filters for the upgrade groups table.
  • Select columns: Button to select columns for the upgrade groups table.
  • Export: Export button to download upgrade groups data.
  • Search: Search box for filtering table content.
  • Default View: Dropdown to select default view or modified view for the table.
  • Save View: Button to save the current view configuration.
  • More Options: Button to access additional view options.
  • View Gateway Instances: Button to view gateway instances for an upgrade group.

​
Actions

To view the upgrade plan:
  1. Go to Administration > Upgrade.
  2. The page appears with Controller version info, Dry Run, Prepare For Software Upgrade, Gateways Requiring Upgrade, upgrade groups table, and Upgrade Group.
  3. Optionally, use Show filters, Select columns, Export, Search, or View Gateway Instances to inspect groups.
The upgrade plan shows controller and gateway upgrade status and upgrade groups.

​
Parameter Details

Sl. No.CoPilot Parameter NameDescription
1OrderShows the order/priority of the upgrade group in the upgrade plan.
2NameShows the name of the upgrade group.
3Gateway TypeShows the type of gateway (e.g., Transit, Spoke).
4Gateway InstanceShows the number of gateway instances in the upgrade group.
5Software VersionShows the current software version of gateways in the group.
6Image VersionShows the current image version of gateways in the group.
7Kernel VersionShows the current kernel version of gateways in the group.
8AccountShows the cloud account associated with the upgrade group.
9CloudShows the cloud provider (e.g., AWS, Azure, GCP).
10RegionShows the cloud region where gateways in the group are located.
11Upgrade Group StatusShows the current status of the upgrade group (e.g., Pending, In Progress).
To create an upgrade group:
  1. Go to Administration > Upgrade.
  2. Click Upgrade Group (or + Upgrade Group).
  3. In the dialog, enter a group Name, select matching conditions (Gateway type, cloud, region, account, gateway name, current image version, kernel version; combine with AND or OR), and set group order (e.g., Place Upgrade Group: Above, Below, Top, or Bottom). Click Save.
A notification appears and the new upgrade group is added to the upgrade plan.

​
Parameter Details

Sl. No.CoPilot Parameter NameDescription
1NameEnter a name for the upgrade group.
2Matching conditionsSelect criteria: Gateway type, cloud, region, account, gateway name, current image version, kernel version. Combine with AND or OR. Enable Preview to view matching gateways.
3Place Upgrade Group (group order)Select where to place the group: Above, Below, Top, or Bottom relative to existing groups; or set order number.