Workflow Insights System Requirements

Before you install Control-M Workflow Insights, verify that your hosts meet the following requirements for your operating system:

  • You must install all instances of Workflow Insights on hosts with the same operating system type (Windows or Linux). Mixed operating systems might cause Workflow Insights to fail or corrupt its data.

  • Control-M Full Installation in a High Availability environment does not support Workflow Insights.

  • Workflow Insights does not support AIX hosts.

Control-M Workflow Insights System Requirements on Windows

The following table lists the prerequisites for Control-M Workflow Insights on Windows.

Resource

Amount

Notes

Control-M/EM Distributed Servers

2 servers

Recommended number of servers.

The Control-M/EM Distributed Servers must be dedicated.

Memory

18 GB

(Control-M/EM Distributed only) 9 GB dedicated to OpenSearch.

CPU

4 cores

(Control-M/EM Distributed only)

Disk Space

1 TB

(Control-M/EM Distributed only) Dedicated to OpenSearch data retention.

Workflow Insights Ports

 

If your network cannot open these ports, set alternative ports during the activation of Control-M Workflow Insights.

Control-M Self Service Installation

 

Relevant for Control-M/EM Primary only.

Paging Parameters

 

 

Enable the following parameters:

  • Automatically manage paging file size for all drives.

  • No paging file.

Control-M Workflow Insights System Requirements on Linux

The following table lists the prerequisites for Control-M Workflow Insights on Linux.

Resource

Amount

Notes

Control-M/EM Distributed Servers

2 servers

Recommended number of servers.

The Control-M/EM Distributed Servers must be dedicated.

Memory

16 GB

(Control-M/EM Distributed only) 6–8 GB dedicated to OpenSearch.

CPU

4 cores

(Control-M/EM Distributed only)

Disk Space

1 TB

(Control-M/EM Distributed only) Dedicated to OpenSearch data retention.

Operating System

 

If your network cannot open these ports, set alternative ports during the activation of Control-M Workflow Insights.

Control-M Self Service Installation

Product Availability and Compatibility

BMC recommends that you use the same Linux operating system for both the primary Control-M/EM and the Control-M/EM Distributed instances.

Linux Kernel Parameters

 

 

 

Workflow Insights Ports

 

If your network cannot open these ports, set alternative ports during the activation of Control-M Workflow Insights.

Control-M Self Service Installation

 

Relevant for Control-M/EM Primary only.

Linux Kernel Parameters

The following table describes the Linux kernel parameter values that you must define on Linux-based hosts where Workflow Insights is installed.

The kernel parameters must be defined on all hosts in the Workflow Insights environment, including the Control-M/EM Primary and Control-M/EM Distributed hosts.

Parameter

Description

Relevant Instance

Minimum Value

vm.max_map_count

Determines the maximum number of memory map areas that a process can contain.

Control-M/EM Primary and Distributed

262,144

soft nofile

Determines the number of files that a process can simultaneously open. This soft limit cannot exceed the hard limit.

Control-M/EM Primary and Distributed

65,535

hard nofile

Determines the number of files that a process can simultaneously open. This hard limit cannot be exceeded.

Control-M/EM Primary and Distributed

65,535

memlock

Determines the maximum locked-in-memory address space (KB). This is memory that is not paged out.

Control-M/EM Distributed only

Unlimited

soft nproc

Determines the maximum number of permitted threads per user. This soft limit cannot exceed the hard limit.

Control-M/EM Primary and Distributed

4,096

hard nproc

Determines the maximum number of permitted threads per user. This hard limit cannot be exceeded.

Control-M/EM Primary and Distributed

4,096

Verify Linux Kernel Parameter Settings

This procedure describes how to verify Linux kernel parameter settings before installing Control-M Workflow Insights.

