Chapter 10. Upgrading your deployment

Procedure

1. Store your service account credential JSON file in the /secrets directory.

   Note

   To create the GCP credentials file, see, Create credentials and Create and delete service account keys

2. The extra_vars.yml file contains the following input variables within the extra_vars directory:

   • gcp_service_account_credentials_json_path is the service account credential JSON file path for the Google cloud account. This is the path within an ansible-on-clouds-ops container where the credentials JSON file is mounted to the /secrets directory. The path should be /secrets/<service-account-creds-json-filename>.

     Replace <service-account-creds-json-filename> with your Google service account credential filename.

   • gcp_deployment_name is the deployment name that you want to upgrade.
   • gcp_compute_region is the GCP region that you provided when deploying foundation deployment. If you have not provided a region when deploying the foundation, use the default region us-east1 here.

   • gcp_compute_zone is the GCP zone that you provided when deploying foundation deployment. If you have not provided a zone when deploying the foundation, use the default us-east1-b here.

     Note

     You can find the region and zone from the filestore instance deployed with the foundation deployment. Look for the filestore with the name <deployment-name>-filestore.

     • Make note of the location field that is your gcp_compute_zone. For example, the filestore instance location might be us-east1-d
     • Remove the last two characters from the location that is your gcp_compute_region. For example, if your gcp_compute_zone location is us-east1-d, your region is us-east1.

     gcp_service_account_credentials_json_path: "/secrets/<service-account-creds-json-filename>"
     gcp_deployment_name: ""
     gcp_compute_region: ""
     gcp_compute_zone: ""

3. The final result should look similar to the following:

   $ tree
   tree
   .
   ├── extra_vars
   │   └── extra_vars.yaml
   └── secrets
       └── gc-ansible-cloud-123434.json

Procedure

1. Replace <absolute path to Google application credentials dir> with the path to the service account credential JSON file for the Google cloud.
2. Replace <absolute path of extra vars dir> with the path to the directory where the extra_vars.yml file you created in step 1 of the backup process.

3. Use the following command to run the playbook:

   $ docker run --rm \
   -v <absolute path to google application credentials dir>:/secrets:ro \
   -v <absolute path of extra vars dir>:/extra_vars:ro \
   $IMAGE \
   redhat.ansible_on_clouds.gcp_backup_deployment \
   -e @/extra_vars/extra_vars.yaml

4. Note the output of the playbook.

   The playbook output resembles the following:

   TASK [redhat.ansible_on_clouds.standalone_gcp_backup : [backup_deployment] Print vars required for restore process] ***
   ok: [localhost] => {
       "msg": [
           "AAP on GCP Backup successful. Please note below vars which are required for restore process.",
           "{ gcp_sql_backup_id: 1677552759614 , gcp_sql_backup_db_name: test-bnr-aap-db ,gcp_filestore_backup_name: test-bnr-filestore-iygs }"
       ]
   }

   Important

   Make a note of the SQL database backup ID, SQL database backup name and the filestore backup name. You will require these for the restore playbook.

Procedure

1. Run the following commands to generate the required data file. These commands create a directory, and populate it with an empty data template that, when populated, is used during the upgrade.

   # Create a folder to hold the configuration files
   $ mkdir command_generator_data
   # Populate command_generator_data folder with configuration file template
   $ docker run --rm -v $(pwd)/command_generator_data:/data $IMAGE \
   command_generator_vars gcp_upgrade \
   --output-data-file /data/extra_vars.yml

2. After running the previous commands, a command_generator_data/extra_vars.yml template is created. This template file should resemble:

     gcp_upgrade:
     ansible_config_path:
     cloud_credentials_path:
     deployment_name:
     extra_vars:
       gcp_backup_taken:
       gcp_compute_region:
       gcp_compute_zone:

1. To run the upgrade, run the command generator to generate the upgrade CLI command:

   $ docker run --rm -v $(pwd)/command_generator_data:/data $IMAGE command_generator --data-file /data/extra_vars.yml

   This generates the following command:

   -----------------------------------------------
   docker run --rm --env PLATFORM=GCP -v ~/secrets/GCP-secrets.json:/home/runner/.gcp/credentials:ro
   --env ANSIBLE_CONFIG=../gcp-ansible.cfg
   --env DEPLOYMENT_NAME=AnsibleAutomationPlatform
   --env GENERATE_INVENTORY=true  $IMAGE redhat.ansible_on_clouds.gcp_upgrade \
   -e 'gcp_deployment_name=AnsibleAutomationPlatform \
   gcp_service_account_credentials_json_path=/home/runner/.gcp/credentials \
   gcp_compute_region=us-east1 gcp_compute_zone=us-east1-b gcp_backup_taken=True'
   ===============================================

2. Run the given upgrade command to trigger the upgrade.

   $ docker run --rm --env PLATFORM=GCP -v ~/secrets/GCP-secrets.json:/home/runner/.gcp/credentials:ro \
   --env ANSIBLE_CONFIG=../gcp-ansible.cfg \
   --env DEPLOYMENT_NAME=AnsibleAutomationPlatform \
   --env GENERATE_INVENTORY=true  $IMAGE redhat.ansible_on_clouds.gcp_upgrade \
   -e 'gcp_deployment_name=AnsibleAutomationPlatform \
   gcp_service_account_credentials_json_path=/home/runner/.gcp/credentials \
   gcp_compute_region=us-east1 gcp_compute_zone=us-east1-b gcp_backup_taken=True'

3. The upgrade can take some time to complete, but can take longer depending on the number of extension nodes on the system. A successful upgrade is marked by the log below.

   TASK [redhat.ansible_on_clouds.standalone_gcp_upgrade : [upgrade] Show GCP current version] ***
   ok: [localhost] => {
       "msg": "gcp_current_version: 2.3.20230221-00"
   }

4. Your Ansible Automation Platform from GCP Marketplace deployment is now upgraded to a newer version and you can log in to Red Hat Ansible Automation Platform automation controller and automation hub using your deployment credentials.

Procedure

1. Replace <absolute path to Google application credentials dir> with the path to the service account credential JSON file for the Google cloud.
2. Replace <absolute path of extra vars dir> with the path to the extra_vars.yml file you created in Preparing the backup environment.

3. Use the following command to run the playbook.

   $ docker run --rm \
   -v <absolute path to Google application credentials dir>:/secrets:ro \
   -v <absolute path of extra vars dir>:/extra_vars:ro \
   $IMAGE \
   redhat.ansible_on_clouds.gcp_restore_deployment \
   -e @/extra_vars/extra_vars.yaml

4. When you have run the playbook, a new restored deployment is visible in the GCP deployment. It can take a few minutes for the deployment to finish and for all the containers to run.

   Note

   Access to the restored deployment must be configured through either an external load balancer or VPN. When a connection method is configured you can log in to Red Hat Ansible Automation Platform automation controller and automation hub using your old deployment credentials. In addition, all job history, uploaded collections and other records must be in the same state as the restored deployment.