> ## 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 Your Controller to the Latest Aviatrix Supported Images (AWS and Azure Only)

> This documentation aims at providing steps on upgrading your Controller to the latest Aviatrix images.

This documentation aims at providing steps on upgrading your Controller to the
latest Aviatrix images.

<Note>
  This upgrade workflow only applies to AWS and Azure. Contact [Aviatrix
  Support](https://support.aviatrix.com) if your Controller and Gateways are
  deployed on other cloud service provides.
</Note>

For the major upgrade paths, see <a href={"/docs/enterprise/" + "10.1" +
"/reference/ui/administration/maintenance#major-upgrade-paths"}>Major Upgrade
Paths</a>.

<a id="start-help-controller-before-upgrade" />

## Before Upgrade

Before you upgrade your Controller and Gateways, it is highly recommended to
check the <a href={"/docs/enterprise/" + "10.1" +
"/guides/maintenance/controller-upgrade-planning"}>prerequisites</a> to ensure
that your Controller meets the upgrade requirements.

### Perform the Pre-upgrade Tasks

Check and perform all the pre-upgrade tasks. See details in <a href={"/docs/enterprise/" + "10.1" +
"/guides/maintenance/upgrade-overview"}>Upgrade Overview</a>.

### Check the Upgrade Checklist

Perform all the items listed in the upgrade checklist.

<a href={"/docs/enterprise/" + "10.1" + "/guides/maintenance/controller-upgrade-checklist"}>Go through Checklist of the Controller and Gateway Upgrade</a>
.

<a id="end-help-controller-before-upgrade" />

## Upgrade Your Controller to the Latest Aviatrix Supported Images

There are four phases of upgrading your Controller:

1. Run the [Readiness Check](#run-the-readiness-check-for-the-upgrade).
2. Review the [Readiness Check Result](#review-the-readiness-check-result).
3. [Perform the Upgrade](#perform-an-image-upgrade-of-your-controller-to-the-latest-aviatrix-supported-images).
4. [Verify the Upgrade](#verify-your-controller-upgrade-status).

<a id="controller-upgrade-dry-run" />

<a id="start-help-controller-upgrade-dry-run" />

## Run the Readiness Check for the Upgrade

The Readiness Check reviews compatibility, prerequisites, and known issues to
better prepare for a successful upgrade. For full details, see <a href={"/docs/enterprise/" + "10.1" +
"/guides/maintenance/controller-upgrade-readiness-check"}>Readiness Check for
the Aviatrix Controller Upgrade</a>.

Confirm your Controller version meets the required 7.1.4101. You can check your
Controller version on the Controller Upgrade page at *CoPilot >
Administration > Maintenance > Controller Upgrade*.

Perform the following steps:

1. From *CoPilot > Administration > Maintenance > Controller Upgrade*, select
   the *Target Version* to check against.

2. Click *Run Readiness Check*.

<a id="review-dryrun-result" />

<a id="start-help-review-dryrun-result" />

<a id="end-help-controller-upgrade-dry-run" />

## Review the Readiness Check Result

1. On the *CoPilot > Administration > Maintenance > Controller Upgrade* page,
   review the **Failed (Blocker)**, **Failed (Non-Blocker)**, **Could Not Run**,
   and **Passed** counts, then review each listed issue. Solve any blocking
   issues as indicated. See <a href={"/docs/enterprise/" + "10.1" +
   "/guides/maintenance/controller-gateway-upgrade-troubleshooting"}>Troubleshooting
   Controller and Gateway Upgrades</a>.

2. Once you have resolved the identified issues, click *Re-Run Readiness Check*
   to run the check again.

<a id="controller-image-upgrade" />

<a id="start-help-controller-image-upgrade" />

<a id="end-help-review-dryrun-result" />

## Perform an Image Upgrade of your Controller to the Latest Aviatrix Supported Images

<Warning>
  During the upgrade, you will not be able to change the settings in Aviatrix
  Network and Security. You will be temporarily logged out of CoPilot and unable
  to access the Controller. For minimal disruption, we recommend performing this
  upgrade during your maintenance window. Your Aviatrix data plane will continue
  to function normally during the Controller image upgrade process.
</Warning>

Perform the following steps to upgrade your Controller and Gateways to the
latest Aviatrix supported images.

1. Enter your upgrade time limit. The upgrade of your Controller will take from
   30 to 60 minutes based on your deployment size. You can set a time limit for
   the upgrade to enable appropriate actions if the process exceeds the expected
   duration. For large networks with more than 500 gateways, set the time to at
   least 2 hours.

   Choose one of the following actions when the upgrade time limit expires:

   * *Revert the Controller to its Previous State*: This option allows reverting
     the Controller back to its previous state if the upgrade does not complete
     within the set time limit. This option helps to prevent prolonged system
     downtime or instability.
   * *Continue Attempting the Upgrade*: Selecting this option allows the system
     to continue attempting the upgrade indefinitely, regardless of the time
     limit or user inaction. Users can also choose to revert the upgrade or
     proceed to complete the upgrade. This option might be suitable if the
     upgrade is critical and must be completed, regardless of how long it takes.

   You can use the estimated timeout session as your maintenance window. When
   the upgrade reaches the time limit, the system will send an email to notify
   you.

2. Click *Start Upgrade*.

3. (Optional) If some error occurs during the upgrade, you can choose to either:

   * Click *Work with Support*.
   * Click *Work with Support* and then click *Revert to Old Controller* to
     cancel the upgrade.

   If the New Controller Process Status is "Failed", the system will halt the
   upgrade and revert the upgrade to its previous state and bring back the old
   Controller. However, once the New Controller Process Status shows
   "Completed", reverting the upgrade to its previous state is no longer allowed
   through the CoPilot UI. To revert back to the old Controller at this stage,
   contact [Aviatrix Support](https://support.aviatrix.com).

   <Note>
     You will be blocked from closing the upgrade wizard. After a period of
     time, the system will log you out automatically and you will have to wait
     10-15 minutes before you can log back in to CoPilot to check the upgrade
     process. The upgrade continues uninterrupted, regardless of whether you are
     logged out or logged back in.
   </Note>

   When prompted to login, enter:

   * Username
   * Password

4. After logging back into the CoPilot UI, wait till the *Next* button becomes
   clickable. Click *Next*.

5. Read all the instructions on the *Verify Upgrade* page. Once completed, click
   *Done* to exit the upgrade wizard.

### For the Controller Configured with a Load Balancer

(Optional) If you have any load balancer configured for the old Controller.
Please go to *AWS > EC2 > Load Balancing > Target Groups*, select the new
Controller instance and then choose *Include as pending below*. When you are
finished adding instances, choose *Register pending targets*. See
[Register Controller with your Target Group](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-register-targets.html).

<a id="verify-controller-image-upgrade" />

<a id="start-help-verify-controller-image-upgrade" />

<a id="end-help-controller-image-upgrade" />

## Verify Your Controller Upgrade Status

After performing an upgrade, it is important to verify the upgrade status to
ensure that it has been completed successfully.

Perform the following steps to verify that your Controller and Gateways have
been upgraded successfully.

1. Go to *CoPilot > Administration > Maintenance > Controller Upgrade* to check
   the Controller upgrade status.

2. Check if the upgrade window displays a message indicating that the Controller
   upgrade has been completed successfully.

3. Ensure that the displayed Controller version is updated to the latest version

4. Go to *CoPilot > Administration > Maintenance > Back Up & Migrate > Back Up
   Controller* to check the Controller backup is shown up.

5. Go to *CoPilot > Cloud Fabric > Gateway Management* to check the status of
   Controller and gateways.
   * Verify all gateways are up and the status is green.
   * Verify all tunnels are up and the status is green.

6. Go to *CoPilot > Diagnostics > AppIQ* to check whether there are some
   connectivity issue.

7. Go to *CoPilot > Diagnostics > FlowIQ* or perform a ping test on Controller
   to check if the traffic flows are running as expected.

If the above conditions are met, this indicates that your Controller upgrade has
been completed successfully.

<a id="cancel-revert-controller" />

<a id="start-help-cancel-revert-controller" />

<a id="end-help-verify-controller-image-upgrade" />

## Cancel Your Controller Upgrade and Revert Your Controller to the Previous State

<Warning>
  If you decide to cancel an ongoing Controller and Gateway upgrade, the
  cancellation stops the upgrade from proceeding further and will attempt to
  revert your Controller to its previous state. Contact [Aviatrix
  Support](https://support.aviatrix.com) before you click the *Force Completion*
  or the *Revert to Old Controller* button.
</Warning>

During the upgrade, you can:

### Get Assistance from Aviatrix Support

The *Work with Support* button displays after the upgrade starts. Click the
*Work with Support* button to work with
[Aviatrix Support](https://support.aviatrix.com).

* Get assistance from [Aviatrix Support](https://support.aviatrix.com). Click
  *Work with Support* to work with Aviatrix Support.
* Click *Enable Remote Support*. You will then see the open remote support port
  and the log bundle name.
* Click *Support* to find solutions or create a support ticket from *Support >
  Ticket Creation* from
  [Aviatrix Support website](https://support.aviatrix.com).
* You can share your log bundle with
  [Aviatrix Support](https://support.aviatrix.com) for further assistance.

### Cancel Your Upgrade

<Warning>
  Contact [Aviatrix Support](https://support.aviatrix.com) before you click the
  *Revert to Old Controller* button.
</Warning>

You can cancel and revert your Controller to its previous state under the
following scenarios:

* During the upgrade
* When the upgrade time limit is reached.

Click *Revert to Old Controller* to cancel the Controller upgrade and revert
Controller to its previous state before the upgrade started.

This action will:

* *Halt the upgrade process*. Please be noted that this process may take some
  time. If you need to access the old Controller, contact
  [Aviatrix Support](https://support.aviatrix.com).
* *Revert your Controller to the previous state*. During the revert, the system
  will clean up all the temporary files and configurations that have been
  created during the upgrade attempt and bring back the Controller to its
  previous state. If you revert the Controller upgrade after logging out of the
  old Controller and logging into the new Controller, you will be logged out and
  returned to the CoPilot again as we restore the old Controller. Contact
  [Aviatrix Support](https://support.aviatrix.com) to understand more about
  potential negative impacts before selecting the *Revert to Old Controller*
  button.

<a id="end-help-cancel-revert-controller" />

### Force Completion of the Upgrade

<Warning>
  Contact [Aviatrix Support](https://support.aviatrix.com) before you click the
  *Force Completion* button.
</Warning>

When the upgrade time limit expires, you will be prompted with two options:
force completion or revert to old Controller.

Click *Force Completion* to continue the upgrade regardless of the expiration of
the time limit. Contact [Aviatrix Support](https://support.aviatrix.com) to
understand more about potential negative impacts before selecting the Force
Completion button.

For troubleshooting the Controller upgrade, see <a href={"/docs/enterprise/" +
"10.1" +
"/guides/maintenance/controller-gateway-upgrade-troubleshooting"}>Troubleshooting
Controller and Gateway Upgrades</a>.

For upgrading gateways to the latest Aviatrix supported images, see <a href={"/docs/enterprise/" + "10.1" +
"/guides/maintenance/gateway-upgrade-latest-image"}>Upgrade Gateways for the
Latest Aviatrix Supported Images (AWS and Azure Only)</a>.