Space banner

   

This documentation supports an earlier version of BMC Helix IT Operations Management on-premises deployment.

To view the documentation for the latest version, select 22.4 from the Product version picker.

Configuration file settings

Use the following configuration files to determine the applications and settings that you want to deploy:

  • infra.config
  • deployment.config

For details about the configuration file settings for each component, see the following topics:

The following sections describe the configuration file parameters in detail.

Important

Based on the DEPLOYMENT_ENVIRONMENT value that you have set in configs/deployment.config file, you must update the PG_REPLICA_COUNT and PG_POOL_REPLICA_COUNT variables in the respective configuration file.

For example:

In the configs/deployment.config file, if you have set the value of DEPLOYMENT_ENVIRONMENT to small, then in the configs/small.config file, you must update the following variables:

  • PG_REPLICA_COUNT - Set it to an odd number; for example 3 or 5.
  • PG_POOL_REPLICA_COUNT - Set it to an odd number; for example 2 or 3. 

If you have already set the Postgres replica count to 2 (or an even number), then reach out to BMC support to increase the Postgres replica count to an odd number.


The infra.config file parameters

Refer to the following table for details about the infra.config file:

SettingDescription
IMAGE_REGISTRY_HOST

Host where the Docker registry is running with the BMC container images, and where the nodes on the cluster will download the images.

If you have synchronized the images to a local Harbor registry, make sure the Harbor registry is set up with HTTPS.

Value:

containers.bmc.com (or local repo if copied down)

IMAGE_REGISTRY_USERNAME

User name to log in to BMC DTR.

If you use a local Harbor registry to synchronize with BMC DTR, specify the user name to log in to your local registry.

NAMESPACE

A valid Kubernetes namespace to deploy BMC Helix IT Operations Management.

LB_HOST

A valid URL host for the load balancer

The BMC Helix Single Sign-on ingress uses this URL to access the BMC Helix Single Sign-on administration console. 

If the value of the CUSTOM_CA_SIGNED_CERT_IN_USE parameter is true, use the DNS that is configured for self-signed certificate.

If the value of the CUSTOM_CA_SIGNED_CERT_IN_USE parameter is false, use the DNS that is configured for the CA signed certificate.

Example:

  • The value of the CUSTOM_CA_SIGNED_CERT_IN_USE parameter is true: lb.cluster3.ame.com (This DNS is configured for the self-signed certificate).
  • The value of the CUSTOM_CA_SIGNED_CERT_IN_USE parameter is false: acme-api.acme.com (This DNS is configured for the CA-signed certificate).
LB_PORT

Port for load balancer

Default value: 443

TMS_LB_HOST

A valid URL host for tenant management system

The tenant management system ingress uses this URL.

If the value of the CUSTOM_CA_SIGNED_CERT_IN_USE parameter is true, use the DNS that is configured for self-signed certificate.

If the value of the CUSTOM_CA_SIGNED_CERT_IN_USE parameter is false, use the DNS that is configured for the CA signed certificate.

Example:

DOMAIN

Domain name of the site where the system is being set up. A valid base URL for tenants to be created from. Needs wildcard cert.

MINIO_LB_HOST

A valid URL for the MinIO storage

The MinIO ingress uses this URL.

If the value of the CUSTOM_CA_SIGNED_CERT_IN_USE parameter is true, use the DNS that is configured for self-signed certificate.

If the value of the CUSTOM_CA_SIGNED_CERT_IN_USE parameter is false, use the DNS that is configured for the CA signed certificate.

Example:

ENVIRONMENT

Type of the environment.

Valid values:

  • compact
  • small
  • medium
  • large
CLUSTER_TYPE

""

The cluster type can be OpenShift or Kubernetes.

If the cluster type is Openshift, the value of this variable is ocp.

If this parameter is blank, the Kubernetes is treated as the cluster type. 

COMPANY_NAME

Name for the tenant. 

This will be used in the tenant URL formation$COMPANY_NAME-private-$ENVIRONMENT.$DOMAIN

Important: Use only lowercase letters to specify the name of the tenant.

TENANT_EMAILEmail address of the admin user of initial tenant
TENANT_FIRST_NAMEFirst name of the admin user for initial tenant
TENANT_LAST_NAMELast name of the admin user for initial tenant
TENANT_TYPE

