Enable SimpCon Consumer

SimpCon Consumer template

The SimpCon Consumer template helps you consume messages from Data Streaming Services and transform them into the format required by the receiving system.

How the extension works

The extension runs as a container in Kubernetes when you create an extension instance in the Integrated Artificial Intelligence for IT Operations platform.

The extension performs the following actions:

Consumes messages from Data Streaming Services.

Transforms the requests into the format required by the receiving system.

Sends the transformed requests to the configured destination endpoint.

For local testing, ensure that your environment meets the following requirements:

A Unix-compatible terminal

Ubuntu

Docker

Access to the required Data Streaming Services endpoint

Valid credentials for the stream endpoint

Familiarity with the extension codebase

Only developers who are familiar with the codebase should run the extension locally. Incorrect configuration might cause unexpected errors.

Configure the extension

When you create the extension from the Integrated Artificial Intelligence for IT Operations user interface, a red asterisk (*) identifies each required variable. When you run the extension locally, define the following environment variables.

Variable	Default value	Description
DX_ENV_ENVIRONMENT	""	Required. Specifies the Integrated Artificial Intelligence for IT Operations deployment environment. Supported values are DEV and PROD.
DX_EXT_BATCH_FREQUENCY	""	Required. Specifies the sleep interval, in seconds, between status stream checks.
DX_EXT_EXTENSION_NAME	""	Required. Specifies the name of the consumer group.
DX_EXT_SOURCE_GSMA_CUSTOMER_CODES	""	Required. Specifies the three-character account codes configured in the user interface.
DX_EXT_SOURCE_INSTANCE_CODES	""	Required. Specifies the TEC ID configured in the user interface.
DX_EXT_SOURCE_URL	""	Required. Specifies the Netcool destination endpoint URL.
DX_EXT_SOURCE_IP_ADDRESS	""	Required. Specifies the destination IP address.
DX_EXT_SOURCE_USER	""	Required. Specifies the destination endpoint user for basic authentication.
DX_EXT_SOURCE_PW	""	Required. Specifies the destination endpoint password for basic authentication.
DX_ENV_OU_KEY	""	Required. Specifies the organizational unit key used to authenticate with Automation Services.
DX_EXT_SOURCE_CERT	""	Required. Specifies the source SSL certificate when the source uses a self-signed certificate or a nonstandard certificate authority.
DX_EXT_LOG_LEVEL	""	Required. Specifies the log level.

Deploy the extension

Use the Integrated AIOps user interface to configure and deploy the extension to an individual OU or compute zone.

The extension is intended for use only within the Integrated Artificial Intelligence for IT Operations platform.

Run the extension locally

Use the ./run.sh script to run the extension from a Unix-compatible terminal. The script contains sample scenarios and can use mock servers for local unit testing. To run the extension:

Open a Unix-compatible terminal.

Go to the extension repository.

Configure the required environment variables.

Run the following command:

./run.sh

Configure local stream access

The application does not automatically inject the stream URL. Before you run it locally, specify the appropriate Synapps URL, user name, and password.

Create the following file in the repository root: local/*ensitive.sh

Add the following content:

#!/bin/bash -eux # Optional. If not set it will become # https://098a759b1e7c.1.account.dev.delivery.kyndryl.net/streams/automations-status # export STREAM_SOURCE="[[ the stream url ]]" export APP_SYNAPPS_USER=[[the synapps user for the STREAM_SOURCE url]] export APP_SYNAPPS_PW=[[the synapps password for the STREAM_SOURCE url]] # recommended: turning this on will disable the internal Event forwarder and # will make logs a little cleaner. export DISABLE_EVENT_FORWARDER=TRUE

Protect the local/sensitive.sh file because it contains credentials. Do not commit credentials to the source code repository.

Run the test suite

The extension includes a test suite that connects to mock servers. To run the test suite from Ubuntu with Docker:

Open a terminal.

Go to the extension repository.

Run the following command: ./tes*/test.sh

Run the extension with custom options

Use the ./test/run.sh script to run the extension locally with custom options. For example: ./test/run.sh *-prune --interactive

This command performs the following actions:

Removes containers and images with names that begin with isg_netcool_automation_.

Builds an image with a tag that begins with isg_netcool_automation_.

Starts a container with the same prefix.

Selects an available port near port 8943.

Writes the container logs directly to the terminal.

The --interactive option displays log output synchronously in the terminal.

To view all supported options, run: ./test/run.sh --help*

Execution result

The extension ingests incident records from the dedicated ticketing system and publishes them to the automations-status topic.

Pull request requirements

Pull requests that involve production branches require at least two reviews. Reviews from contributors who committed code to the same pull request do not count toward this requirement.