OpenSearch Installation

The following procedures enable you to upgrade, downgrade, install, or uninstall OpenSearch in Workflow Insights:

Upgrading OpenSearch

This procedure describes how to upgrade to the newest version of OpenSearch.

Before You Begin

  • Define a Workflow Insights backup, as described in Defining Workflow Insights Backups.

  • Copy the Workflow Insights cluster backup location that you defined in Configuring Workflow Insights, and paste it to the following location:

    • UNIX: ~/BMCINSTALL/uninstall/DRNFT.<Current_Version>/Backup_OpenSearch_Snapshots

    • Windows: "%EM_HOME%\BMCINSTALL\uninstall\DRNFT.<Current_Version>\Backup_OpenSearch_Snapshots"

  • Install Control-M/EM 9.0.22, as described in Control-M Upgrade.

  • Verify that the Control-M/EM Configuration Agent is Up.

  • (Control-M Full Install only) Verify that the self-hosted Control-M/Server is Down.

Begin

  1. Log in as a Control-M/EM user.

  2. Run the following command to stop OpenSearch and OpenSearch Dashboards:

    • UNIX:

      em bmcpython ~/ctm_em/services/bin/opensearch_update/opensearch_manager.py stop

    • Windows:

      bmcpython "%EM_HOME%\services\bin\opensearch_update\opensearch_manager.py" stop

    In a Control-M/EM Cluster or High Availability Configuration, you must consecutively run this command on every host before you move to the next step.

  3. Run the following command to upgrade OpenSearch and OpenSearch Dashboards:

    • UNIX:

      em bmcpython ~/ctm_em/services/bin/opensearch_update/opensearch_manager.py install

    • Windows:

      bmcpython "%EM_HOME%\services\bin\opensearch_update\opensearch_manager.py" install

    In a Control-M/EM Cluster or High Availability Configuration, you must consecutively run this command on every host.

  4. Run the following command to verify that the OpenSearch services are running:

    em services-cli -st

Downgrading OpenSearch

This procedure describes how to downgrade OpenSearch and OpenSearch Dashboards in Control-M Workflow Insights to a previous version.

Begin

  1. Log in as a Control-M/EM user.

  2. Do the following:

    1. Run the following command to view the backups that can be restored:

      UNIX: em bmcpython <install path>/ctm_em/services/bin/elasticsearch_restore.py snapshots

      Windows: bmcpython "%EM_HOME%\services\bin\elasticsearch_restore.py" snapshots

      A list of backups appears.

    2. From the list of backups, find and record the backup Name that you want to restore.

  3. Uninstall Control-M Workflow Insights, as described below:

  4. Run the following command to downgrade Control-M/EM:

    • UNIX: ~/BMCINSTALL/uninstall/DRNFT.9.0.21.200/uninstall.sh

    • Windows: "%EM_HOME%\BMCINSTALL\uninstall\DRNFT.9.0.21.200\uninstall.exe"

  5. Reinstall Control-M Workflow Insights, as described below:

  6. Restore he previous version of OpenSearch with the backup Name that you recorded, as described in Restoring a Workflow Insights Backup.

Upgrading from Elasticsearch to OpenSearch

This procedure describes how to upgrade from Elasticsearch and Kibana (deprecated in Control-M) to OpenSearch and OpenSearch Dashboards in Control-M Workflow Insights.

Before You Begin

  • Define a Workflow Insights backup, as described in Defining Workflow Insights Backups.

  • Copy the Workflow Insights cluster backup location that you defined in Configuring Workflow Insights, and paste it to the following location:

    • UNIX: ~/BMCINSTALL/uninstall/DRNFT.<Current_Version>/Backup_Elasticsearch_Snapshots

    • Windows: "%EM_HOME%\BMCINSTALL\uninstall\DRNFT.<Current_Version>\Backup_Elasticsearch_Snapshots"

  • Install Control-M/EM 9.0.22, as described in Control-M Upgrade.

  • Verify that the Control-M/EM Configuration Agent is Up.

  • (Control-M Full Install only) Verify that the Control-M/Server is Down.

Begin

  1. Log in as a Control-M/EM user.

  2. Run the following command to stop Elasticsearch and Kibana:

    In a Control-M/EM Cluster or High Availability Configuration, you must consecutively run this command on every host before you move to the next step.

    • UNIX:

      em bmcpython ~/ctm_em/services/bin/opensearch_update/opensearch_manager.py stop

    • Windows:

      bmcpython "%EM_HOME%\services\bin\opensearch_update\opensearch_manager.py" stop

  3. Run the following command to install OpenSearch and OpenSearch Dashboards:

    In a Control-M/EM Cluster or High Availability Configuration, you must consecutively run this command on every host.

    • UNIX:

      em bmcpython ~/ctm_em/services/bin/opensearch_update/opensearch_manager.py install

    • Windows:

      bmcpython "%EM_HOME%\services\bin\opensearch_update\opensearch_manager.py" install

  4. Run the following command to verify that OpenSearch service is running:

    em services-cli -st

Uninstalling OpenSearch

This procedure describes how to uninstall OpenSearch and OpenSearch Dashboards and restore Elasticsearch and Kibana in Control-M Workflow Insights. You must uninstall OpenSearch when you downgrade from 9.0.22 to Control-M/EM 9.0.21.100 and lower.

Begin

  1. Log in as a Control-M/EM user.

  2. Do the following:

    1. Run the following command to view the backups that can be restored:

      UNIX: em bmcpython <install path>/ctm_em/services/bin/elasticsearch_restore.py snapshots

      Windows: bmcpython "%EM_HOME%\services\bin\elasticsearch_restore.py" snapshots

      A list of backups appears.

    2. From the list of backups, find and record the backup Name that you want to restore.

  3. Uninstall Control-M Workflow Insights, as described below:

  4. Run the following command to downgrade Control-M/EM:

    • UNIX: ~/BMCINSTALL/uninstall/DRNFT.9.0.21.200/uninstall.sh

    • Windows: "%EM_HOME%\BMCINSTALL\uninstall\DRNFT.9.0.21.200\uninstall.exe"

  5. Reinstall Control-M Workflow Insights, as described below:

  6. Restore Elasticsearch with the backup Name that you recorded, as described in Restoring a Workflow Insights Backup.