Upgrade AppGate collective with sdpctl tool

The sdpctl tool is used for upgrades of the AppGate ZTNA collective from version 6.0 or later. For best practices and preparation refer the guide.

Prerequisites

Before starting the upgrade process:

• Download the latest SDPCTL tools from the AppGate GitHub repository.

• Install SDPCTL by following the instructions for your operating system in the Quick Start Guide.

• “Optional step ( you don’t need this, if you have 3rd party cert for your admin UI )” Download the CA certificate from the AppGate Admin UI:

  • Navigate to: System → Certificate Authority

  • Download the CA certificate file.

  • Place the downloaded certificate file (ca-filename.cer) in the same directory as the sdpctl binary.

• Ensure you have:

  • Administrator access to the AppGate Controller.

  • The upgrade image file downloaded and available locally. Available versions.

Upgrade Procedure

1.Configure sdpctl

• Open your terminal and run the command - sdpctl configure --pem <ca-cert-file-name>

• Enter your Controller URL - https://ctl.mycompany.com:8443

• Then you should see Configuration updated successfully

2.Sign In to the Controller

• Run the command - sdpctl configure signin

• Then

  • Select the appropriate Identity Provider (IDP) if multiple IDPs are configured.

    *note: SAML and OIDC are not supported

  • Enter your credentials. (for below example we have chosen local admin credentials).

  • After a successful login, you should see - Successfully signed in

3.Prepare the upgrade

• Run the command - sdpctl appliance upgrade prepare --image=<choose the upgrade image file>

• During this step:

  • sdpctl will display the list of AppGate appliances within your collective, that will be upgraded, along with current and prepare version. In the example below, the upgrade is being performed from version 6.4.2 to 6.6.3. Please note that AppGate supports upgrades within a maximum of two versions at a time.

  • You will be prompted with - Do you want to continue? (y/N): to proceed, choose y

• Once the preparation completes successfully, a confirmation summary will be displayed.

4.Complete the upgrade

• Run the command - sdpctl appliance upgrade complete

• Before proceeding, sdpctl will prompt you to create a backup.

  • Important: It is highly recommended to back up your Controllers before continuing.

• During the backup step, sdpctl may prompt you to enable the Backup API and request a passphrase to encrypt the appliance backup files.

• After the successful upgrade, you will then see an Upgrade Complete Summary like below.