The tenant type. 

Valid values:

public or private

The value must be in the lower case. This will be used in the tenant URL and BMC Discovery appliance URL formation.

For BMC Helix Operations Management :
$COMPANY_NAME-disc-$TENANT_TYPE-$ENVIRONMENT.$DOMAIN  $COMPANY_NAME-$TENANT_TYPE-$ENVIRONMENT.$DOMAIN
Example:
acme-private-small.acme.com

TENANT_DOMAIN_HOST

The tenant domain. This is the URL of BMC Helix Portal.

This is a required parameter.

This parameter must be in the following format:

$TENANT_NAME-$TENANT_TYPE-$ENVIRONMENT$.TENANT_DOMAIN_HOST

Example:

acme-private-small.acme.com 

where acme.com is the TENANT_DOMAIN_HOST.


Important

Only small case letters, digits, and hyphen are valid values.

COUNTRY

Country of deployment

The country name must match the value in the operation system locale.

Important

  • Add the country name within double quotes. For example:

    "India"

  • Do not use abbreviations in country names.

    Click here to view a list of the supported country names.

NFS_MOUNT_PATH

/ade-onprem/monitor 

Configure the NFS mount point and Server. Do not specify the root mount path for this value. Create the sub-folder in the mount path. For example, ensure that the folder /ade-onprem/monitor is already created.

If you are using the default NFS storage class value, keep the NFS_MOUNT_PATH value empty:

NFS_MOUNT_PATH=""

NFS_SERVER

The host name where the NFS server is configured. 

Value can be the NFS server host name or the IP address that is accessible from the cluster.

If you are using the default NFS storage class value, keep the NFS_SERVER value empty:

NFS_SERVER =""

NFS_STORAGE_CLASS

onprem-nfs-storage

The KM Repo needs the static NFS storage class.

Leave blank if the default storage class is to be used:

NFS_STORAGE_CLASS=""

SMTP_HOSTA valid URL host of the SMTP server
All SMTP mail servers are supported.
SMTP_PORTAn integer value for the port of the SMTP server.
SMTP_USERNAME

User name to connect to the SMTP server.

If SMTP_AUTH value is set to NONE, keep the SMTP_USERNAME and SMTP_PASSWORD values blank as shown below:

  • SMTP_USERNAME=""
  • SMTP_PASSWORD=""

This parameter is required.

SMTP_FROM_EMAIL

A valid email ID for the From address in all emails

This parameter is required.

SMTP_TLS

The SMTP server TLS. Valid values are:

  • true
  • false

If not in use, leave the parameter blank as shown below:

SMTP_TLS=""

SMTP_AUTH_DASHBOARD

The value can be true or false.

SMTP_AUTH

Use one of the following values:

  • PLAIN
    This value is case sensitive. If you set the value as PLAIN, it is mandatory to set valid values for SMTP_USER and SMTP_PASSWORD.
  • LOGIN
    This value is case sensitive. If you set the value as LOGIN, it is mandatory to set valid values for SMTP_USER and SMTP_PASSWORD.
  • NONE
    This value is case sensitive. Use this value when you want to skip SMTP authentication. If you set the value as NONE, set the user name and password values as shown below:
    • SMTP_USERNAME=""
    • SMTP_PASSWORD=""
OPS_GROUP_EMAIL

Ops email address.

All emails related to tenant activities such as tenant creation, tenant registration, and tenant offboarding are sent to your organization's operations team.

APPROVAL_GROUP_EMAIL

Email address for approval.

When a new tenant is created, an email is sent for tenant approval to this email group.

PG_STORAGE_CLASS

Storage class for Postgres.

Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example acme-block-storage

VMSTORAGE_STORAGE_CLASS

Storage class for VictoriaMetrics.

Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example, acme-block-storage

VMAGGSTORAGE_STORAGE_CLASSnfs-storage/ceph-rbd-sc
ES_MASTER_STORAGE_CLASS

Storage class for Elasticsearch master nodes

Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example acme-block-storage

ES_DATA_STORAGE_CLASS

Storage class for Elasticsearch data nodes

Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example acme-block-storage

MINIO_STORAGE_CLASS

Storage class for MinIO

Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example acme-block-storage

EFS_STORAGE_CLASS

Storage class for EFS.

