You can follow the appropriate steps to upgrade Pulse to version 4.0.1 based on your current deployment:
- Upgrade Pulse from Version 4.0.0. to 4.0.1
- Upgrade Pulse from Version 3.8.x. to 4.0.0
- Upgrade Pulse from Version 3.7.x. to 4.0.0
Upgrade Pulse from Version 4.0.0. to 4.0.1
Step 1: Update Container Runtime Configuration
Update /etc/profile.d/ad.sh based on the container orchestration tool in use.
For Docker:
export CONTAINER_TOOL='docker'For Podman:
export CONTAINER_TOOL='podman'export REGISTRY_AUTH_FILE=${AcceloHome}/config/podman/config.jsonThis step is required because accelo supports Podman and dynamically selects the appropriate container runtime socket based on the configured orchestration tool (Podman or Docker).
Step 2: Update the Image Tag
Update the ImageTag in $AcceloHome/config/accelo.yml:
ImageTag: 4.0.1Step 3: Update the Accelo CLI
- Take a backup of the existing accelo CLI binary.
- Download the latest accelo.linux CLI.
- Replace the existing binary and make it executable:
mv accelo.linux accelochmod +x ./acceloStep 4: Pull the Latest Images (online installations)
accelo login dockeraccelo pull allStep 5: Load Images (offline installations only)
Download the latest image packs and load them:
docker load -i <image-pack-file>Step 6: Reconfigure the Cluster
Run the following command to update and add new keys in vars.yml:
accelo reconfig clusterStep 7: Verify the Upgrade
Confirm that the image tag is updated:
accelo infoUpgrade Pulse from Version 3.8.x. to 4.0.1
Step 1: Update Container Runtime Configuration
Update /etc/profile.d/ad.sh based on the container orchestration tool in use.
For Docker:
export CONTAINER_TOOL='docker'For Podman:
export CONTAINER_TOOL='podman'export REGISTRY_AUTH_FILE=${AcceloHome}/config/podman/config.jsonThis step is required because accelo supports Podman and dynamically selects the appropriate container runtime socket based on the configured orchestration tool (Podman or Docker).
Step 2: Prepare for the Upgrade
- Back up the existing
accelofile. - Download the latest version of the
accelo.linuxCLI. - Move and make the new CLI executable. Also, check the updated Pulse information for the following:
mv accelo.linux accelochmod +x ./accelo- Update the
ImageTagin$AcceloHome/config/accelo.ymlto4.0.1. - Push the updated configuration to the database:
accelo admin database push-config -a- Run the following command to confirm the ImageTag update:
accelo infoStep 3: For Offline Installations
- Download all the latest image packs.
- Upload the latest images using:
docker load -i- Run the migration command from
$AcceloHome:
Do not change the -v value from 4.0.0 unless explicitly instructed by Engineering.
Run the following command on all Pulse nodes, including standalone nodes (where PULSE_SA_NODE is set to true). Examples of such nodes include, but are not limited to, dedicated Pulse standalone instances.
For example:
- -v: specifies the version you are migrating to (4.0.1). Note: Keep the version as
-v 4.0.0, even when you are migrating to any update release version in 4.0.x. - -i: specifies the version you are migrating from (3.8.0).
To migrate from version 3.8.0 to 4.0.1, the migration command looks as shown below.
- For a single cluster, run:
accelo migrate -v 4.0.0 -i 3.8.0 -b- For multi-cluster setups, run:
accelo migrate -v 4.0.0 -i 3.8.0 -a -b- If any issue occurs during migration, rerun the same command.
- After migration, deploy the core components:
accelo deploy coreStep 4: For Online Installations
- Log in and pull the latest binaries:
accelo login dockeraccelo pull allPress Y when prompted to get the most recent binaries.
- Restart all containers so that they use the updated images.
accelo restart all -dStep 5: Update Hydra Agent
- Uninstall the existing Hydra agent:
accelo uninstall remote- Install the updated Hydra agent:
accelo deploy hydraStep 6: Reconfigure the Cluster
- Reconfigure the cluster to get the updated configuration for agents.
accelo reconfig cluster -a- Push the updated configuration to the database:
accelo admin database push-config -aStep 7: Configure MongoDB Cleanup and Compaction
To define the execution schedule for MongoDB cleanup and compaction in Gauntlet Snap, run:
accelo config retentionStep 8: Create Database Indices
Run the following command to create indices for database collections.
If readOnlyRootFSEnabled is set to true in $AcceloHome/config/accelo.yml, follow these steps:
- Open
$AcceloHome/config/accelo.ymland setreadOnlyRootFSEnabledto false. - Run:
accelo admin database push-configaccelo restart all -daccelo admin database index-db- Reset
readOnlyRootFSEnabledto true and run:
accelo admin database push-configaccelo restart all -dStep 9: Update Playbooks
- If older playbooks exist on the node where ad-director is deployed, delete them:
rm -rf $AcceloHome/work/<cluster_name>/director/playbook/*Replace <cluster_name> with the name of your cluster.
- Download the latest playbooks tar file from the LICENSE UI.
- Follow the guide Deploy Playbooks to install the updated playbooks.
After completing these steps, your environment should be running version 4.0.1 with updated configurations, images, and agents
Upgrade Pulse from Version 3.7.x. to 4.0.1
Follow these steps to upgrade from version 3.7.x to 4.0.1.
Step 1: Update Container Runtime Configuration
Update /etc/profile.d/ad.sh based on the container orchestration tool in use.
For Docker:
export CONTAINER_TOOL='docker'For Podman:
export CONTAINER_TOOL='podman'export REGISTRY_AUTH_FILE=${AcceloHome}/config/podman/config.jsonThis step is required because accelo supports Podman and dynamically selects the appropriate container runtime socket based on the configured orchestration tool (Podman or Docker).
Step 2: Prepare for the Upgrade
- Back up the existing
accelofile. - Download the latest version of the
accelo.linuxCLI. - Move and make the new CLI executable. Also, check the updated Pulse information for the following:
mv accelo.linux accelochmod +x ./accelo- Push the updated configuration to the database:
accelo admin database push-config -a- Upgrade MongoDB to version 8.0.8:
accelo admin database migrateFor detailed steps, see Migrate MongoDB from Version 6.0.X to 8.0.X.
- Update the
ImageTagin$AcceloHome/config/accelo.ymlto4.0.1. - Push the updated configuration to the database again:
accelo admin database push-config -a- Verify the update: Run the info command to confirm the ImageTag update.
accelo infoStep 3: For Offline Installations
- Download all the latest image packs.
- Upload the latest images:
docker load -i- Update and add new keys in
vars.yml:
accelo reconfig clusterIf your ODP cluster includes Kafka 3, run accelo config cluster before executing this step.
Step 4: (Optional) Update LDAP Configuration
If ad-ldap is deployed, follow these steps:
- Generate an encrypted password:
accelo admin encryptEnter the plain text password when prompted to receive the encrypted value.
Update the following file:
- Edit
/data01/acceldata/config/ldap/ldap.conf - Set
bindPWto the new encrypted password. - Add the flag:
encryptedPassword = true
- Edit
Push the updated configuration:
accelo admin database push-configAfter the previous command completes, move the license file from the local work directory to a backup directory.
Step 5: Migrate to Version 4.0.1
- Move the license file from the local work directory to a backup directory.
- Run the migration command from
$AcceloHome:
Do not change the
-vvalue from4.0.0unless explicitly instructed by Engineering.Run the following command on all Pulse nodes, including standalone nodes (where
PULSE_SA_NODEis set totrue). Examples of such nodes include, but are not limited to, dedicated Pulse standalone instances.
For example:
- -v: specifies the version you are migrating to (4.0.1). Note: Keep the version as
-v 4.0.0, even when you are migrating to any update release version in 4.0.x. - -i: specifies the version you are migrating from (3.7.0).
To migrate from version 3.7.0 to 4.0.1, the migration command looks as shown below.
For a single cluster:
accelo migrate -v 4.0.0 -i 3.7.0 -bFor multi-cluster:
accelo migrate -v 4.0.0 -i 3.7.0 -a -b- If any issue occurs during migration, rerun the same command.
- Deploy the core components:
accelo deploy coreStep 6: For Online Installations
- Log in and pull the latest binaries:
accelo login dockeraccelo pull allPress Y when prompted to get the most recent binaries.
- Restart all containers so that they use the updated images.
accelo restart all -dStep 7: Update Hydra Agent
- Uninstall the existing Hydra agent:
accelo uninstall remote- Install the updated Hydra agent:
accelo deploy hydraStep 8: Reconfigure the Cluster
- Reconfigure the cluster to apply updated configurations for agents..
accelo reconfig cluster -a- Push the latest configuration to the database:
accelo admin database push-config -aStep 9: Configure MongoDB Cleanup and Compaction
To define the execution schedule for MongoDB cleanup and compaction in Gauntlet Snap, run:
accelo config retentionStep 10: Create Database Indices
Run the following command to create indices for database collections:
accelo admin database index-dbIf readOnlyRootFSEnabled is set to true in $AcceloHome/config/accelo.yml, follow these steps:
- Open
$AcceloHome/config/accelo.ymland set:
readOnlyRootFSEnabled: false- Run:
accelo admin database push-configaccelo restart all -daccelo admin database index-db- Reset
readOnlyRootFSEnabledtotrueand rerun:
accelo admin database push-configaccelo restart all -dStep 11: Update Playbooks
- Delete existing playbooks on the ad-director node:
rm -rf $AcceloHome/work/<cluster_name>/director/playbook/*Replace <cluster_name> with the name of your cluster.
- Download the latest playbooks tar file from the LICENSE UI.
- Follow the guide Deploy Playbooks to deploy the new playbooks.
Upgrade Complete
After completing these steps, your environment will be successfully upgraded to version 4.0.0 with the latest configurations, images, and agents.