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:

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

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.

The following services were deprecated and replaced in the 4.1.0 release:

  • ad-director (deprecated) → ad-axnserver
  • ad-proxy (deprecated) → ad-pulse-ui

Before starting the migration:

  1. Run the following command: accelo deploy addons
  2. Ensure the deprecated services are unchecked or disabled.
  3. Proceed with the deployment.

This step must be completed before migration. Otherwise, the migration will fail.

Step 1: Update Container Runtime Configuration (Required Only for 4.0.0)

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

For Podman:

Bash
Copy

For Docker:

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

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

Bash
Copy

Step 2: Uninstall Hydra Agent

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

SSH-based deployment

Bash
Copy

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:
Bash
Copy

Step 4: Update the Image Tag

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

Bash
Copy

Set the version to:

Bash
Copy

Push the updated configuration to the database:

Bash
Copy

Verify the update:

Bash
Copy

Step 5: Offline Installations: Load Latest Images

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

Bash
Copy

Step 6: Run Migration

Run the migration command from $AcceloHome.

Do not change the -v value 4.1.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.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:

Bash
Copy

For multi-cluster setups, run:

Bash
Copy

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

Step 7: Online Installations: Pull Latest Images

For online installations, run:

Bash
Copy

Press Y when prompted to download the most recent binaries.

Step 8: Restart Containers

Restart all containers to use the updated images:

Bash
Copy

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.
Bash
Copy
  1. If the Actions Service container is not present, deploy it using the command:
Bash
Copy
  1. When prompted, select Actions Service.
Bash
Copy
  1. Press Enter to start deployment.

Verify the deployment

After deployment completes, confirm that the container is running:

Bash
Copy

Expected output (status should be Up):

Bash
Copy

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

Bash
Copy

Reconfigure Notifications

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

Bash
Copy

Example:

Bash
Copy

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:

Bash
Copy

Step 10: Install Hydra Agent

  1. Deploy Hydra agents:
Bash
Copy

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

  1. Reconfigure the cluster to apply the updated agent configuration:
Bash
Copy
  1. Push the updated configuration to the database:
Bash
Copy

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 Native SSL/TLS Support for Pulse Web UI.

Step 12: Configure Retention

To configure MongoDB cleanup and compaction scheduling:

Bash
Copy

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

Upgrade Pulse from Version 3.8.x. to 4.1.0

The following services were deprecated and replaced in the 4.1.0 release:

  • ad-director (deprecated) → ad-axnserver
  • ad-proxy (deprecated) → ad-pulse-ui

Before starting the migration:

  1. Run the following command: accelo deploy addons
  2. Ensure the deprecated services are unchecked or disabled.
  3. Proceed with the deployment.

This step must be completed before migration. Otherwise, the migration will fail.

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

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

Bash
Copy

Step 2: Uninstall Hydra Agent

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

SSH-based deployment

Bash
Copy

Mpack and parcel-based deployments

  • Uninstall Hydra agents from the CDP or Ambari UI.
  • 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:
Bash
Copy

Step 4: Update ImageTag

Update the ImageTag in:

Bash
Copy

Set:

Bash
Copy

Push the updated configuration to the database:

Bash
Copy

Verify the update:

Bash
Copy

Step 5: Offline Installations: Load Latest Images

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

Bash
Copy

Step 7: Run Migration

Do not change the -v value from 4.1.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.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:
Bash
Copy
  • For multi-cluster setups, run:
Bash
Copy

If any issues occur, rerun the same migration command.

Step 8: Deploy Core Services

After migration, deploy core services:

Bash
Copy

Step 9: Online Installations: Pull Latest Images

For online installations:

Bash
Copy

Press Y when prompted to download the latest binaries.

Step 10: Restart Containers

Restart all containers to apply the updated images:

Bash
Copy

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.
Bash
Copy
  1. If the Actions Service container is not present, deploy it using the command:
Bash
Copy
  1. When prompted, select Actions Service.
Bash
Copy
  1. Press Enter to start deployment.

Verify the deployment

After deployment completes, confirm that the container is running:

Bash
Copy

Expected output (status should be Up):

Bash
Copy

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

Bash
Copy

Reconfigure Notifications

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

Bash
Copy

Example:

Bash
Copy

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:

Bash
Copy

Step 11: Install Hydra Agent

Deploy Hydra agents:

Bash
Copy

Reconfigure the cluster:

Bash
Copy

Push updated configuration to the database:

Bash
Copy

Step 12: (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 Native SSL/TLS Support for Pulse Web UI.

Step 12: Configure Retention

To configure MongoDB cleanup and compaction:

Bash
Copy

Step 13: Create Database Indexes

Create database indexes:

Bash
Copy

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:
Bash
Copy
  1. Create indexes:
Bash
Copy
  1. Set readOnlyRootFSEnabled back to true.
  2. Push configuration and restart again:
Bash
Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard