Selective upgrade workflow

A selective upgrade consists of upgrading Okta Access Gateway nodes from their current version to a later version. While the upgrade can be to the current released version, it can be any version later than the version currently installed on a node.

Available since Access Gateway version 2021.9.3

Topics

Before you begin

Verify that:

  • You have access to the Access Gateway Command Line console.

  • Each Access Gateway node can reach yum.oag.okta.com. You can test connectivity to the Access Gateway yum repository using the Access Gateway Management console.

    To test connectivity:

    1. Using secure shell, connect to the Access Gateway Management console: ssh oag-mgmt@admin
    2. Select 1-Network.
    3. Select 7- Connectivity test.
    4. Enter host: yum.oag.okta.com
    5. Enter port: 443

    Review connection yum.oag.okta.com confirmation message. In case of an error, confirm that the host yum.oag.okta.com is reachable using port 443 from the network where Access Gateway is deployed.

Perform selective upgrade

Upgrade to the latest Access Gateway version

On the node that will be upgraded:

  1. Connect to the target instance Access Gateway Management console.

    >ssh oag-mgmt@[node.tld]

  2. Select 5 - System.
  3. Select 4- Upgrade.
    The upgrade menu will display and resemble:
    Upgrade Access Gateway
    1 - Upgrade to the latest Access Gateway version. . . 2 - View list of Access Gateway versions to upgrade. . . x - Exit
  4. Select 1 - Upgrade to the latest Access Gateway version ...
  5. The upgrade confirmation dialog will display and resemble:
    Enter 1 to confirm and begin upgrade.
    Enter X to exit, and cancel upgrade.Upgrade to Okta Access Gateway 202X.Y.Z-abcdefg NOTE: Confirming the operation will start the upgrade process. The system configuration will be automatically backed up before theupdate. It is strongly recommended that to take a system snapshot before proceeding. 1 - Confirm X - Exit Choice:
  6. Enter 1 to continue.

    Entering X aborts the upgrade and returns to the prior menu.

  7. The upgrade begins and shows results resembling the following: Update in progress... okta-datastores-202X.Y.Z-abcdefg.x86 64 . . . Installed: okta-monitoring-rest-202X.Y.Z-abcdefg.x86_64 Complete! Dependencies resolved. . . . Complete! Upgrade to Okta Access Gateway 202X.Y.Z-abcdefg successful. Press any key to continue to results review.
  8. The view yum page will display:
    Enter y to view the yum upgrade log.
    Enter x - to exit and return to the main upgrade menu.

Upgrade to the selected Access Gateway version

On the node to upgrade:

  1. Connect to the target instance Access Gateway Management console.

    >ssh oag-mgmt@[node.tld]

  2. Select 5 - System.
  3. Select 4- Upgrade.
    The upgrade menu will display and resemble:
    Upgrade Access Gateway
    1 - Upgrade to the latest Access Gateway version. . . 2 - View list of Access Gateway versions to upgrade. . . x - Exit
  4. Enter 2 - View list of Access Gateway versions. . .

    This displays a list of available versions, similar to the following:

    Available versions Okta Access Gateway 2021.A.x-abcdefg Okta Access Gateway 2021.B.x-abcdefg Okta Access Gateway 2021.C.x-abcdefg Okta Access Gateway 2021.D.x-abcdefg Okta Access Gateway 2021.E.x-abcdefg Up/Down - scroll list Return - select x - exit
  5. Use the [up]/[down] or arrows to select a target and enter Return to begin the upgrade process.
  6. In the upgrade confirmation dialog, enter 1 to begin the upgrade:Upgrade to Okta Access Gateway 202X.Y.Z-abcdefg NOTE: Confirming the operation will start the upgrade process. The system configuration will be automatically backed up before the update. It is strongly recommended that to take a system snapshot before proceeding. 1 - Confirm X - Exit Choice:
  7. After the upgrade is complete, use any key to continue:Update in progress... okta-datastores-202X.Y.Z-abcdefg.x86 64 . . . Complete! Upgrade to Okta Access Gateway 202X.Y.Z-abcdefg successful.
  8. You have two options from the view yum page:
    • Enter y to view the yum upgrade log.
    • Enter x - to exit and return to the main upgrade menu.

Related topics

Selective upgrade