Upgrade to Version 4.1.0

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

• Upgrade Pulse from Version 4.0.x to 4.1.0

• Upgrade Pulse from Version 3.8.x. to 4.1.0

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

Enable the runMigrations Property for Dashplots

Before performing a fresh installation or upgrading Pulse to a newer version, verify that the runMigrations property in the ad-dashplots-ui section of the ad-core configuration is set to true.

This property enables the required Dashplot database migrations. If it is not enabled during an upgrade, the ad-dashplots-ui service may fail to start and repeatedly restart with a database migration error similar to the following:

ERROR: column dashplot_reporting.cluster_key does not exist

For more information about the runMigrations property and other Dashplot configuration options, see Configure Dashplot Variables.

Upgrade Pulse from Version 4.0.x to 4.1.0

This section describes the required steps to upgrade from Pulse 4.0.x to 4.1.0.

Step 1: Update Container Runtime Configuration

Update the /etc/profile.d/ad.sh file based on your container runtime.

For Podman:

For Docker:

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

Step 2: Uninstall Hydra Agent

Hydra agents must be uninstalled to stop NATS stream data from being sent.

SSH-based deployment

Mpack and parcel-based deployments

• Uninstall Hydra agents from the CDP or Ambari UI.

• This step is required to stop NATS streams from being sent from agents side. Before doing further steps, ensure all NATS stream data has been processed before continuing.

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

Step 4: Update the Image Tag

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

Set the version to:

Push the updated configuration to the database:

Verify the update:

Step 5: Offline Installations: Load Latest Images

For offline installations, download the latest image packs and load them:

Step 6: Run Migration

Run the migration command from $AcceloHome.

For example:

• -v: specifies the version you are migrating to (4.1.0). Note: Keep the version as -v 4.1.0, even when you are migrating to any update release version in 4.1.x.

• -i: specifies the version you are migrating from (4.0.0).

To migrate from version 4.0.0 to 4.1.0, the migration command looks as shown below.

For a single cluster, run:

For multi-cluster setups, run:

If any issues occur during migration, rerun the same command.

Step 7: Online Installations: Pull Latest Images

For online installations, run:

Press Y when prompted to download the most recent binaries.

Step 8: Restart Containers

Restart all containers to use the updated images:

Step 9: (Optional) Migrate from old Actions (ad-director) to the new Actions service

Pulse does not support Kerberos migration from old actions to new actions. For new actions, the Kerberos plugin had to be added before running any action plugin if the cluster was kerberized.

1. If the ad-director was previously configured, verify that the new Actions Service (ad-axnserver) container is running.

2. If the Actions Service container is not present, deploy it using the command:

3. When prompted, select Actions Service.

4. Press Enter to start deployment.

Verify the deployment

After deployment completes, confirm that the container is running:

Expected output (status should be Up):

Check the container logs to confirm that the service has started successfully:

Reconfigure Notifications

If notifications (Email, Slack, Jira) were configured in ad-director, enable them again for the new Actions service.

Example:

After configuration completes:

• The notifications configuration file is generated.

• The configuration is pushed to the Pulse database.

Run the migration

Once the Actions Service is running and healthy, run:

Step 10: Install Hydra Agent

1. Deploy Hydra agents:

For mpack- or parcel-based deployments, install the Hydra agent using Ambari or Cloudera Manager.

2. Reconfigure the cluster to apply the updated agent configuration:

3. Push the updated configuration to the database:

Step 11: (Optional) Enable native SSL in Pulse UI

• If SSL was previously enabled using ad-proxy, enable native SSL support in Pulse UI.

• The ad-proxy service has been removed starting in Pulse 4.1.x. Native SSL must now be configured directly in Pulse UI.

• For instructions, see Enable Native SSL/TLS for Pulse Web UI.

Step 12: Configure Retention

To configure MongoDB cleanup and compaction scheduling:

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

Upgrade Pulse from Version 3.8.x. to 4.1.0

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: Uninstall Hydra Agent

Hydra agents must be uninstalled to stop NATS stream data from being sent.

SSH-based deployment

Mpack and parcel-based deployments

• Uninstall Hydra agents from the CDP or Ambari UI.

• This step is required to Stop nats streams data being sent from agents side. Ensure all NATS stream data has been processed before continuing.

Step 3: Update Accelo CLI

1. Take a backup of the existing Accelo binary.

2. Download the latest accelo.linux CLI.

3. Replace the binary and make it executable:

Step 4: Before upgrading Pulse to version 4.1.0 from 3.8.X, you must upgrade both:

• ad-elastic

• ad-fs-elastic

Elasticsearch instances from ES 8.16.6 → ES 8.18.4. For details, see Upgrade ElasticSearch from ES 8.16.6 to ES 8.18.4.

• This step is mandatory and must be completed before running the main Pulse migration command.

• Make sure the cluster health is YELLOW or GREEN before proceeding with the Elasticsearch migration.

Step 5: Update ImageTag

Update the ImageTag in:

Set:

Push the updated configuration to the database:

Verify the update:

Step 6: Offline Installations: Load Latest Images

For offline installations, download the latest image packs and load them:

Step 7: Run Migration

For example:

• -v: specifies the version you are migrating to (4.1.0). Note: Keep the version as -v 4.1.0, even when you are migrating to any update release version in 4.1.x.

• -i: specifies the version you are migrating from (3.8.0).

To migrate from version 3.8.0 to 4.1.0, the migration command looks as shown below.

• For a single cluster, run:

• For multi-cluster setups, run:

If any issues occur, rerun the same migration command.

Step 8: Deploy Core Services

After migration, deploy core services:

Step 9: Online Installations: Pull Latest Images

For online installations:

Press Y when prompted to download the latest binaries.

Step 10: Restart Containers

Restart all containers to apply the updated images:

Step 11: (Optional) Migrate from old Actions (ad-director) to the new Actions service

1. If the ad-director was previously configured, verify that the new Actions Service (ad-axnserver) container is running.

2. If the Actions Service container is not present, deploy it using the command:

3. When prompted, select Actions Service.

4. Press Enter to start deployment.

Verify the deployment

After deployment completes, confirm that the container is running:

Expected output (status should be Up):

Check the container logs to confirm that the service has started successfully:

Reconfigure Notifications

If notifications (Email, Slack, Jira) were configured in ad-director, enable them again for the new Actions service.

Example:

After configuration completes:

• The notifications configuration file is generated.

• The configuration is pushed to the Pulse database.

Run the migration

Once the Actions Service is running and healthy, run:

Step 12: Install Hydra Agent

Deploy Hydra agents:

Reconfigure the cluster:

Push updated configuration to the database:

Step 13: (Optional) Enable native SSL in Pulse UI

• If SSL was previously enabled using ad-proxy, enable native SSL support in Pulse UI.

• The ad-proxy service has been removed starting in Pulse 4.1.x. Native SSL must now be configured directly in Pulse UI.

• For instructions, see Enable Native SSL/TLS for Pulse Web UI.

Step 14: Configure Retention

To configure MongoDB cleanup and compaction:

Step 15: Create Database Indexes

Create database indexes:

If readOnlyRootFSEnabled Is Set to true

If readOnlyRootFSEnabled is enabled in $AcceloHome/config/accelo.yml, perform the following steps:

1. Set readOnlyRootFSEnabled to false.

2. Push configuration and restart:

3. Create indexes:

4. Set readOnlyRootFSEnabled back to true.

5. Push configuration and restart again: