Upgrade to Version 4.0.0

You can follow the appropriate steps to upgrade Pulse to version 4.0.0 based on your current deployment:

Note Before upgrading Pulse, ensure that your Docker version is upgraded. For details, see Upgrade Prerequisite.

Upgrade Pulse from Version 3.8.x. to 4.0.0

Step 1: Prepare for the Upgrade

Back up the existing accelo file.
Download the latest version of the accelo.linux CLI.
Move and make the new CLI executable. Also, check the updated Pulse information for the following:

Bash
    
 
mv accelo.linux accelochmod +x ./accelo
Copy

Update the ImageTag in $AcceloHome/config/accelo.yml to 4.0.0.
Push the updated configuration to the database:

Bash
    
 
accelo admin database push-config -a
Copy

Run the following command to confirm the ImageTag update:

Bash
    
 
accelo info
Copy

Step 2: For Offline Installations

Download all the latest image packs.
Upload the latest images using:

Bash
    
 
docker load -i
Copy

Run the migration command from $AcceloHome:

For a single cluster:

Bash
    
 
accelo migrate -v 4.0.0 -i 3.8.0 -b
Copy

For multi-cluster setups, run:

Bash
    
 
accelo migrate -v 4.0.0 -i 3.8.0 -a -b
Copy

-v: specifies the version you are migrating to (4.0.0).
-i: specifies the version you are migrating from (3.8.0).

If any issue occurs during migration, rerun the same command.
After migration, deploy the core components:

Bash
    
 
accelo deploy core
Copy

Step 3: For Online Installations

Bash
    
 
accelo login dockeraccelo pull all
Copy

Press Y when prompted to get the most recent binaries.

Restart all containers so that they use the updated images.

Bash
    
 
accelo restart all -d
Copy

Step 3: Update Hydra Agent

Uninstall the existing Hydra agent:

Bash
    
 
accelo uninstall remote
Copy

Install the updated Hydra agent:

Bash
    
 
accelo deploy hydra
Copy

Step 4: Reconfigure the Cluster

Reconfigure the cluster to get the updated configuration for agents.

Bash
    
 
accelo reconfig cluster -a
Copy

Push the updated configuration to the database:

Bash
    
 
accelo admin database push-config -a
Copy

Step 5: Configure MongoDB Cleanup and Compaction

To define the execution schedule for MongoDB cleanup and compaction in Gauntlet Snap, run:

Bash
    
 
accelo config retention
Copy

Step 6: Create Database Indices

Run the following command to create indices for database collections:

Bash
    
 
accelo admin database index-db
Copy

If readOnlyRootFSEnabled is set to true in $AcceloHome/config/accelo.yml, follow these steps:

Open $AcceloHome/config/accelo.yml and set readOnlyRootFSEnabled to false.
Run:

Bash
    
 
accelo admin database push-configaccelo restart all -daccelo admin database index-db
Copy

Reset readOnlyRootFSEnabled to true and run:

Bash
    
 
accelo admin database push-configaccelo restart all -d
Copy

Step 7: Update Playbooks

If older playbooks exist on the node where ad-director is deployed, delete them:

Bash
    
 
rm -rf $AcceloHome/work/<cluster_name>/director/playbook/*
Copy

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.0 with updated configurations, images, and agents

Upgrade Pulse from Version 3.7.x. to 4.0.0

Follow these steps to upgrade from version 3.7.x to 4.0.0.

Step 1: Prepare for the Upgrade

Back up the existing accelo file.
Download the latest version of the accelo.linux CLI.
Move and make the new CLI executable. Also, check the updated Pulse information for the following:

Bash
    
 
mv accelo.linux accelochmod +x ./accelo
Copy

Push the updated configuration to the database:

Bash
    
 
accelo admin database push-config -a
Copy

Upgrade MongoDB to version 8.0.8:

Bash
    
 
accelo admin database migrate
Copy

For detailed steps, see Migrate MongoDB from Version 6.0.X to 8.0.X.

Update the ImageTag in $AcceloHome/config/accelo.yml to 4.0.0.
Push the updated configuration to the database again:

Bash
    
 
accelo admin database push-config -a
Copy

Verify the update: Run the info command to confirm the ImageTag update.

Bash
    
 
accelo info
Copy

Step 3: For Offline Installations

Download all the latest image packs.
Upload the latest images:

Bash
    
 
docker load -i
Copy

Update and add new keys in vars.yml:

Bash
    
 
accelo reconfig cluster
Copy

If your ODP cluster includes Kafka 3, run accelo config cluster before executing this step.

Step 3: (Optional) Update LDAP Configuration

If ad-ldap is deployed, follow these steps:

Generate an encrypted password:

Bash
    
 
accelo admin encrypt
Copy

Enter the plain text password when prompted to receive the encrypted value.

Update the following file:
- Edit /data01/acceldata/config/ldap/ldap.conf
- Set bindPW to the new encrypted password.
- Add the flag: encryptedPassword = true
Push the updated configuration:

Bash
    
 
accelo admin database push-config
Copy

After the previous command completes, move the license file from the local work directory to a backup directory.

Step 4: Migrate to Version 4.0.0

Move the license file from the local work directory to a backup directory.
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 a single cluster:

Bash
    
 
accelo migrate -v 4.0.0 -i 3.7.0 -b
Copy

For multi-cluster:

Bash
    
 
accelo migrate -v 4.0.0 -i 3.7.0 -a -b
Copy

-v → version you are migrating to (4.0.0).
-i → version you are migrating from (3.7.0).

If any issue occurs during migration, rerun the same command.
Deploy the core components:

Bash
    
 
accelo deploy core
Copy

Step 5: For Online Installations

Bash
    
 
accelo login dockeraccelo pull all
Copy

Press Y when prompted to get the most recent binaries.

Restart all containers so that they use the updated images.

Bash
    
 
accelo restart all -d
Copy

Step 6: Update Hydra Agent

Uninstall the existing Hydra agent:

Bash
    
 
accelo uninstall remote
Copy

Install the updated Hydra agent:

Bash
    
 
accelo deploy hydra
Copy

Step 7: Reconfigure the Cluster

Reconfigure the cluster to apply updated configurations for agents..

Bash
    
 
accelo reconfig cluster -a
Copy

Push the latest configuration to the database:

Bash
    
 
accelo admin database push-config -a
Copy

Step 8: Configure MongoDB Cleanup and Compaction

To define the execution schedule for MongoDB cleanup and compaction in Gauntlet Snap, run:

Bash
    
 
accelo config retention
Copy

Step 9: Create Database Indices

Run the following command to create indices for database collections:

Bash
    
 
accelo admin database index-db
Copy

If readOnlyRootFSEnabled is set to true in $AcceloHome/config/accelo.yml, follow these steps:

Open $AcceloHome/config/accelo.yml and set:

Bash
    
 
readOnlyRootFSEnabled: false
Copy

Run:

Bash
    
 
accelo admin database push-configaccelo restart all -daccelo admin database index-db
Copy

Reset readOnlyRootFSEnabled to true and rerun:

Bash
    
 
accelo admin database push-configaccelo restart all -d
Copy

Step 10: Update Playbooks

Delete existing playbooks on the ad-director node:

Bash
    
 
rm -rf $AcceloHome/work/<cluster_name>/director/playbook/*
Copy

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.

Last updated on

Was this page helpful?