HTTP server configuration

The HTTP server configuration describes how the probe receive HTTP notifications.

Table 1. Configurable parameters for the HTTP server

Parameter name

Description

license

Use this parameter to specify the license state of the image being deployed. Enter accept to install and use the image.

The default value is not accepted

replicaCount

Use this parameter to specify the number of deployment replicas.

The default value is 1

global.image.secretName

Use this parameter to specify the name of the Secret containing the Docker Config to pull image from a private repository. Leave blank if the probe image already exists in the local image repository or the Service Account has been assigned with an Image Pull Secret.

The default value is nil

image.repository

Use this parameter to specify the probe image repository. Update this repository name to pull from a private image repository. The image name should be set to netcool-probe-messagebus

The default value is netcool-probe-messagebus

image.tag

Use this parameter to specify the netcool-probe-messagebus image tag.

The default value is 9.0.9

image.testRepository

Use this parameter to specify the utility image (busybox) repository. Update this repository name to pull from a private image repository.

The default value is busybox

image.testImagetag

Use this parameter to specify the utility image tag.

The default value is 1.28.4

image.pullPolicy

Use this parameter to specify the image pull policy.

The default value is IfNotPresent

image.tag

Use this parameter to specify the netcool-probe-messagebus image tag.

The default value is 9.0.8

netcool.primaryServer

Use this parameter to specify the primary Netcool/OMNIbus server the probe should connect to (required).

The default value is nil

netcool.primaryHost

Use this parameter to specify the host of the primary Netcool/OMNIbus server (required).

The default value is nil

netcool.primaryPort

Use this parameter to specify the port number of the primary Netcool/OMNIbus server (required).

The default value is nil

netcool.backupServer

Use this parameter to specify the backup Netcool/OMNIbus server to connect to. If the backupServer, backupHost and backupPort parameters are defined in addition to the primaryServer, primaryHost, and primaryPort parameters, the probe will be configured to connect to a virtual object server pair called `AGG_V`.

The default value is nil

netcool.backupHost

Use this parameter to specify the host of the backup Netcool/OMNIbus server.

The default value is nil

netcool.backupPort

Use this parameter to specify the port of the backup Netcool/OMNIbus server.

The default value is nil

probe.messageLevel

Use this parameter to specify the probe log message level.

The default value is warn

probe.heartbeatInterval

Use this parameter to specify the probe heartbeat interval (in seconds) to check the transport connection status.

The default value is 1

probe.rulesConfigmap

Use this parameter to specify an alternative ConfigMap. If set,it overrides the template rules files with this ConfigMap containing a custom rules files in message_bus.rules key. Leave empty to use the default rules file template which can be customized later.

The default value is nil

probe.jsonParserConfig.notification. messagePayload

Use this parameter to specify the JSON tree to be identified as message payload from the notification (webhook) channel. See example for more details on how to configure the Probe's JSON parser.

The default value is json

probe.jsonParserConfig.notification. messageHeader

Use this parameter to specify the JSON tree to be identified as message header from the notification (webhook) channel. Attributes from the headers will be added to the generated event.

The default value is nil

probe.jsonParserConfig.notification. jsonNestedPayload

Use this parameter to specify the JSON tree within a nested JSON or JSON string to be identified as message payload from the notification (webhook) channel. The probe.jsonParserConfig.notification. messagePayload must be set to point to the attribute containing the JSON String.

The default value is nil

probe.jsonParserConfig.notification. jsonNestedHeader

Use this parameter to specify the JSON tree within a nested JSON or JSON string to be identified as message header from the notification (Webhook) channel. The probe.jsonParserConfig.notification. messageHeader must be set to point to the attribute containing the JSON String.

The default value is nil

probe.jsonParserConfig.notification. messageDepth

Use this parameter to specify the number of levels in the message to traverse during parsing.

The default value is 3

service.probe.type

Use this parameter to specify the probe k8 service type exposing ports, for example ClusterIP or NodePort.

The default value is ClusterIP

service.probe.externalPort

Use this parameter to specify the external port for this service.

The default value is 80

ingress.enabled

Use this parameter to specify whether the Ingress is enabled.

The default value is FALSE

ingress.hosts

Use this parameter to specify the Host to route requests based on. The Helm Release Name will be appended as a prefix. Required when using Ingress. Ignored when ingress is disabled and the default value can be used as dummy value to proceed with installation.

The default value is netcool-probe-messagebus-webhook.local

ingress.annotations

Use this parameter to specify the meta data to drive Ingress class used.

The default value is nil

ingress.tls.enabled

Use this parameter to enable or disable TLS to secure channel from external clients / hosts.

The default value is FALSE

ingress.tls.secretName

Use this parameter to specify the TLS secret to secure channel from external clients / hosts. The secret must contain the tls.crt and tls.key entries. If ingress.tls.enabled=true and this parameter is unset, a TLS secret will be created.

The default value is nil

ingress.tls.caName

Use this parameter to specify a Certificate Authority name used to create the CA certificate when signing the TLS certificate. Used when ingress.tls.secretName is unset.

The default value is IBM Netcool/OMNIbus Integration

webhook.httpVersion

Use this parameter to specify the version of the HTTP protocol to use. The probe supports 1.1 or 1.0.

The default value is 1.1

webhook.uri

Use this parameter to specify the probe's Webhook URI into which the target device will POST notifications.

The default value is /probe

webhook.respondWithContent

Use this parameter to specify whether the probe includes the HTTP body received from the client HTTP request in the HTTP response. Set to ON to specify that the probe includes the HTTP body.

The default value is OFF

webhook.validateBodySyntax

Use this parameter to specify the probe performs a JSON format check. Set to ON to perform a JSON format check on the HTTP request body.

The default value is ON

webhook.validateRequestURI

Use this parameter to enable or disable a URI path check.

Set this property to ON to enable URI path check. Set this property to OFF to disable the URI check and the Webhook will accept all HTTP request regardless of the path set.

The default value is ON

webhook.idleTimeout

Use this parameter to specify the time (in seconds) to allow an idle HTTP client to be connected.

The default value is 180

webhook.keepTokens

Use this parameter to specify a comma-separated list of the attributes that the probe extracts from the incoming JSON data. These data items can be used in token substitution

The default value is nil

autoscaling.enabled

Use this parameter to enable or disable auto-scaling.

The default value is TRUE

autoscaling.minReplicas

Use this parameter to specify the minimum number of probe replicas.

The default value is 2

autoscaling.maxReplicas

Use this parameter to specify the maximum number of probe replicas.

The default value is 5

autoscaling.cpuUtil

Use this parameter to specify the target CPU utilization. For example, enter 60 for 60% target utilization.

The default value is 60

poddisruptionbudget.enabled

Use this parameter to specify the enable or disable Pod Disruption Budget to maintain high availability during a node maintenance.

The default value is FALSE

poddisruptionbudget.minAvailable

Use this parameter to specify the minimum number of available pods during node drain. Can be set to a number or percentage, eg: 1 or 10%. Caution: Setting to 100% or equal to the number of replicas may block node drains entirely.

The default value is 1

resources.limits.memory

Use this parameter to specify the memory resource limits.

The default value is 512Mi

resources.limits.cpu

Use this parameter to specify the CPU resource limits.

The default value is 500m

resources.requests.cpu

Use this parameter to specify the CPU resource requests.

The default value is 100m

resources.requests.memory

Use this parameter to specify the memory resource requests.

The default value is 128Mi

arch

Use this parameter to specify the worker node architecture. This is fixed to amd64.