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:

• Upgrade Pulse from Version 4.0.0. to 4.0.1

• Upgrade Pulse from Version 3.8.x. to 4.0.1

• Upgrade Pulse from Version 3.7.x. to 4.0.1

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:

For Podman:

Once modified, run the following command to apply the updated environment variables.

Step 2: Update the Accelo CLI

1. Take a backup of the existing accelo CLI binary.

2. Download the latest accelo.linux CLI.

Authenticate and pull latest images:

Replace and make CLI executable:

Step 3: Update the Image Tag

Update the ImageTag in $AcceloHome/config/accelo.yml:

Step 4: Push Configuration to Database

Step 5: Load Images (offline installations only)

Download the latest image packs and load them:

Step 6: Restart All Services

Step 7: Uninstall Hydra Agent

Step 8: Install the Hydra Agent

Step 9: Reconfigure the Cluster

Step 10: Push Configuration to Database (Post Reconfig)

Step 11: Verify the Upgrade

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:

For Podman:

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:

4. Update the ImageTag in $AcceloHome/config/accelo.yml to 4.0.1.

5. Push the updated configuration to the database:

6. Run the following command to confirm the ImageTag update:

Step 3: For Offline Installations

1. Download all the latest image packs.

2. Upload the latest images using:

3. Run the migration command from $AcceloHome:

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:

• For multi-cluster setups, run:

4. If any issue occurs during migration, rerun the same command.

5. After migration, deploy the core components:

Step 4: For Online Installations

1. Log in and pull the latest binaries:

Press Y when prompted to get the most recent binaries.

2. Restart all containers so that they use the updated images.

Step 5: Update Hydra Agent

1. Uninstall the existing Hydra agent:

2. Install the updated Hydra agent:

Step 6: Reconfigure the Cluster

1. Reconfigure the cluster to get the updated configuration for agents.

2. Push the updated configuration to the database:

Step 7: Update Pulse UI Proxy Configuration (SSL via ad-proxy)

If SSL is enabled for Pulse UI using an ad proxy, you must update the proxy configuration because the legacy ad-graphql (old Pulse UI) service is no longer the default.

Update Proxy Configuration

Edit the following file:

Change:

To:

Why is this required?

The ad-graphql service (old Pulse UI) has been removed as the default Pulse UI service. The proxy must now point to ad-pulse-ui.

Restart ad-proxy

After making the change, restart the proxy service:

Alternative: Enable Native SSL (Without ad-proxy)

If ad-proxy is deployed as an addon; you can remove it and enable native SSL support directly in Pulse UI.

1. Run:

2. Unselect Proxy

3. Follow the official documentation to enable native SSL: Enable Native SSL/TLS for Pulse Web UI.

Step 8: Configure MongoDB Cleanup and Compaction

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

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

2. Reset readOnlyRootFSEnabled to true and run:

Step 10: Update Playbooks

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

Replace <cluster_name> with the name of your cluster.

2. Download the latest playbooks tar file from the LICENSE UI.

3. 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:

For Podman:

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:

4. Push the updated configuration to the database:

5. Upgrade MongoDB to version 8.0.8:

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

6. Update the ImageTag in $AcceloHome/config/accelo.yml to 4.0.1.

7. Push the updated configuration to the database again:

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

Step 3: For Offline Installations

1. Download all the latest image packs.

2. Upload the latest images:

3. Update and add new keys in vars.yml:

Step 4: (Optional) Update LDAP Configuration

If ad-ldap is deployed, follow these steps:

1. Generate an encrypted password:

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

2. Update the following file:

   • Edit /data01/acceldata/config/ldap/ldap.conf

   • Set bindPW to the new encrypted password.

   • Add the flag: encryptedPassword = true

3. Push the updated configuration:

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:

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:

For multi-cluster:

3. If any issue occurs during migration, rerun the same command.

4. Deploy the core components:

Step 6: For Online Installations

1. Log in and pull the latest binaries:

Press Y when prompted to get the most recent binaries.

2. Restart all containers so that they use the updated images.

Step 7: Update Hydra Agent

1. Uninstall the existing Hydra agent:

2. Install the updated Hydra agent:

Step 8: Reconfigure the Cluster

1. Reconfigure the cluster to apply updated configurations for agents..

2. Push the latest configuration to the database:

Step 9: Update Pulse UI Proxy Configuration (SSL via ad-proxy)

If SSL is enabled for Pulse UI using an ad proxy, you must update the proxy configuration because the legacy ad-graphql (old Pulse UI) service is no longer the default.

Update Proxy Configuration

Edit the following file:

Change:

To:

Why is this required?

The ad-graphql service (old Pulse UI) has been removed as the default Pulse UI service. The proxy must now point to ad-pulse-ui.

Restart ad-proxy

After making the change, restart the proxy service:

Alternative: Enable Native SSL (Without ad-proxy)

If ad-proxy is deployed as an addon, you can remove it and enable native SSL support directly in Pulse UI.

1. Run:

2. Unselect Proxy

3. Follow the official documentation to enable native SSL: Enable Native SSL/TLS for Pulse Web UI.

Step 10: Configure MongoDB Cleanup and Compaction

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

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

2. Run:

3. Reset readOnlyRootFSEnabled to true and rerun:

Step 12: Update Playbooks

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

Replace <cluster_name> with the name of your cluster.

2. Download the latest playbooks tar file from the LICENSE UI.

3. 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.1 with the latest configurations, images, and agents.