> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aviatrix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Upgrade

> This section provides the purpose, elements, and actions performed on the Upgrade pages.

This section provides the purpose, elements, and actions performed on the
**Upgrade** pages.

<Tabs>
  <Tab title="Upgrade">
    ## 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

    <Frame>
      <img
        src={
  "/images/reference/ui/administration/upgrade-plan.png"
}
        alt="Upgrade: Upgrade Plan"
        width="100%"
      />
    </Frame>

    * **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

    <AccordionGroup>
      <Accordion title="View Upgrade Plan">
        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

        | CoPilot Parameter Name | Description |
        | - | - |
        | Order | Shows the order/priority of the upgrade group in the upgrade plan. |
        | Name | Shows the name of the upgrade group. |
        | Gateway Type | Shows the type of gateway (e.g., Transit, Spoke). |
        | Gateway Instance | Shows the number of gateway instances in the upgrade group. |
        | Software Version | Shows the current software version of gateways in the group. |
        | Image Version | Shows the current image version of gateways in the group. |
        | Kernel Version | Shows the current kernel version of gateways in the group. |
        | Account | Shows the cloud account associated with the upgrade group. |
        | Cloud | Shows the cloud provider (e.g., AWS, Azure, GCP). |
        | Region | Shows the cloud region where gateways in the group are located. |
        | Upgrade Group Status | Shows the current status of the upgrade group (e.g., Pending, In Progress). |
      </Accordion>

      <Accordion title="Create Upgrade Group">
        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

        | CoPilot Parameter Name | Description |
        | - | - |
        | Name | Enter a name for the upgrade group. |
        | Matching conditions | Select criteria: Gateway type, cloud, region, account, gateway name, current image version, kernel version. Combine with AND or OR. Enable Preview to view matching gateways. |
        | Place Upgrade Group (group order) | Select where to place the group: Above, Below, Top, or Bottom relative to existing groups; or set order number. |
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.