Begin

  1. Run the following command to verify the value of the vm.max_map_count parameter:

    sysctl -q vm.max_map_count

    The following return value appears: 262144.

  2. Do the following to increase the value of the vm.max_map_count parameter:

    1. Log in as root.

    2. In the /etc/sysctl.conf file, set vm.max_map_count to 262144.

    3. Run the following command to apply the new value:

      sysctl -p

      The following vm.max_map_count return value appears: 262144.

  3. Do one of the following in one of these command shells to verify the value of the soft nofile, hard nofile, memlock, soft nproc, and hard nproc parameters:

    • tcsh:

      1. Run the following command:

        limit | grep descriptors

        The following return value appears: 65536.

      2. Run the following command:

        sh -c ulimit -|

        The following return value appears: unlimited.

      3. Run the following command:

        ulimit -u

        The return value appears and exceeds the following number: 4096.

    • bash:

      1. Run ulimit - a |grep files

        The following return value appears: 65536.

      2. Run ulimit -|

        The following return value appears: unlimited.

      3. Run the following command:

        ulimit -u

        The return value appears and must exceed the following number: 4096.

  4. Do the following to increase the value of the soft nofile, hard nofile, memlock, soft nproc, and hard nproc parameters:

    1. Log in as root.

    2. Open the /etc/security/limits.conf file.

    3. Add or edit the following lines:

      • Soft nofile 65536

      • Hard nofile 65536

      • Soft memlock unlimited

      • hard memlock unlimited

  5. Restart the host.

  6. Do the following to verify that the configuration is updated:

    1. Run the following command:

      sysctl -q vm.max_map_count

      The following return value appears: 262144.

    2. Do one of the following from one of these command shells

      • tcsh: Run the following command:

        limit | grep descriptors

        The following return value appears: 65536.

      • bash: Run the following command:

        ulimit -a | grep files

        The following return value appears: 65536.

    3. Do one of the following from one of these command shells

      • tcsh: Run the following command:

        sh -c ulimit -|

        The following return value appears: unlimited.

      • bash: Run the following command:

        ulimit -|

        The following return value appears: unlimited.

Workflow Insights Ports

The following table describes the default Workflow Insights ports on Windows and Linux.

The ports must be open for all hosts in the Workflow Insights environment, including Control-M/EM Primary and Control-M/EM Distributed Servers.

If you cannot open any of these ports, you must define custom ports in the designated screen of the Workflow Insights installation. The Workflow Insights installation is described in Installing Workflow Insights on Windows or Installing Workflow Insights on Linux.

Port Name

Port Value

Component Installation

Description

Control-M/EM Web Server

8443

Control-M/EM Primary

Defines the Control-M/EM Web Server port, which grants access to a number of applications, as described in Control-M/EM Servers.

KAFKA_PORT

50100–50300

Control-M/EM Primary

Defines the Kafka server port, which enables Workflow Insights.

OpenSearch_HTTP_Port

19200

Control-M/EM Distributed First Workflow Insights Activation

Defines the OpenSearch HTTP port, which enables communication between the OpenSearch client and server, based on the HTTP and HTTPS protocol.

OpenSearch_Transport_Port

19300

Control-M/EM Distributed First Workflow Insights Activation

Defines the OpenSearch Transport port, which enables communication between the OpenSearch hosts.

OpenSearch_Dashboards_Port

15061

Control-M/EM Distributed First Workflow Insights Activation

Defines the OpenSearch Dashboards port, which enables communication between Control-M Web and OpenSearch Dashboards, based on the HTTP and HTTPS protocols.

WORKFLOW INSIGHT Service API PORT

DYNAMIC

Post-installation Step

Defines the Control-M Web API port that enables API requests.

Checking Workflow Insights Ports

This procedure describes how to check which ports are assigned to Workflow Insights.

Begin

Execute one of the following commands:

  • Kafka and Zookeeper:

    • Linux: em -no_wrap cha -get_kafka_info -json

    • Windows: emcha -get_kafka_info -json

  • OpenSearch and OpenSearch Dashboards:

    • Linux: em -no_wrap cha -get_elastic_info

    • Windows: emcha -get_elastic_info

  • Workflow Insights Service API Port: Do the following:

    1. Open the following file:

      • Linux: <Control-M/EM_HOME>/services/config/workflow-insights-service-application.yml

      • Windows: <Control-M/EM_HOME>\services\config\workflow-insights-service-application.yml

    2. Check the value of the Port property.

Changing the Kafka Broker Port

This procedure describes how to change the Kafka broker port after you install Workflow Insights. A Kafka broker is a server that runs Apache Kafka and handles messages, and a Kafka broker port is the TCP network port that applications and other Kafka servers use to connect to an Apache Kafka broker.

You must perform this procedure on the Control-M/EM host where the Kafka service is installed.