SmartGraph uses the dynamic NFS mount storage class.

REDIS_HA_GLOBAL_STORAGECLASS

Storage class for REDIS
Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example acme-block-storage

KAFKA_STORAGECLASS

Storage class for Kafka

Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example acme-block-storage

ESLOG_MASTER_STORAGE_CLASS

Storage class for Elasticsearch log

Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example acme-block-storage

ESLOG_DATA_STORAGE_CLASS

Storage class for Elasticsearch log

Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example acme-block-storage

AIOPS_STORAGE_CLASS

Storage class for BMC Helix AIOps

Usually, a single storage class by using block storage is configured for all the infra services. Repeat the same value if configured in this manner.

For example acme-block-storage

CUSTOM_CA_SIGNED_CERT_IN_USE

The default value is false.

If you are using a self-signed or custom CA certificate, set the value to true.

For instructions on using a self-signed or custom CA certificates, see Using self-signed or custom CA certificates

For information about adding a self-signed or custom CA certificate in BMC Discovery, see Integrating with BMC Helix Single Sign-On Open link .

CLIENT_ROOT_CERT

If the MONITOR parameter in the deployment.config file is set to yes, the value for CLIENT_ROOT_CERT is required.

The value should be the immediate signer certificate of the load balancer.

Download the certificate from your browser.

Perform the following steps:

  1. Download the immediate signer certificate from the browser.
    The steps to download the certificate change according to the browser. For more information, see the documentation for your browser.
  2. Remove the BEGIN CERTIFICATE and END CERTIFICATE lines in the certificate. To do this, run the following command:

    $ grep -v CERT </path/to/downloaded/certificate/file> | tr -d '\n'


  3. Ensure that the remaining content in the certificate is in a single line.
  4. Set this single line as a value for the CLIENT_ROOT_CERT variable.

SMART_SYSTEM_USERNAME

User name to connect to the BMC Discovery appliance
INGRESS_CLASS

The ingress class to be used.

Value: nginx

Important: The default value is nginx. Change this value only if you selected a different ingress class when performing the ingress controller deployment.

HELM_BIN

The absolute path of the Helm binary

Value:

/usr/local/bin/helm

Use the following command to get the location of this file:

which helm

KUBECTL_BIN

The absolute path of the kubectl binary

Value:

/usr/bin/kubectl

Use the following command to get the location of this file:

which kubectl

OC_BIN

The absolute path of the OpenShift binary

Value:

/usr/local/sbin/oc

OPT_STORAGE_CLASS

The storage class for BMC Helix Continuous Optimization

BMC Helix Continuous Optimization uses the NFS mount storage class only.

For example, acme-opt-storage

REPOPV_MOUNT_PATH

The Linux-based path to mount for the BMC Helix Continuous Optimization repository.

Configure the NFS mount point for this repository. Do not specify the root mount path for this value. Create the sub-folder in the mount path and change the owner to 1001:87654321.

For example, chown -R 1001:87654321 /data/ade-stack/export/repository.

Note: This setting is required only while upgrading to BMC Helix Continuous Optimization. When deploying the product, provide an empty string as this setting is not required. 

MIGRATORPV_MOUNT_PATH

The Linux-based path to mount for the BMC Helix Continuous Optimization migrator repository.

Configure the NFS mount point for this repository. Do not specify the root mount path for this value. Create the sub-folder in the mount path and change the owner to 1001:87654321.

For example, chown -R 1001:87654321  /data/ade-stack/export/migratorrepository.

Note: This setting is required only while upgrading to BMC Helix Continuous Optimization. When deploying the product, provide an empty string as this setting is not required. 

ETLPV_MOUNT_PATH

The Linux-based path to mount for the BMC Helix Continuous Optimization  ETL repository.

Configure the NFS mount point for this repository. Do not specify the root mount path for this value. Create the sub-folder in the mount path and change the owner to 1001:87654321.

For example, chown -R 1001:87654321  /data/ade-stack/export/etlrepository.

Note: This setting is required only while upgrading to BMC Helix Continuous Optimization. When deploying the product, provide an empty string as this setting is not required. 

LOGIN_ID

If the value of the ITSMINSIGHT_SERVICES parameter in the deployment.config file is set to no, the default login ID is admin.

If the value of the ITSMINSIGHT_SERVICES parameter in the deployment.config file is set to yes, the default login ID is hannah_admin.

