Autonomous Identity 2022.11.0

Upgrade Autonomous Identity

Autonomous Identity provides an upgrade command to update your core software to the latest version while migrating your data.

Upgrade Considerations

  • Database Systems are the Same. If your current database is Apache Cassandra, you cannot upgrade to a MongoDB-based system. You will need to run a clean installation with the new version.

  • Host IPs should be the Same. Host IP addresses must be the same for existing components. You must update the ~/autoid-config/hosts file by adding the IP addresses for the Elasticsearch entries. See the instructions below.

  • Registry Key Required. To download the deployment images for the upgrade, you still need your registry key to log into the ForgeRock Google Cloud Registry (gcr.io). Copy your registry key from your previous build to your new upgrade.

Make sure to test the upgrade on a staging or QA server before running it in production.

Upgrade Paths

The upgrade assumes the following upgrade paths depends on your current deployment version. The preferred upgrade path is to the latest patch release. The following chart summarizes these upgrade paths:

Table 1: Upgrade Paths
Version Upgrade To See

2021.8.7

2022.8.11

2021.8.7 Air-Gapped

2022.8.11 Air-Gapped

Upgrade from Autonomous Identity 2021.8.7 to 2022.11.0

The following instructions are for upgrading from Autonomous Identity version 2021.8.7 to the latest version 2022.11.0 in non air-gapped deployments.

Upgrade from 2021.8.7 to 2022.11.0 Non Air-Gap:
  1. Start on the target server, and back up your /data/conf configuration file. The upgrade overwrites this file when updating, so you must restore this file after running the upgrade.

    sudo mv /data/conf ~/backup-data-conf-2021.8.7
  2. Next, if you changed any analytic settings on your deployment, make note of your configuration, so that you can replicate those settings on the upgraded server. Log in to Autonomous Identity, navigate to Administration > Analytic Settings, and record your settings.

  3. On the deployer machine, back up the 2021.8.7 ~/autoid-config directory or move it to another location.

    mv ~/autoid-config ~/backup-2021.8.7
  4. Create a new ~/autoid-config directory.

    mkdir ~/autoid-config
  5. Copy your autoid_registry_key.json, ansible.cfg, and vault.yml files from your backup directory to ~/autoid-config. If your vault.yml file is encrypted, copy the .autoid_vault_password file to ~/autoid-config.

  6. Copy your original SSH key into the new directory.

    cp ~/.ssh/id_rsa ~/autoid-config
  7. Change the permission on the SSH key.

    chmod 400 ~/autoid-config/id_rsa
  8. Check if you can successfully SSH to the target server.

    ssh autoid@<Target-IP-Address>
    
    Last login: Wed Jan 15 18:19:14 2021
  9. On the deployer node, change to the ~/autoid-config directory.

    cd ~/autoid-config
  10. Log in to the ForgeRock Google Cloud Registry (gcr.io) using the registry key. The registry key is only available to ForgeRock Autonomous Identity customers. For specific instructions on obtaining the registry key, see How To Configure Service Credentials (Push Auth, Docker) in Backstage.

    docker login -u _json_key -p "$(cat autoid_registry_key.json)" https://gcr.io/forgerock-autoid

    You should see:

    Login Succeeded
  11. Run the create-template command to generate the deployer.sh script wrapper and configuration files. Note that the command sets the configuration directory on the target node to /config. The --user parameter eliminates the need to use sudo while editing the hosts file and other configuration files.

    docker run --user=$(id -u) -v ~/autoid-config:/config -it gcr.io/forgerock-autoid/deployer:2022.11.0 create-template
  12. Configure your upgraded system by editing the ~/autoid-config/vars.yml , ~/autoid-config/hosts , and ~/autoid-config/vault.yml files on the deployer machine.

    You must keep your configuration settings consistent from one system to another.
  13. Migrate the consul data to JSON. This command is required for consul-server, consul-client, and configuration-service removal. The deployer migrates all consul data to JAS.

    ./deployer.sh debug consul-backup
  14. Stop the stack.

    If you are upgrading a multi-node deployment, run this command on the Docker Manager node.
    docker stack rm configuration-service consul-server consul-client nginx jas swagger-ui ui api notebook

    You should see:

    Removing service configuration-service_configuration-service
    Removing service consul-server_consul-server
    Removing service consul-client_consul-client
    Removing service nginx_nginx
    Removing service jas_jasnode
    Removing service swagger-ui_swagger-ui
    Removing service ui_zoran-ui
    Removing service api_zoran-api
    Nothing found in stack: notebook
  15. Prune old Docker images before running the upgrade command:

    1. Get all of the Docker images:

      docker images
    2. Identify the images that are Autonomous Identity-related. They start with gcr.io/forgerock-autoid/. For example:

      REPOSITORY                                            TAG         IMAGE ID       CREATED       SIZE
      gcr.io/forgerock-autoid/ci/develop/deployer           650879186   075481cea4c2   2 hours ago   823MB
      gcr.io/forgerock-autoid/ci/develop/offline-packages   650879186   e1a90f389ccc   2 hours ago   3.03GB
      gcr.io/forgerock-autoid/ci/develop/zoran-ui           650879186   bd303a28b5df   2 hours ago   35.3MB
      gcr.io/forgerock-autoid/ci/develop/zoran-api          650879186   114d1aca5b0a   2 hours ago   421MB
      gcr.io/forgerock-autoid/ci/develop/nginx              650879186   43b410661269   2 hours ago   16.7MB
      gcr.io/forgerock-autoid/ci/develop/jas                650879186   2821e5c365d8   2 hours ago   491MB
    3. Remove the old images using the docker rmi command. For example:

      docker rmi -f <image ID>
      
      Example:
      docker rmi -f 075481cea4c2
    4. Repeat the previous command to remove all of the Autonomous Identity-related Docker images.

  16. For multinode deployments, run the following on the Docker Worker node:

    docker swarm leave
  17. Enter exit to end your SSH session.

  18. From the deployer, restart Docker command:

    sudo systemctl restart docker
  19. Download the images. This step downloads software dependencies needed for the deployment and places them in the autoid-packages directory. Make sure you are in the ~/autoid-config directory.

    ./deployer.sh download-images
  20. Run the upgrade:

    ./deployer.sh upgrade
  21. SSH to the target server.

  22. On the target server, restore your /data/conf configuration file from your previous installation.

    sudo mv ~/backup-data-conf-2021.8.7 /data/conf
  23. Re-apply your analytics settings to your upgraded server if you made changes on your previous Autonomous Identity machine. Log in to Autonomous Identity, navigate to Administration > Analytics Settings, and edit your changes.

  24. Log out, and then log back in to Autonomous Identity.

