Upgrading Autonomous Identity
Autonomous Identity provides an upgrade command to update your core software to the latest version while migrating your data.
The upgrade assumes the following:
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/hostsfile 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 a registry key to log into the ForgeRock Google Cloud Registry (gcr.io). 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.
The following instruction is for upgrade from Autonomous Identity 2021.3.x (2021.3.0, 2021.3.1, 2021.3.2) to version 2021.3.3.
Upgrade to version 2021.3.3:
On the deployer machine, back up the 2021.3.x
~/autoid-configdirectory or move it to another location.
$ mv ~/autoid-config ~/backup-2021.3.1
Create a new
$ mkdir ~/autoid-config
autoid_registry_key.jsonfrom your backup directory to
Copy your original SSH key into the new directory.
$ cp ~/.ssh/id_rsa ~/autoid-config
Change the permission on the SSH key.
$ chmod 400 ~/autoid-config/id_rsa
Check if you can successfully SSH to the target server.
$ ssh -i ~/autoid-config/id_rsa autoid@<Target-IP-Address> Last login: Tue Aug 3 18:19:14 2021
Stop the stack.
$ docker stack rm configuration-service consul-server consul-client nginx jas openldap selfservice swagger-ui ui api
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 openldap_openldap Removing service openldap_phpldapadmin Removing service selfservice_selfservice Removing service swagger-ui_swagger-ui Removing service ui_zoran-ui Removing service api_zoran-api
Back up the
/data/confdirectory. This directory holds the configuration files used in 2021.3.x.
$ cp -r /data/conf <backup-directory>
Remove the analytics container of the analytics node:
$ docker rm -f analytics
exitto end your SSH session.
Repeat the restart Docker command:
$ sudo systemctl restart docker
On the deployer node, change to the
$ cd ~/autoid-config
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:
create-templatecommand to generate the
deployer.shscript wrapper and configuration files. Note that the command sets the configuration directory on the target node to
--userparameter eliminates the need to use
sudowhile editing the hosts file and other configuration files.
$ docker run --user=$(id -u) -v ~/autoid-config:/config -it gcr.io/forgerock-autoid/deployer:2021.3.3 create-template … d6c7c6f3303e: Pull complete Digest: sha256:15225be65417f8bfb111adea37c83eb5e0d87140ed498bfb624a358f43fbbf Status: Downloaded newer image for gcr.io/forgerock-autoid/autoid/dev-compact/deployer@sha256:15225be65417f8bfb111a dea37c83eb5e0d87140ed498bfb624a358f43fbbf Config template is copied to host machine directory mapped to /config
Configure your upgraded system by editing the
~/autoid-config/vault.ymlfiles on the deployer machine.
The key here is to keep your configuration settings consistent from one system to another.
Download the images. This step downloads software dependencies needed for the deployment and places them in the
autoid-packagesdirectory. Make sure you are in the
$ ./deployer.sh download-images
SSH to the target node.
Stop the Spark master and workers.
You should see:
localhost: stopping org.apache.spark.deploy.worker.Worker stopping org.apache.spark.deploy.master.Master
Exit your SSH session.
Run the upgrade.
$ ./deployer.sh upgrade
Add a reference to Autonomous Identity JAS to your
/etc/hostsor DNS server.
<Public IP Address> autoid-ui.forgerock.com autoid-selfservice.forgerock.com autoid-jas.forgerock.com
Redo the attribute mappings. See Set Attribute Mappings.
Log out and then log in. SSH to the target server.
Create an analytics template. This step creates a template from the new analytics image.
$ analytics create-template
/data/conf/analytics_init_config.ymlfile if you made changes to this file in your previous deployment.
Apply the analytics template.
$ analytics apply-template
Then, rerun the analytics pipeline.
$ analytics ingest $ analytics train $ analytics predict-as-is $ analytics predict-recommendation $ analytics publish $ analytics create-assignment-index
You have successfully upgraded your Autonomous Identity server to 2021.3.3.