INGRESS_API_VERSION
  • Kubernetes:
    • For version 1.21 or later, set this value to true.
    • For versions earlier than 1.21, set this value to false. 
  • OpenShift:
    • For version 4.8 or later, set this value to true.
    • For versions earlier than 4.8, set this value to false.


The deployment.config file parameters

Refer to the following table for details about the deployment.config file:

PropertyDefault value

IMAGE_REGISTRY_PROJECT

bmc

Organization within the Docker registry where the container image repositories are located.

For example, if the image name is containers.bmc.com/bmc/, the IMAGE_REGISTRY_PROJECT name is bmc.

DEPLOYMENT_ENVIRONMENT

small

IMAGE_REGISTRY_ORG

lp0lz

CORE_IMAGE_REGISTRY_ORG

lp0lz

IA_IMAGE_REGISTRY_ORG

lp0oz

OPTIMIZE_IMAGE_REGISTRY_ORG

lp0pz

BHOM_IMAGE_REGISTRY_ORG

lp0mz

AIOPS_IMAGE_REGISTRY_ORG

la0cz

INSTALL_MODE

fresh

Valid values: fresh or upgrade

INFRA

yes

Flag to determine whether to deploy all of the infra.

Valid values: yes or no

_POSTGRES

yes

Flag to determine whether to deploy PostgreSQL.

Valid values: yes or no

_KAFKA

yes

Flag to determine whether to deploy Kafka.

Valid values: yes or no

_REDIS

yes

Flag to determine whether to deploy Redis.

Valid values: yes or no

_RSSO

yes

Flag to determine whether to deploy RSSO.

Valid values: yes or no

_VICTORIAMETRICS

yes

Flag to determine whether to deploy VictoriaMetrics.

Valid values: yes or no

_ELASTICSEARCH

yes

Flag to determine whether to deploy Elasticsearch.

Valid values: yes or no

_MINIO

yes

Flag to determine whether to deploy MinIO.

Valid values: yes or no

HELIX_DASHBOARD_SERVICES

yes

Flag to determine whether to deploy BMC Helix Dashboards.

Valid values: yes or no

ITSMINSIGHT_SERVICES

no

Flag to determine whether to deploy BMC Helix IT Service Management.

Valid values: yes or no

AIOPS_SERVICES

no

Flag to determine whether to deploy BMC Helix AIOps.

Valid values: yes or no

MONITOR

no

Flag to determine whether to deploy BMC Helix Operations Management.

Valid values: yes or no

INTELLI_INT_SERVICES

no

Set the INTELLI_INT_SERVICES flag to yes if you want to install BMC Helix Developer Tools.

Important:

If you want to install the on-premises version of BMC Helix Intelligent Integrations, you must install the BMC Helix Intelligent Integrations gateway.
For more information, see Deploying the BMC Helix Intelligent Integrations Gateway Open link in the BMC Helix Intelligent Integrations documentation.

INTELLIGENT_AUTOMATION

no

Flag to determine whether to deploy BMC Helix Intelligent Automation.

Valid values: yes or no

BMC_HELIX_LOGGING

no

Flag to determine whether to deploy BMC Helix Platform Logging.

Valid values: yes or no

OPTIMIZE

no

Flag to determine whether to deploy BMC Helix Continuous Optimization.

Valid values: yes or no

Was this page helpful? Yes No Submitting... Thank you

Comments

  1. John O'Toole

    Important note about INTELLI_INT_SERVICES

    In 22.2.01, setting the INTELLI_INT_SERVICES flag to yes will actually result in "BMC Helix Developer Tools" being installed.

    If the On-Prem version of BMC Helix Intelligent Integrations is required, the On Prem Helix Intelligent Integrations Gateway should be installed:

    https://docs.bmc.com/docs/helixintelligentintegrations/224/deploying-the-bmc-helix-intelligent-integrations-gateway-1137738594.html

    Jan 19, 2023 03:18
  2. John O'Toole

    This seems to be a typo: It looks like double qoutes but is now. It is two singles and a double. Should be two doubles.

    If you are using the default NFS storage class value, keep the NFS_MOUNT_PATH value empty:

    NFS_MOUNT_PATH=''"

    Jan 30, 2023 10:21