Upgrade to Version 4.0.1

You can follow the appropriate steps to upgrade Pulse to version 4.0.1 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 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:

Bash
Copy

For Podman:

Bash
Copy

This 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:

Bash
Copy

Step 3: Update the Accelo CLI

  1. Take a backup of the existing accelo CLI binary.
  2. Download the latest accelo.linux CLI.
  3. Replace the existing binary and make it executable:
Bash
Copy

Step 4: Pull the Latest Images (online installations)

Bash
Copy

Step 5: Load Images (offline installations only)

Download the latest image packs and load them:

Bash
Copy

Step 6: Reconfigure the Cluster

Run the following command to update and add new keys in vars.yml:

Bash
Copy

Step 7: Verify the Upgrade

Confirm that the image tag is updated:

Bash
Copy

Upgrade 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:

Bash
Copy

For Podman:

Bash
Copy

This 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

  1. Back up the existing accelo file.
  2. Download the latest version of the accelo.linux CLI.
  3. Move and make the new CLI executable. Also, check the updated Pulse information for the following:
Bash
Copy
  1. Update the ImageTag in $AcceloHome/config/accelo.yml to 4.0.1.
  2. Push the updated configuration to the database:
Bash
Copy
  1. Run the following command to confirm the ImageTag update:
Bash
Copy

Step 3: For Offline Installations

  1. Download all the latest image packs.
  2. Upload the latest images using:
Bash
Copy
  1. 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:
Bash
Copy
  • For multi-cluster setups, run:
Bash
Copy
  1. If any issue occurs during migration, rerun the same command.
  2. After migration, deploy the core components:
Bash
Copy

Step 4: For Online Installations

  1. Log in and pull the latest binaries:
Bash
Copy

Press Y when prompted to get the most recent binaries.

  1. Restart all containers so that they use the updated images.
Bash
Copy

Step 5: Update Hydra Agent

  1. Uninstall the existing Hydra agent:
Bash
Copy
  1. Install the updated Hydra agent:
Bash
Copy

Step 6: Reconfigure the Cluster

  1. Reconfigure the cluster to get the updated configuration for agents.
Bash
Copy
  1. Push the updated configuration to the database:
Bash
Copy

Step 7: Configure MongoDB Cleanup and Compaction

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

Bash
Copy

Step 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:

  1. Open $AcceloHome/config/accelo.yml and set readOnlyRootFSEnabled to false.
  2. Run:
Bash
Copy
  1. Reset readOnlyRootFSEnabled to true and run:
Bash
Copy

Step 9: Update Playbooks

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

Replace <cluster_name> with the name of your cluster.

  1. Download the latest playbooks tar file from the LICENSE UI.
  2. 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:

Bash
Copy

For Podman:

Bash
Copy

This 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

  1. Back up the existing accelo file.
  2. Download the latest version of the accelo.linux CLI.
  3. Move and make the new CLI executable. Also, check the updated Pulse information for the following:
Bash
Copy
  1. Push the updated configuration to the database:
Bash
Copy
  1. Upgrade MongoDB to version 8.0.8:
Bash
Copy

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

  1. Update the ImageTag in $AcceloHome/config/accelo.yml to 4.0.1.
  2. Push the updated configuration to the database again:
Bash
Copy
  1. Verify the update: Run the info command to confirm the ImageTag update.
Bash
Copy

Step 3: For Offline Installations

  1. Download all the latest image packs.
  2. Upload the latest images:
Bash
Copy
  1. Update and add new keys in vars.yml:
Bash
Copy

If 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:

  1. Generate an encrypted password:
Bash
Copy

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

  1. Update the following file:

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

Bash
Copy

After 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

  1. Move the license file from the local work directory to a backup directory.
  2. 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.7.0).

To migrate from version 3.7.0 to 4.0.1, the migration command looks as shown below.

For a single cluster:

Bash
Copy

For multi-cluster:

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

Step 6: For Online Installations

  1. Log in and pull the latest binaries:
Bash
Copy

Press Y when prompted to get the most recent binaries.

  1. Restart all containers so that they use the updated images.
Bash
Copy

Step 7: Update Hydra Agent

  1. Uninstall the existing Hydra agent:
Bash
Copy
  1. Install the updated Hydra agent:
Bash
Copy

Step 8: Reconfigure the Cluster

  1. Reconfigure the cluster to apply updated configurations for agents..
Bash
Copy
  1. Push the latest configuration to the database:
Bash
Copy

Step 9: Configure MongoDB Cleanup and Compaction

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

Bash
Copy

Step 10: Create Database Indices

Run the following command to create indices for database collections:

Bash
Copy

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

  1. Open $AcceloHome/config/accelo.yml and set:
Bash
Copy
  1. Run:
Bash
Copy
  1. Reset readOnlyRootFSEnabled to true and rerun:
Bash
Copy

Step 11: Update Playbooks

  1. Delete existing playbooks on the ad-director node:
Bash
Copy

Replace <cluster_name> with the name of your cluster.

  1. Download the latest playbooks tar file from the LICENSE UI.
  2. 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.

Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard