Acceldata
 Pulse
Search documentation… ⌘K

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:

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:

export CONTAINER_TOOL='docker'
For Podman:

export CONTAINER_TOOL='podman'
export REGISTRY_AUTH_FILE=${AcceloHome}/config/podman/config.json

Info

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).

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

source /etc/profile.d/ad.sh

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:

accelo login docker
accelo pull all
Replace and make CLI executable:

mv accelo.linux accelo
chmod +x ./accelo

Step 3: Update the Image Tag

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

ImageTag: 4.0.1

Step 4: Push Configuration to Database

accelo admin database push-config -a

Step 5: Load Images (offline installations only)

Download the latest image packs and load them:

docker load -i <image-pack-file>

Step 6: Restart All Services

accelo restart all -d

Step 7: Uninstall Hydra Agent

accelo uninstall remote

Step 8: Install the Hydra Agent

accelo deploy hydra

Step 9: Reconfigure the Cluster

accelo reconfig cluster -a

Step 10: Push Configuration to Database (Post Reconfig)

accelo admin database push-config -a

Step 11: Verify the Upgrade

accelo info

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:

export CONTAINER_TOOL='docker'
For Podman:

export CONTAINER_TOOL='podman'
export REGISTRY_AUTH_FILE=${AcceloHome}/config/podman/config.json

Info

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:
mv accelo.linux accelo
chmod +x ./accelo
  1. Update the ImageTag in $AcceloHome/config/accelo.yml to 4.0.1.
  2. Push the updated configuration to the database:
accelo admin database push-config -a
  1. Run the following command to confirm the ImageTag update:
accelo info

Step 3: For Offline Installations

  1. Download all the latest image packs.
  2. Upload the latest images using:
docker load -i
  1. Run the migration command from $AcceloHome:

Info

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
  1. If any issue occurs during migration, rerun the same command.
  2. After migration, deploy the core components:
accelo deploy core

Step 4: For Online Installations

  1. Log in and pull the latest binaries:
accelo login docker
accelo pull all
Press Y when prompted to get the most recent binaries.
  1. Restart all containers so that they use the updated images.
accelo restart all -d

Step 5: Update Hydra Agent

  1. Uninstall the existing Hydra agent:
accelo uninstall remote
  1. Install the updated Hydra agent:
accelo deploy hydra

Step 6: Reconfigure the Cluster

  1. Reconfigure the cluster to get the updated configuration for agents.
accelo reconfig cluster -a
  1. Push the updated configuration to the database:
accelo admin database push-config -a

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:

$AcceloHome/config/proxy/config.toml
Change:

url = "http://ad-graphql:4000"
To:

url = "http://ad-pulse-ui:4000"
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:

accelo restart ad-proxy
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:
accelo deploy addons
  1. Unselect Proxy
  2. Follow the official documentation to enable native SSL: Configure 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:

accelo config retention

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:
accelo admin database push-config
accelo restart all -d
accelo admin database index-db
  1. Reset readOnlyRootFSEnabled to true and run:
accelo admin database push-config
accelo restart all -d

Step 10: Update Playbooks

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

export CONTAINER_TOOL='docker'
For Podman:

export CONTAINER_TOOL='podman'
export REGISTRY_AUTH_FILE=${AcceloHome}/config/podman/config.json

Info

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:
mv accelo.linux accelo
chmod +x ./accelo
  1. Push the updated configuration to the database:
accelo admin database push-config -a
  1. Upgrade MongoDB to version 8.0.8:
accelo admin database migrate
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:
accelo admin database push-config -a
  1. Verify the update: Run the info command to confirm the ImageTag update.
accelo info

Step 3: For Offline Installations

  1. Download all the latest image packs.
  2. Upload the latest images:
docker load -i
  1. Update and add new keys in vars.yml:
accelo reconfig cluster

Info

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:
accelo admin encrypt
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:
accelo admin database push-config

Info

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:

Info

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:

accelo migrate -v 4.0.0 -i 3.7.0 -b
For multi-cluster:

accelo migrate -v 4.0.0 -i 3.7.0 -a -b
  1. If any issue occurs during migration, rerun the same command.
  2. Deploy the core components:
accelo deploy core

Step 6: For Online Installations

  1. Log in and pull the latest binaries:
accelo login docker
accelo pull all
Press Y when prompted to get the most recent binaries.
  1. Restart all containers so that they use the updated images.
accelo restart all -d

Step 7: Update Hydra Agent

  1. Uninstall the existing Hydra agent:
accelo uninstall remote
  1. Install the updated Hydra agent:
accelo deploy hydra

Step 8: Reconfigure the Cluster

  1. Reconfigure the cluster to apply updated configurations for agents..
accelo reconfig cluster -a
  1. Push the latest configuration to the database:
accelo admin database push-config -a

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:

$AcceloHome/config/proxy/config.toml
Change:

url = "http://ad-graphql:4000"
To:

url = "http://ad-pulse-ui:4000"
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:

accelo restart ad-proxy
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:
accelo deploy addons
  1. Unselect Proxy
  2. Follow the official documentation to enable native SSL: Configure 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:

accelo config retention

Step 11: Create Database Indices

Run the following command to create indices for database collections:

accelo admin database index-db
If readOnlyRootFSEnabled is set to true in $AcceloHome/config/accelo.yml, follow these steps:
  1. Open $AcceloHome/config/accelo.yml and set:
readOnlyRootFSEnabled: false
  1. Run:
accelo admin database push-config
accelo restart all -d
accelo admin database index-db
  1. Reset readOnlyRootFSEnabled to true and rerun:
accelo admin database push-config
accelo restart all -d

Step 12: Update Playbooks

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