Title
Create new category
Edit page index title
Edit category
Edit link
Upgrade to Version 4.0.3
You can follow the appropriate steps to upgrade Pulse to version 4.0.3 based on your current deployment:
- Upgrade Pulse from Version 4.0.0. to 4.0.3
- Upgrade Pulse from Version 3.8.x. to 4.0.3
- Upgrade Pulse from Version 3.7.x. to 4.0.3
Upgrade Pulse from Version 4.0.0. to 4.0.3
Step 1: Update Container Runtime Configuration
Update /etc/profile.d/ad.sh based on the container orchestration tool in use.
For Docker:
xxxxxxxxxxexport CONTAINER_TOOL='docker'For Podman:
xxxxxxxxxxexport 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).
Once modified, run the following command to apply the updated environment variables.
xxxxxxxxxxsource /etc/profile.d/ad.shStep 2: Update the Accelo CLI
- Take a backup of the existing accelo CLI binary.
- Download the latest accelo.linux CLI.
Authenticate and pull latest images:
xxxxxxxxxxaccelo login dockeraccelo pull allReplace and make CLI executable:
xxxxxxxxxxmv accelo.linux accelochmod +x ./acceloStep 3: Update the Image Tag
Update the ImageTag in $AcceloHome/config/accelo.yml:
xxxxxxxxxxImageTag: 4.0.3Step 4: Push Configuration to Database
xxxxxxxxxxaccelo admin database push-config -aStep 5: Load Images (offline installations only)
Download the latest image packs and load them:
xxxxxxxxxxdocker load -i <image-pack-file>Step 6: Restart All Services
xxxxxxxxxxaccelo restart all -dStep 7: Uninstall Hydra Agent
xxxxxxxxxxaccelo uninstall remoteStep 8: Install the Hydra Agent
xxxxxxxxxxaccelo deploy hydraStep 9: Reconfigure the Cluster
xxxxxxxxxxaccelo reconfig cluster -aStep 10: Push Configuration to Database (Post Reconfig)
xxxxxxxxxxaccelo admin database push-config -aStep 11: Verify the Upgrade
xxxxxxxxxxaccelo infoUpgrade Pulse from Version 3.8.x. to 4.0.3
Step 1: Update Container Runtime Configuration
Update /etc/profile.d/ad.sh based on the container orchestration tool in use.
For Docker:
xxxxxxxxxxexport CONTAINER_TOOL='docker'For Podman:
xxxxxxxxxxexport 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).
Once modified, run the following command to apply the updated environment variables.
xxxxxxxxxxsource /etc/profile.d/ad.shStep 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:
xxxxxxxxxxmv accelo.linux accelochmod +x ./accelo- Update the
ImageTagin$AcceloHome/config/accelo.ymlto4.0.3. - Push the updated configuration to the database:
xxxxxxxxxxaccelo admin database push-config -a- Run the following command to confirm the ImageTag update:
xxxxxxxxxxaccelo infoStep 3: For Offline Installations
- Download all the latest image packs.
- Upload the latest images using:
xxxxxxxxxxdocker 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.3). 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.3, the migration command looks as shown below.
- For a single cluster, run:
xxxxxxxxxxaccelo migrate -v 4.0.0 -i 3.8.0 -b- For multi-cluster setups, run:
xxxxxxxxxxaccelo 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:
xxxxxxxxxxaccelo deploy coreStep 4: For Online Installations
- Log in and pull the latest binaries:
xxxxxxxxxxaccelo login dockeraccelo pull allPress Y when prompted to get the most recent binaries.
- Restart all containers so that they use the updated images.
xxxxxxxxxxaccelo restart all -dStep 5: Update Hydra Agent
- Uninstall the existing Hydra agent:
xxxxxxxxxxaccelo uninstall remote- Install the updated Hydra agent:
xxxxxxxxxxaccelo deploy hydraStep 6: Reconfigure the Cluster
- Reconfigure the cluster to get the updated configuration for agents.
xxxxxxxxxxaccelo reconfig cluster -a- Push the updated configuration to the database:
xxxxxxxxxxaccelo admin database push-config -aStep 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:
xxxxxxxxxx$AcceloHome/config/proxy/config.tomlChange:
xxxxxxxxxxurl = "http://ad-graphql:4000"To:
xxxxxxxxxxurl = "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:
xxxxxxxxxxaccelo restart ad-proxyAlternative: 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.
- Run:
xxxxxxxxxxaccelo deploy addons- Unselect Proxy
- Follow the official documentation to enable native SSL: Native SSL/TLS Support 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:
xxxxxxxxxxaccelo config retentionStep 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:
- Open
$AcceloHome/config/accelo.ymland setreadOnlyRootFSEnabledto false. - Run:
xxxxxxxxxxaccelo admin database push-configaccelo restart all -daccelo admin database index-db- Reset
readOnlyRootFSEnabledto true and run:
xxxxxxxxxxaccelo admin database push-configaccelo restart all -dStep 10: Update Playbooks
- If older playbooks exist on the node where ad-director is deployed, delete them:
xxxxxxxxxxrm -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.2 with updated configurations, images, and agents
Upgrade Pulse from Version 3.7.x. to 4.0.3
Follow these steps to upgrade from version 3.7.x to 4.0.3.
Step 1: Update Container Runtime Configuration
Update /etc/profile.d/ad.sh based on the container orchestration tool in use.
For Docker:
xxxxxxxxxxexport CONTAINER_TOOL='docker'For Podman:
xxxxxxxxxxexport 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).
Once modified, run the following command to apply the updated environment variables.
xxxxxxxxxxsource /etc/profile.d/ad.shStep 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:
xxxxxxxxxxmv accelo.linux accelochmod +x ./accelo- Push the updated configuration to the database:
xxxxxxxxxxaccelo admin database push-config -a- Upgrade MongoDB to version 8.0.8:
xxxxxxxxxxaccelo 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.3. - Push the updated configuration to the database again:
xxxxxxxxxxaccelo admin database push-config -a- Verify the update: Run the info command to confirm the ImageTag update.
xxxxxxxxxxaccelo infoStep 3: For Offline Installations
- Download all the latest image packs.
- Upload the latest images:
xxxxxxxxxxdocker load -i- Update and add new keys in
vars.yml:
xxxxxxxxxxaccelo 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:
xxxxxxxxxxaccelo 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:
xxxxxxxxxxaccelo 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.3
- 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.3). 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.3, the migration command looks as shown below.
For a single cluster:
xxxxxxxxxxaccelo migrate -v 4.0.0 -i 3.7.0 -bFor multi-cluster:
xxxxxxxxxxaccelo 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:
xxxxxxxxxxaccelo deploy coreStep 6: For Online Installations
- Log in and pull the latest binaries:
xxxxxxxxxxaccelo login dockeraccelo pull allPress Y when prompted to get the most recent binaries.
- Restart all containers so that they use the updated images.
xxxxxxxxxxaccelo restart all -dStep 7: Update Hydra Agent
- Uninstall the existing Hydra agent:
xxxxxxxxxxaccelo uninstall remote- Install the updated Hydra agent:
xxxxxxxxxxaccelo deploy hydraStep 8: Reconfigure the Cluster
- Reconfigure the cluster to apply updated configurations for agents..
xxxxxxxxxxaccelo reconfig cluster -a- Push the latest configuration to the database:
xxxxxxxxxxaccelo admin database push-config -aStep 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:
xxxxxxxxxx$AcceloHome/config/proxy/config.tomlChange:
xxxxxxxxxxurl = "http://ad-graphql:4000"To:
xxxxxxxxxxurl = "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:
xxxxxxxxxxaccelo restart ad-proxyAlternative: 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.
- Run:
xxxxxxxxxxaccelo deploy addons- Unselect Proxy
- Follow the official documentation to enable native SSL: Native SSL/TLS Support 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:
xxxxxxxxxxaccelo config retentionStep 11: Create Database Indices
Run the following command to create indices for database collections:
xxxxxxxxxxaccelo admin database index-dbIf readOnlyRootFSEnabled is set to true in $AcceloHome/config/accelo.yml, follow these steps:
- Open
$AcceloHome/config/accelo.ymland set:
xxxxxxxxxxreadOnlyRootFSEnabled: false- Run:
xxxxxxxxxxaccelo admin database push-configaccelo restart all -daccelo admin database index-db- Reset
readOnlyRootFSEnabledtotrueand rerun:
xxxxxxxxxxaccelo admin database push-configaccelo restart all -dStep 12: Update Playbooks
- Delete existing playbooks on the ad-director node:
xxxxxxxxxxrm -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.3 with the latest configurations, images, and agents.
For additional help, contact www.acceldata.force.com OR call our service desk +1 844 9433282
Copyright © 2026