Control-M Workflow Insights Installation

Control-M Workflow Insights installation requires multiple component installations and configurations across several computers. Due to the large number of metrics that Workflow Insights gathers and processes, the installation requires more CPU, disk space, different kernel parameters settings, and specific port configurations than a typical Control-M installation. Therefore, it is crucial that you review the architecture and requirements before you install.

The installation includes one Control-M/EM primary host and at least two dedicated Control-M/EM Distributed hosts, to avoid performance impact on the Control-M/EM primary.

Workflow Insights only supports one Control-M/EM distributed node down at any one time. If more than one distributed node is down, Workflow Insights cannot function.

For more information about the Workflow Insights environment, see Control-M Workflow Insights Architecture and Workflow Insights Installation and Configuration video.

After Workflow Insights is installed, the following services are included in the Control-M/EM Distributed computers and appear in the CCM:

Elasticsearch: A third-party search engine based on the Lucene library that is used in Workflow Insights to gather information and perform queries. This service is also included in the Control-M/EM Primary.
Kibana: A third-party data visualization dashboard software for Elasticsearch that is used in Workflow Insights, which displays the collected data in the dashboards.
Workflow Insights: A service that manages and maintains data in Elasticsearch, sends new data to the Elasticsearch, orders backups, and creates and updates indexes.

The demands of the above services require that before Workflow Insights installation you must prepare the hosts used in the installation, as follows:

System Requirements: The Elasticsearch process requires significant memory, CPU, and disk space, which require the Control-M/EM servers to meet certain requirements, as described in Control-M Workflow Insights System Requirements.

System Settings: The Elasticsearch process requires non-default kernel settings for Linux installations and paging settings for Windows installations before installing the Control-M/EM Primary or Control-M/EM Distributed instances, as described in Linux Kernel Parameters and Installing Control-M Workflow Insights on Windows.
Open Ports: The required ports for Elasticsearch, Kafka, Zookeeper, and Kibana must be opened in the firewall for both the Control-M/EM Primary and Control-M/EM Distributed instances, as described in Workflow Insights Ports. If the required ports are not open during installation, you might need to change the ports, as described in Changing Workflow Insights Ports After Installation for Kafka/Zookeper, Changing Workflow Insights Ports After Installation for Elasticsearch and Kibana, and Changing Workflow Insights Ports After Installation for the Workflow Insights Service API Port.
- If you are upgrading the primary to 9.0.21 the additional ports that Kafka requires are automatically defined. You cannot define custom ports during the upgrade.
- If you install the default Workflow Insights installation option, you cannot assume that the default ports are defined. If a port is busy, the installation automatically selects the next available port.
- If your Workflow Insights environment includes a Secondary Control-M/EM host for High Availability, you must open the same ports in the Secondary Control-M/EM host as are open in the Control-M/EM primary host.

Before you install, see Setting Up the Workflow Insights Environment.

Control-M Workflow Insights Architecture

The following diagram shows the Control-M Workflow Insights architecture in a production environment:

The following diagram shows the Control-M Workflow Insights architecture in a non-production environment:

The following diagram shows the Control-M Workflow Insights architecture in a high availability environment without a failover:

The following diagram shows the Control-M Workflow Insights architecture in a high availability environment after a failover:

Setting Up the Workflow Insights Environment

This procedure describes how to set up the Workflow Insights environment.

Before you begin

Verify your Control-M/EM computers meet the requirements, as described in Control-M Workflow Insights System Requirements
Verify your Linux Control-M/EM computers have the Kernel settings, as described in Linux Kernel Parameters
If you first updated the version and then set the Linux kernel parameters, you must restart the Control-M/EM Configuration Agent.
Verify the required ports are open, as described in Workflow Insights Ports.
Verify the Control-M Self Service is installed on the Control-M/EM Primary, as described in Control-M Self Service Installation

Begin

Install or upgrade the Control-M/EM Primary to 9.0.21 or higher, as described in Control-M/Enterprise Manager Installation.
Install at least two dedicated Control-M/EM Distributed instances, as described in Control-M/Enterprise Manager Installation.
install Control-M Workflow Insights on Windows on a Control-M/EM Distributed instance, as described in Installing Control-M Workflow Insights on Windows and Installing Control-M Workflow Insights on Linux.
You must do the installations one at a time.
Define the Workflow Insight backups, as described in Defining Workflow Insights Backups.
Define the Workflow Insights configuration, as described in Configuring Workflow Insights.

After you have installed or upgraded the primary Control-M/EM and installed Workflow Insights on the Control-M Distributed instances, you need to run a script on all these components that removes the Log4j v2 vulnerability, as described in 000391322.

The Workflow Insights Environment is set up.