This procedure only changes the Kafka broker port. It does not change the Zookeeper (KRaft controller) port.

  1. Log in to the Control-M/EM host where Workflow Insights is installed.

  2. Do the following to identify the host where the Kafka service is installed:

    1. Run the following command:

      • Linux: em services-cli -st

      • Windows: services-cli -st

      Each connected host is listed with its hostname, corresponding services, and service instance names.

    2. Record the Control-M/EM hostname where the Kafka service appears.

  3. Log in to the Control-M/EM host where the Kafka service is installed.

  4. Run the following command:

    • Linux: em em-kafka-cli set-port <Port_Number>

    • Windows: em-kafka-cli set-port <Port_Number>

    where the <Port_Number> option argument defines the Kafka broker port number, which is any available port from 1024 to 65535.

    After you run this command, Control-M performs the following actions:

    • Updates the kafka_port to the defined port number in the Workflow Insights configuration.

    • Updates the broker port in the listeners and advertised.listeners properties in the following service file: 

      • Linux: <Control-M/EM_Home>/kafka/kafka/config/bmc.server.properties

      • Windows: <Control-M/EM_Home>\kafka\kafka\config\bmc.server.properties

    • Updates the kafka.bootstrap.servers property in the following service file:

      • Linux: <Control-M/EM_Home>/etc/services/config/services.yml

      • Windows: <Control-M/EM_Home>\Default\services\config\services.yml

    • Restarts Control-M/EM microservices on the Control-M/EM host where the Kafka service is installed.

    The Control-M/EM microservices take a few minutes to recycle.

  5. (Optional) Run the following command to verify that the Control-M/EM microservices are up:

    • Linux: em services-cli -st

    • Windows: services-cli -st

  6. (Optional) Do the following to verify that the Kafka broker port was changed successfully:

    1. Run the following command to review the current Kafka configuration:

      • Linux: em em-kafka-cli info

      • Windows: em-kafka-cli info

      The following information appears:

      • Kafka configuration details in Control-M/EM

      • The local services.yml file contents

      • The local bmc.server.properties file contents

    2. From the Kafka configuration details in Control-M/EM, which begins with the header === KAFKA INFO ===, verify that the kafka_port number has changed to the number that you defined on every host.

      • If the previous port is still listed on one or more hosts, run the following commands to recycle the Kafka service on those hosts:

        • Linux: 

          • em emsca set-desired-state down -s apache-kafka

          • em emsca set-desired-state up -s apache-kafka

        • Windows:

          • emsca set-desired-state down -s apache-kafka

          • emsca set-desired-state up -s apache-kafka

      • The log is saved to the following directory:

        • Linux: <Control-M/EM_Home>/log/services/workflow_insights/kafka_cli

        • Windows: <Control-M/EM_Home>\log\services\workflow_insights\kafka_cli

Changing OpenSearch and OpenSearch Dashboards Ports

This procedure describes how to change the OpenSearch and OpenSearch Dashboards ports after you install Workflow Insights. You must perform this procedure on every Control-M/EM distributed host where Workflow Insights is installed.

Begin

  1. From the command line, run one of the following commands:

    • OpenSearch_HTTP_Port:

      • Linux: em em-wi-config-cli change_ports --OpenSearch_HTTP_Port <Port_Number>

      • Windows: em-wi-config-cli change_ports --OpenSearch_HTTP_Port <Port_Number>

    • OpenSearch_Transport_Port: 

      • Linux: em em-wi-config-cli change_ports --OpenSearch_Transport_Port <Port_Number>

      • Windows: em-wi-config-cli change_ports --OpenSearch_Transport_Port <Port_Number>

    • OpenSearch_Dashboards_Port: 

      • Linux: em em-wi-config-cli change_ports --OpenSearch_Dashboards_Port <Port_Number>

      • Windows: em-wi-config-cli change_ports --OpenSearch_Dashboards_Port <Port_Number>

    where the <Port_Number> option argument defines the new port number.

  2. Run the following commands to restart OpenSearch:

    • Linux:

      • em emsca set-desired-state down -s opensearch

      • em emsca set-desired-state up -s opensearch

    • Windows:

      • emsca set-desired-state down -s opensearch

      • emsca set-desired-state up -s opensearch

  3. Run the following commands to restart OpenSearch Dashboards:

    • Linux:

      • em emsca set-desired-state down -s opensearch-dashboards

      • em emsca set-desired-state up -s opensearch-dashboards

    • Windows:

      • emsca set-desired-state down -s opensearch-dashboards

      • emsca set-desired-state up -s opensearch-dashboards

Changing the Service API Port

This procedure describes how to change the Workflow Insights Service API Port after you install Workflow Insights. You must perform this procedure on every Control-M/EM Distributed host where Workflow Insights is installed.

Begin

  1. Open the following file in a text editor:

    • Linux: <Control-M/EM_HOME>/services/config/workflow-insights-service-application.yml

    • Windows: <Control-M/EM_HOME>\services\config\workflow-insights-service-application.yml

  2. Locate the following code block and define the port and portspanClosed A whole number that defines how many ports are reserved for a service or application, that begins with the defined primary port, and determines the successive ports to try on bind failure. For example, a primary port of 12493 with a portspan of 3 reserves ports 12493–12495., as required:

    Copy 
    com:
      bmc:
        services:
          map:
            eviction:
              interval: 600
          workflow-insights-service:
            server:
               rest:
                port: <Workflow_Insights_Service_Primary_Port_Number>
                portspan: 0
                hostname: "*"

  3. Save and close the file.

  4. Restart the Workflow Insights service.