You have successfully upgraded your Autonomous Identity server to 2022.11.0.

Upgrade from Autonomous Identity 2021.8.7 to 2022.11.0 Air-Gapped

The following instructions are for upgrading from Autonomous Identity version 2021.8.7 to 2022.11.0 on air-gapped deployments.

Upgrade from 2021.8.7 to 2022.11.0 Air-Gapped:
  1. Start on the target server, and back up your /data/conf configuration file. The upgrade overwrites this file when updating, so you must restore this file after running the upgrade.

    sudo mv /data/conf ~/backup-data-conf-2021.8.7
  2. Next, if you changed any analytic settings on your deployment, make note of your configuration, so that you can replicate those settings on the upgraded server. Log in to Autonomous Identity, navigate to Administration > Analytic Settings, and record your settings.

  3. On the deployer machine, back up the 2021.8.7 ~/autoid-config directory or move it to another location.

    mv ~/autoid-config ~/backup-2021.8.7
  4. Create a new ~/autoid-config directory.

    mkdir ~/autoid-config
  5. Copy your autoid_registry_key.json, ansible.cfg, and vault.yml files from your backup directory to ~/autoid-config. If your vault.yml file is encrypted, copy the .autoid_vault_password file to ~/autoid-config.

  6. Copy your original SSH key into the new directory.

    cp ~/.ssh/id_rsa ~/autoid-config
  7. Change the permission on the SSH key.

    chmod 400 ~/autoid-config/id_rsa
  8. On the deployer node, change to the ~/autoid-config directory.

    cd ~/autoid-config
  9. Log in to the ForgeRock Google Cloud Registry (gcr.io) using the registry key. The registry key is only available to ForgeRock Autonomous Identity customers. For specific instructions on obtaining the registry key, see How To Configure Service Credentials (Push Auth, Docker) in Backstage.

    docker login -u _json_key -p "$(cat autoid_registry_key.json)" https://gcr.io/forgerock-autoid

    You should see:

    Login Succeeded
  10. Run the create-template command to generate the deployer.sh script wrapper and configuration files. Note that the command sets the configuration directory on the target node to /config. The --user parameter eliminates the need to use sudo while editing the hosts file and other configuration files.

    docker run --user=$(id -u) -v ~/autoid-config:/config -it gcr.io/forgerock-autoid/deployer:2022.11.0 create-template
  11. Configure your upgraded system by editing the ~/autoid-config/vars.yml , ~/autoid-config/hosts , and ~/autoid-config/vault.yml files on the deployer machine.

    You must keep your configuration settings consistent from one system to another.
  12. Migrate the consul data to JSON. This command is required for consul-server, consul-client, and configuration-service removal. The deployer migrates all consul data to JAS.

    ./deployer.sh debug consul-backup
  13. Download the images. This step downloads software dependencies needed for the deployment and places them in the autoid-packages directory. Make sure you are in the ~/autoid-config directory.

    ./deployer.sh download-images
  14. Stop the stack.

    If you are upgrading a multi-node deployment, run this command on the Docker Manager node.
    docker stack rm configuration-service consul-server consul-client nginx jas swagger-ui ui api notebook

    You should see:

    Removing service configuration-service_configuration-service
    Removing service consul-server_consul-server
    Removing service consul-client_consul-client
    Removing service nginx_nginx
    Removing service jas_jasnode
    Removing service swagger-ui_swagger-ui
    Removing service ui_zoran-ui
    Removing service api_zoran-api
    Nothing found in stack: notebook
  15. Prune old Docker images before running the upgrade command:

    1. Get all of the Docker images:

      docker images
    2. Identify the images that are Autonomous Identity-related. They start with gcr.io/forgerock-autoid/. For example:

      REPOSITORY                                            TAG         IMAGE ID       CREATED       SIZE
      gcr.io/forgerock-autoid/ci/develop/deployer           650879186   075481cea4c2   2 hours ago   823MB
      gcr.io/forgerock-autoid/ci/develop/offline-packages   650879186   e1a90f389ccc   2 hours ago   3.03GB
      gcr.io/forgerock-autoid/ci/develop/zoran-ui           650879186   bd303a28b5df   2 hours ago   35.3MB
      gcr.io/forgerock-autoid/ci/develop/zoran-api          650879186   114d1aca5b0a   2 hours ago   421MB
      gcr.io/forgerock-autoid/ci/develop/nginx              650879186   43b410661269   2 hours ago   16.7MB
      gcr.io/forgerock-autoid/ci/develop/jas                650879186   2821e5c365d8   2 hours ago   491MB
    3. Remove the old images using the docker rmi command. For example:

      docker rmi -f <image ID>
      
      Example:
      docker rmi -f 075481cea4c2
  16. For multinode deployments, run the following on the Docker Worker node:

    docker swarm leave
  17. From the deployer, restart Docker:

    sudo systemctl restart docker
  18. Create a tar file containing all of the Autonomous Identity binaries.

    tar czf autoid-packages.tgz deployer.sh migrated_consul_config.json autoid-packages/*
  19. Copy the autoid-packages.tgz, deployer.sh, migrated_consul_config.json, and SSH key (id_rsa ) to a portable hard drive.

  20. On the air-gapped target machine, backup your previous ~/autoid-config directory, and then create a new ~/autoid-config directory.

    mkdir ~/autoid-config
  21. Copy the autoid-package.tgz tar file, deployer.sh, migrated_consul_config.json, and SSH key from the portable storage device to the /autoid-config folder.

  22. Unpack the tar file.

    tar xf autoid-packages.tgz -C ~/autoid-config
  23. Copy the SSH key to the ~/autoid-config directory.

  24. Change the privileges to the file.

    chmod 400 ~/autoid-config/id_rsa
  25. Change to the configuration directory.

    cd ~/autoid-config
  26. Import the deployer image.

    ./deployer.sh import-deployer

    You should see:

    …​
    db631c8b06ee: Loading layer [=============================================⇒]   2.56kB/2.56kB
    2d62082e3327: Loading layer [=============================================⇒]  753.2kB/753.2kB
    Loaded image: gcr.io/forgerock-autoid/deployer:2022.11.0
  27. Create the configuration template using the create-template command. This command creates the configuration files: ansible.cfg , vars.yml , vault.yml and hosts.

    ./deployer.sh create-template

    You should see:

    Config template is copied to host machine directory mapped to /config
  28. Configure your upgraded system by editing the ~/autoid-config/vars.yml , ~/autoid-config/hosts , and ~/autoid-config/vault.yml files on the deployer machine.

    You must keep your configuration settings consistent from one system to another.
  29. Run the upgrade on versions 2021.8.0–2021.8.3:

    ./deployer.sh upgrade
  30. On the target server, restore your /data/conf configuration file from your previous installation.

    sudo mv ~/backup-data-conf-2021.8.7 /data/conf
  31. Re-apply your analytics settings to your upgraded server if you made changes on your previous Autonomous Identity machine. Log in to Autonomous Identity, navigate to Administration > Analytics Settings, and edit your changes.

  32. Log out, and then log back in to Autonomous Identity.

You have successfully upgraded your Autonomous Identity server to 2022.11.0.

Copyright © 2010-2022 ForgeRock, all rights reserved.