Upgrade to Version 3.7.1
If you are upgrading Pulse from the version 3.5.0 or lower, make sure to export all the custom dashboards from the Pulse UI. For details, see Exporting Dashboards.
Prerequisite
Upgrade the Docker version to 20.10.x or above.
Steps to upgrade the Docker version:
- Uninstall the current Docker:
yum remove -y docker-ce docker-ce-cli containerd.io
- Install the latest version of Docker:
yum install -y docker-ce docker-ce-cli containerd.io
- To install a specific version of Docker:
yum install -y docker-ce-24.0.5 docker-ce-cli-24.0.5 containerd.io
- Replace 24.0.5 with the appropriate version string
- To list specific versions of docker
yum list docker-ce --showduplicates | sort -r
- Start Docker:
systemctl start docker
Migration Steps from Version 3.7.x to 3.7.1
Follow these steps to upgrade Pulse.
Update Configuration:
- Update
ImageTag
in the$AcceloHome/config/accelo.yml
file to3.7.1
.
- Update
Push Updated Configuration to Database:
- Run the following command:
accelo admin database push-config -a
- Take a backup of the
accelo
file and download the latest version foraccelo.linux
CLI. - Move and make the latest
accelo
CLI file as an executable. Also, check the updated Pulse information for the following.
mv accelo.linux accelo
chmod +x ./accelo
- For the Online installations, run the following command and press 'Y' at the prompt to get the most recent binaries.
accelo login docker
accelo pull all
- For the Offline Installations, download all the latest image packs and run the following command to upload the latest images.
docker load -i
- Run the below command to update and add new keys in
vars.yml.
accelo reconfig cluster
- [Optional: If AD-LDAP is deployed] Run the following command to generate an encrypted password for the LDAP server connection.
accelo admin encrypt
- Enter the plain-text password to generate the encrypted password.
- Update the
bindPW
field in/data01/acceldata/config/ldap/ldap.conf
with the encrypted value, and add theencryptedPassword = true
flag in the same configuration file.
- Run the below command to push
acceldata.conf
and other updated files to MongoDB.
accelo admin database push-config
- Restart all containers including database(s) with the following command.
accelo restart all -d
- Uninstall the Hydra Agent.
accelo uninstall remote
- Install the Hydra Agent.
accelo deploy hydra
- Reconfigure the cluster to get the updated configurations for Agents.
accelo reconfig cluster -a
Migration Steps from Version 3.6.x to 3.7.1
Follow these steps to upgrade Pulse.
Update Configuration:
- Update
ImageTag
in the$AcceloHome/config/accelo.yml
file to3.7.1
.
- Update
Push Updated Configuration to Database:
- Run the following command:
accelo admin database push-config
- Ensure that you have downloaded and loaded all the necessary Docker images for 3.7.1.
- Download a new
accelo
binary and replace the existing one with the newaccelo
binary.
Ensure that you do not change the value of v
from 3.7.0 to anything else unless explicitly advised by Acceldata. The following command needs to run on all the Pulse nodes including standalone nodes i.e. nodes where PULSE_SA_NODE
is true. The examples of such nodes include, but aren’t limited to Logsearch, FS Analytics V2, and Dashplot.
- Run the migration command. For example:
-v 3.7.0
: The version you are migrating to.Note Keep the version as-v 3.7.0
, even when you are migrating to any update release version in 3.7.x.-i 3.6.2
: The version you are migrating from.- To migrate from version 3.6.2 to 3.7.1, the migration command looks as shown below.
Ensure that you run the following command from $AcceloHome.
For a single cluster:
accelo migrate -v 3.7.0 -i 3.6.2 -b
For multi-cluster:
accelo migrate -v 3.7.0 -i 3.6.2 -a -b
- Run the same command again, If any issue occurs during migration on any step.
- If YARN optimizer is deployed, append the feature flag
"enableStaticQueue": true
to thead-graphql
section in thead-core.yml
file.
vi $AcceloHome/config/docker/ad-core.yml
After adding the mentioned feature flag, the FEATURE_FLAG
environment must look as below. If you have additional FEATURE_FLAG
entries, do not need to remove them, just append "enableStaticQueue": true
at the end . For example:
'FEATURE_FLAGS={ "ui_regex": { "regex": "ip-([^.]+)", "index": 1 }, "rename_nav_labels":{}, "timezone": "", "experimental": true, "themes": false, "hive_const":{ "HIVE_QUERY_COST_ENABLED": false, "HIVE_MEMORY_GBHOUR_COST": 0, "HIVE_VCORE_HOUR_COST": 0 }, "spark_const": { "SPARK_QUERY_COST_ENABLED": false, "SPARK_MEMORY_GBHOUR_COST": 0, "SPARK_VCORE_HOUR_COST": 0 }, "queryRecommendations": false, "hostIsTrialORLocalhost": false, "data_temp_string": "", "enableStaticQueue" : true }'
- Restart all the containers so that they use the updated images.
accelo restart all -d
- Uninstall the Hydra Agent.
accelo uninstall remote
- Install the Hydra Agent.
accelo deploy hydra
- If Logsearch is deployed in standalone mode, verify whether the
yarn app es_urls
parameter is present in theoverride.yml
file. If it exists, update the port number from 19013 to 19051.
yarn_app_es_urls: <http://<LOG_SEARCH_HOSTNAME>>:19051
- Reconfigure the cluster to get the updated configuration for Agents.
accelo reconfig cluster -a
If your ODP cluster has Kafka 3 installed, you need to run accelo config cluster
before performing this step.
- [Optional: If AD-LDAP is deployed] Run the following command to generate an encrypted password for the LDAP server connection.
accelo admin encrypt
- Enter the plain-text password to generate the encrypted password.
- Update the
bindPW
field in/data01/acceldata/config/ldap/ldap.conf
with the encrypted value, and add theencryptedPassword = true
flag in the same configuration file.
- To push the updated configuration to database, execute the following command.
accelo admin database push-config -a
- To configure when
gauntlet snap
must run the MongoDB cleanup and compaction, run the following command.
accelo config retention
- Finally execute the following command to create indices for database collections.
If readOnlyRootFSEnabled is set to true in $AcceloHome/config/accelo.yml, then follow the steps listed below instead of running the command directly.
1. Open $AcceloHome/config/accelo.yml and set the value of readOnlyRootFSEnabled to false.
2. Run accelo admin database push-config
3. Run accelo restart all -d.
4. Run accelo admin database index-db.
5. Open $AcceloHome/config/accelo.yml and set the value of readOnlyRootFSEnabled to true.
6. Run accelo admin database push-config.
7. Run accelo restart all -d.
accelo admin database index-db
- If the older playbooks already present in the node where ad-director is deployed, delete them, and download the latest playbooks tar from the License UI.
- Delete the older playbooks using the command:
rm -rf $AcceloHome/work/<cluster_name>/director/playbook/*.
Replace<cluster_name>
with name of the cluster where the playbooks are present. - Download the playbooks tar from the License UI. For details, see Deploy Playbooks.
- Delete the older playbooks using the command:
Migration Steps from Version 3.5.x to 3.7.1
Follow these steps to upgrade Pulse.
Update Configuration:
- Update
ImageTag
in the$AcceloHome/config/accelo.yml
file to3.7.1
.
- Update
Push Updated Configuration to Database:
- Run the following command:
accelo admin database push-config
- Ensure that you have downloaded and loaded all the necessary Docker images for 3.7.1.
- Download a new
accelo
binary and replace the existing one with the newaccelo
binary.
Ensure that you do not change the value of v
from 3.7.0 to anything else unless explicitly advised by Acceldata. The following command needs to run on all the Pulse nodes including standalone nodes i.e. nodes where PULSE_SA_NODE
is true. The examples of such nodes include, but aren’t limited to Logsearch, FS Analytics V2, and Dashplot.
- Run the migration command. For example:
-v 3.7.0
: The version you are migrating to.Note Keep the version as-v 3.7.0
, even when you are migrating to any update release version in 3.7.x.-i 3.5.2
: The version you are migrating from.- To migrate from version 3.5.2 to 3.7.1, the migration command looks as shown below.
Ensure that you run the following command from $AcceloHome.
For a single cluster:
accelo migrate -v 3.7.0 -i 3.5.2 -b
For multi-cluster:
accelo migrate -v 3.7.0 -i 3.5.2 -a -b
- Run the same command again, If any issue occurs during migration on any step.
- Delete the following directories, if they are re present.
This step is applicable only if you are upgrading Pulse from 3.5.0.
rm -rf $AcceloHome/data/pg/*
rm -rf $AcceloHome/data/pg-ui/*
- Delete the metric groups from the alerts collection in MongoDB. Log into Mongo db and run following commands.
Note For details about logging into MongoDB, reach out to Acceldata Support.
use alerts
db.metric_groups.deleteMany({})
db.metrics.deleteMany({})
- If YARN optimizer is deployed, append the feature flag
"enableStaticQueue": true
to thead-graphql
section in thead-core.yml
file.
After adding the mentioned feature flag, the FEATURE_FLAG
environment must look like this. If you have additional FEATURE_FLAG
entries, do not need to remove them, just append "enableStaticQueue": true
at the end . For example:
vi $AcceloHome/config/docker/ad-core.yml
'FEATURE_FLAGS={ "ui_regex": { "regex": "ip-([^.]+)", "index": 1 }, "rename_nav_labels":{}, "timezone": "", "experimental": true, "themes": false, "hive_const":{ "HIVE_QUERY_COST_ENABLED": false, "HIVE_MEMORY_GBHOUR_COST": 0, "HIVE_VCORE_HOUR_COST": 0 }, "spark_const": { "SPARK_QUERY_COST_ENABLED": false, "SPARK_MEMORY_GBHOUR_COST": 0, "SPARK_VCORE_HOUR_COST": 0 }, "queryRecommendations": false, "hostIsTrialORLocalhost": false, "data_temp_string": "", "enableStaticQueue" : true }'
- Restart all the containers so that they use the updated images.
accelo restart all -d
- Uninstall the Hydra Agent.
accelo uninstall remote
- Install the Hydra Agent.
accelo deploy hydra
- If Logsearch is deployed in standalone mode, verify whether the
yarn app es_urls
parameter is present in theoverride.yml
file. If it exists, update the port number from 19013 to 19051.
yarn_app_es_urls: <http://<LOG_SEARCH_HOSTNAME>>:19051
- Reconfigure the cluster to get the updated configuration for Agents.
accelo reconfig cluster -a
If your ODP cluster has Kafka 3 installed, you need to run accelo config cluster
before performing this step.
- [Optional: If AD-LDAP is deployed] Run the following command to generate an encrypted password for the LDAP server connection.
accelo admin encrypt
- Enter the plain-text password to generate the encrypted password.
- Update the
bindPW
field in/data01/acceldata/config/ldap/ldap.conf
with the encrypted value, and add theencryptedPassword = true
flag in the same configuration file.
- To push the updated configuration to database, execute the following command.
accelo admin database push-config -a
- To configure when
gauntlet snap
must run the MongoDB cleanup and compaction, run the following command.
accelo config retention
- Finally execute the following command to create indices for database collections.
If readOnlyRootFSEnabled is set to true in $AcceloHome/config/accelo.yml, then follow the steps listed below instead of running the command directly.
1. Open $AcceloHome/config/accelo.yml and set the value of readOnlyRootFSEnabled to false.
2. Run accelo admin database push-config
3. Run accelo restart all -d.
4. Run accelo admin database index-db.
5. Open $AcceloHome/config/accelo.yml and set the value of readOnlyRootFSEnabled to true.
6. Run accelo admin database push-config.
7. Run accelo restart all -d.
accelo admin database index-db
- If the older playbooks already present in the node where ad-director is deployed, delete them, and download the latest playbooks tar from the License UI.
- Delete the older playbooks using the command:
rm -rf $AcceloHome/work/<cluster_name>/director/playbook/*.
Replace<cluster_name>
with name of the cluster where the playbooks are present. - Download the playbooks tar from the License UI. For details, see Deploy Playbooks.
- Delete the older playbooks using the command:
You can import the previously exported custom dashboards. For details, see Importing Dashboards.