Control-M Workflow Insights System Requirements

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

  • You must run all of your Workflow Insights machines on either Windows or Linux—mixed operating systems might cause the service to fail or corrupt data.

  • You cannot install Workflow Insights on a Control-M full installation or in a High Availability environment.

  • Workflow Insights does not support AIX machines.

Control-M Workflow Insights System Requirements for Windows

The following table lists the prerequisite requirements for all 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

16 GB

6–8 dedicated to ElasticSearch.

(Control-M/EM Distributed Only)

CPU

4 Cores

(Control-M/EM Distributed Only)

Disk Space

1 TB

Dedicated to ElasticSearch data retention.

(Control-M/EM Distributed Only)

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 files size for all drives.

  • No paging file.

Control-M Workflow Insights System Requirements for Linux

The following table lists the prerequisite requirements for all Control-M Workflow Insights Linux platforms.

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

6–8 dedicated to ElasticSearch.

(Control-M/EM Distributed only)

CPU

4 Cores

(Control-M/EM Distributed only)

Diskspace

1 TB

Dedicated to ElasticSearch data retention.

(Control-M/EM Distributed only)

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 OS 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 Control-M Workflow Insights environment machines.

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 computers.

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 Distributed only.

65,535

hard nofile

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

Control-M/EM Distributed only.

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 threads permitted to the user. This soft limit cannot exceed the hard limit.

Control-M/EM Primary and Distributed.

4,096

hard nproc

Determines the maximum number of threads permitted to the 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. Do the following to verify the value of the vm.max_map_count parameter:

    1. Run the following command:

      sysctl-q vm.max_map_count

      The following return value appears: 262144.

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

      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 update the new value:

        sysctl -p

        The following vm.max_map_count return value appears: 262144.

  2. Do one of the following from 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.

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

    1. Log in as root.

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

    3. Add or edit or add the following lines:

      • Soft nofile 65536

      • Hard nofile 65536

      • Soft memlock unlimited

      • hard memlock unlimited

  4. Restart the machine.

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

    1. Run the following command:

      sysctl -q vm.max_map_count

      The return value is equal to 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 ports that are used by Workflow Insights for both 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 Control-M Workflow Insights on Windows or Installing Control-M Workflow Insights on Linux.

Port Name

Default Port

Set During Installation Of

Port Purpose

Control-M/EM Web Server

8443

Control-M/EM Primary

Determines the Control-M/EM Web Server port, which provides access for a number of applications, as described in Control-M/EM Servers.

KAFKA_PORT

19092

Control-M/EM Primary

Determines the Kafka server port used for micro-service communications.

ZOOKEEPER_LE_PORT

3888

Control-M/EM Primary

Determines the Kafka cluster port via which the primary host is chosen.

ZOOKEEPER_FOLLOWERS_PORT

2888

Control-M/EM Primary

Determines the Kafka cluster port via which the Kafka Follower hosts communicate with the Leader host.

ZOOKEEPER_CLIENT_PORT

12181

Control-M/EM Primary

Determines the Kafka port used for Zookeeper communication.

ELASTIC_TRANSPORT_PORT

19200

Control-M/EM Distributed 1st Workflow Insights Activation

Determines the Elastic cluster port used for communication between Elastic client and server based on http/https.

ELASTIC_HTTP_PORT

19300

Control-M/EM Distributed 1st Workflow Insights Activation

Determines the Elastic cluster port used for communication between the OpenSearch hosts.

KIBANA_PORT

15061

Control-M/EM Distributed 1st Workflow Insights Activation

Determines the Control-M WEB and Kibana port used for communication between Kibana client and server, based on http/https.

WORKFLOW INSIGHT Service API PORT

DYNAMIC

Post-installation step

Determines the CONTROL-M WEB API port used for API requests.

Checking Workflow Insights Ports

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

Begin

Execute one of the following commands:

  • Kafka and Zookeeper:

    • Windows: emcha -get_kafka_info -json

    • Linux: em -no_wrap cha -get_kafka_info -json

  • Elasticsearch and Kibana:

    • Windows: emcha -get_elastic_info

    • Linux: em -no_wrap cha -get_elastic_info

  • WORKFLOW INSIGHT Service API PORT: Do the following:

    1. Open the following file:
      <EM_HOME>/services/config/workflow-insights-service-application.yml

    2. Check the value of the Port property.

     

Changing Workflow Insights Ports After Installation for Kafka/Zookeper

This procedure describes how to change Workflow Insights Ports after installation for the following services: Kafka/Zookeeper.

Begin

  1. From any Control-M/EM host where Workflow Insights is installed, run the following script to see the usage:

    em bmcpython ~/ctm_em/services/bin/apache_kafka_config.py change_ports -h

    The usage shows you the exact names that the script uses for each service: Kafka, Elasticsearch, and Kibana.

  2. Run the following scripts on every Control-M/EM primary and every Control-M/EM distributed host where Workflow Insights is installed:
    em bmcpython ~/ctm_em/services/bin/apache_kafka_config.py install --<port_name> <port value>
    em emsca set-desired-state down -s <service>
    em emsca set-desired-state up -s <service>

    Set <service> to apache-zookeeper or apache-kafka.

    The ports are changed.

Changing Workflow Insights Ports After Installation for Elasticsearch and Kibana

This procedure describes how to change Workflow Insights Ports after installation for the following services: Elasticsearch and Kibana.

Begin

  1. From any Control-M/EM host where Workflow Insights is installed, run the relevant script to see the usage:
    em bmcpython ~/ctm_em/services/bin/workflow_insights_config.py change_ports -h

    The usage shows you the exact names that the script uses for each service: Kafka, Elasticsearch, and Kibana.

  2. Run the following scripts on every Control-M/EM primary and every Control-M/EM distributed host where Workflow Insights is installed:
    em bmcpython ~/ctm_em/services/bin/workflow_insights_config.py change_ports -<port_name> <port value>
    em emsca set-desired-state down -s <service>
    em emsca set-desired-state up -s <service>

    Set <service> to elasticsearch, or kibana.

    The ports are changed.

Changing Workflow Insights Ports After Installation for the Workflow Insights Service API Port

This procedure describes how to change Workflow Insights Ports after installation for the Workflow Insights Service API Port.

Begin

  1. From a Control-M/EM distributed host installed with Workflow Insights, open the following file:
    $EM_HOME/services/config/workflow-insights-service-application.yml

  2. In the file, change the port property to the required port number.

  3. Restart the Workflow Insights service.

  4. Repeat the previous steps for each Control-M/EM host where Workflow Insights is installed.

    The ports are changed.