Install Moogsoft Add-ons

Moogsoft periodically provides updates to Moogsoft AIOps as add-ons. Add-ons may comprise updates to the Workflow Engine, new Workflow Engine functions, integrations tiles, and other features. This topic tells you how to install the latest version of the Moogsoft Add-ons. For information on the latest add-ons, see Moogsoft Add-ons.

Before you begin

Before you install Moogsoft Add-ons:

  • Verify you have SSH access to to your Moogsoft AIOps machines. For distributed or Highly Available installations, update the add-ons on all core role machines where you run Moogfarmd and on the machines where you run the UI. See Server Roles.

  • Verify you have the connection information and credentials to login to the Moogsoft AIOps database server to set up the Enrichment API Integration. By default, the integration uses the same database cluster as Moogsoft AIOps, but you can specify another database.

  • Optionally, if you want to use the node.js-based Enrichment API utilities, install node.js 12.6.x or later. See the node.js docs for more information.


    You can run the node.js-based Enrichment API utilities on any machine with node.js version 12.6.x or later and with with HTTPS access to Moogsoft AIOps.

  • Download the latest add-ons bundle and transfer it to the machines where you are performing the update.

  • Verify the credentials for the operating system user that runs Moogfarmd or the UI and perform all steps as that same user.

Download Moogsoft Add-ons

Install add-ons

To install add-ons, you add them to machines running Moogfarmd and the UI components. This procedure replaces existing components.

  1. Create a backup of the moobots, integrations, and other add-on files on the instance. For example:

    tar -czf $MOOGSOFT_HOME/addons_backup.tar.gz -C $MOOGSOFT_HOME \
    bots/moobots \
    config \
    contrib \
  2. Make a copy of SimilarSigConfig.conf:

    cp $MOOGSOFT_HOME/config/SimilarSigConfig.conf $MOOGSOFT_HOME
  3. Extract the add-ons to $MOOGSOFT_HOME:

    tar -xzhf Moogsoft-Addons- -C $MOOGSOFT_HOME
  4. Move SimilarSigConfig.conf back into place:

    mv $MOOGSOFT_HOME/SimilarSigConfig.conf $MOOGSOFT_HOME/config
  5. On core role machines, restart Moogfarmd:

    service moogfarmd restart

    You do not need to restart Nginx or Apache Tomcat on UI machines.

Extract the Enrichment API utilities and create the Enrichment API data store

The add-ons includes the Enrichment API Integration that lets you store enrichment data in a database for use with the Enrichment Workflow Engine. Before you can use the integration, create the data store from one machine with access to the database as follows:

  1. Extract the utilities. For example:

    unzip -x $MOOGSOFT_HOME/contrib/ -d $MOOGSOFT_HOME/contrib/
  2. Run the script to create the database and the enrichment user:

    $MOOGSOFT_HOME/contrib/moog_enrichment_utils/bin/ \
    -u <database root user> \
    -p <optional database root user password> \
    -d <database host>:<database port> \
    -e <enrichment user password>

    For example to initialize the moog_enrichment database on a database host named my_database_host with an enrichment user password of 'password123':

    $MOOGSOFT_HOME/contrib/moog_enrichment_utils/bin/ \
    -u root \
    -d my_database_host:3306 \
    -e password123

    In this case, when prompted for the password, enter the root database user password.

In addition to the database script, the Add-ons include the following utilities to help you load and test enrichment data:

  • moog_send_event is a node.js script that sends test events to the Enrichment API after you set up the integration. For usage information run: ./moog_send_event -h .

  • moog_enrichment_util is a node.js script that loads data into the Enrichment API after you set up the integration. You can supply enrchment data in JSON, CSV, or TSV format. For usage information, run ./moog_enrichment_util -h.

  • is a Bash version of the data loader. It is slower than the node.js scripts, but works on systems where you can't install node.js. For usage information, run ./ -h.

After you have installed the latest add-ons and created the data store for the Enrichment API, you can install the Enrichment API Integration.