Configuration file settings
infra.config file parameters
Refer to the following table for details about the infra.config file:
Parameter | Description | Example |
---|---|---|
Docker registry details | ||
IMAGE_REGISTRY_HOST
| Specify the host where the Docker registry runs with the BMC container images. | For BMC repository: IMAGE_REGISTRY_HOST=containers.bmc.com. For a local repository: IMAGE_REGISTRY_HOST= value-investing.cluster3.bmc.com. |
IMAGE_REGISTRY_USERNAME | Specify the user name to access the Docker registry. | IMAGE_REGISTRY_USERNAME = symphony.aircooler@summer.hot |
Load balancer details | ||
NAMESPACE | Specify a valid Kubernetes namespace to deploy BMC Helix IT Operations Management. | NAMESPACE=dark-helmet |
LB_HOST | Specify a URL to create the load balancer host. |
|
LB_PORT | Specify the port number that the load balancer listens to for accepting the client request. The default value is 443. | LB_PORT=443 |
TMS_LB_HOST | Specify a URL to create the Tenant Management System (TMS) host.
| TMS_LB_HOST=tms.mydomain.bmc.com.
|
DOMAIN | Specify the domain that will be used to create a valid base URL. This value is used to create a valid base URL for tenants in the specified format: $TENANT_NAME-$TENANT_TYPE-$TENANT_ENVIRONMENT.$DOMAIN | DOMAIN=mydomain.bmc.com For example, purplekite-tyrion-dev.mydomain.bmc.com |
MINIO_LB_HOST | Specify a URL to create a MinIO storage. This value is used by the MinIO Ingress. Important: If you need access to the MinIo console, provide load balancer URL which has a DNS entry, else keep the value of MINIO_LB_HOST as blank MINIO_LB_HOST="". | MINIO_LB_HOST=minio.mydomain.bmc.com.
|
MINIO_API_LB_HOST | Specify a URL to create a MinIO storage. | MINIO_API_LB_HOST=minio-api.mydomain.bmc.com |
TENANT_ENVIRONMENT | Specify the environment type. The value that you specify is used to create the tenant URL in the following format: $TENANT_NAME-$TENANT_TYPE-$TENANT_ENVIRONMENT.$DOMAIN For example, purplekite-tyrion-dev.mydomain.bmc.com Important:
| TENANT_ENVIRONMENT=dev |
Cluster type | ||
CLUSTER_TYPE | Specify the cluster type. Important: If you do not want to set a value for CLUSTER_TYPE, leave it blank as shown: | CLUSTER_TYPE=openshift |
Tenant details | ||
TENANT_NAME | Specify the name of the tenant. The value that you specify is used to create the tenant URL in the following format: For example, purplekite-tyrion-dev.mydomain.bmc.com Important: Use only lowercase letters to specify the name of the tenant. | TENANT_NAME=purplekite |
TENANT_EMAIL | Specify the email address of the admin user of the primary tenant. | TENANT_EMAIL=abc@bmc.com |
TENANT_FIRST_NAME | Specify the first name of the admin user of the primary tenant. | TENANT_FIRST_NAME=Myfirstname |
TENANT_LAST_NAME | Specify the last name of the admin user of the primary tenant. | TENANT_LAST_NAME=Mylastname |
TENANT_TYPE | Specify a value to uniquely identify different groups within a tenant (TENANT_ENVIRONMENT). The value that you specify is used to create the tenant URL in the following format: For example, purplekite-tyrion-dev.mydomain.bmc.com The URL must align with the URL that you created for BMC Discovery. The Discovery URL must be in the following format: For example, disc-purplekite-tyrion-dev.mydomain.bmc.com | TENANT_TYPE=tyrion |
TENANT_COUNTRY | Specify the country where the servers are located or from where you are deploying BMC Helix ITOM. Important: Make sure that the value of TENANT_COUNTRY is enclosed within double quotation marks. | TENANT_COUNTRY="Virgin Islands" |
SMTP details | ||
SMTP_HOST | Specify a valid host name for the SMTP server. | SMTP_HOST=mailhost.bmc.com |
SMTP_PORT | Specify a value for the port of the SMTP server. Important: Specify only integer values. | SMTP_PORT=25 |
SMTP_USERNAME | If the SMTP server does not need authentication, set the value of this parameter to false. | SMTP_AUTH_DASHBOARD=true |
SMTP_FROM_EMAIL | Specify the authorization value for SMTP server. Use one of the following values:
Important: The values that you specify are case-sensitive. | SMTP_AUTH=PLAIN |
SMTP_TLS | Specify a 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: | SMTP_USERNAME=abc@bmc.com |
SMTP_AUTH_DASHBOARD | Specify a valid email ID for the from address in all emails. | SMTP_FROM_EMAIL=helix-activation@bmc.com |
SMTP_AUTH | If your SMTP server is using TLS certificates, set the value of this parameter to true. If SMTP_TLS is set to true, and the SMTP_HOST certificate is signed by a custom The default value is false. | SMTP_TLS=false |
OPS_GROUP_EMAIL | Specify a valid email address for your organization's operations team. | OPS_GROUP_EMAIL=abc@bmc.com |
APPROVAL_GROUP_EMAIL | Set a valid email address of the approval group that would approve a new tenant. Important: Special characters are not allowed in an email address. | APPROVAL_GROUP_EMAIL=abc@bmc.com |
Storage class details | ||
PG_STORAGE_CLASS | Specify a storage class for PostgreSQL. | PG_STORAGE_CLASS=acme-block-storage |
VMSTORAGE_STORAGE_CLASS | Specify a storage class for VictoriaMetrics. Repeat the same value for all infra services. | VMSTORAGE_STORAGE_CLASS=acme-block-storage |
VMAGGSTORAGE_STORAGE_CLASS | Specify a storage class. Repeat the same value for all infra services. | VMAGGSTORAGE_STORAGE_CLASS=acme-block-storage |
ES_MASTER_STORAGE_CLASS | Specify a storage class for Elasticsearch master nodes. Repeat the same value for all infra services. | ES_MASTER_STORAGE_CLASS=acme-block-storage |
ES_DATA_STORAGE_CLASS | Specify a storage class for Elasticsearch data nodes. Repeat the same value for all infra services. | ES_DATA_STORAGE_CLASS=acme-block-storage |
MINIO_STORAGE_CLASS | Specify a storage class for MinIO. Repeat the same value for all infra services. | MINIO_STORAGE_CLASS=acme-block-storage |
EFS_STORAGE_CLASS | Specify a storage class for Amazon Elastic File System (EFS). | EFS_STORAGE_CLASS=acme-nfs-storage |
REDIS_HA_GLOBAL_STORAGECLASS | Specify a storage class for REDIS. Repeat the same value for all infra services. | REDIS_HA_GLOBAL_STORAGECLASS=acme-block-storage |
REDIS_CLUSTER__STORAGE_CLASS | Specify a storage class for REDISCLUSTER. Repeat the same value for all infra services. |
|
KAFKA_STORAGECLASS | Specify a storage class for Kafka. Repeat the same value for all infra services. | KAFKA_STORAGECLASS=acme-block-storage |
AIOPS_STORAGE_CLASS | Specify a storage class for BMC Helix AIOps. Repeat the same value for all infra services. | AIOPS_STORAGE_CLASS=acme-block-storage |
BHAC_STORAGE_CLASS | Specify a storage class for BMC Helix Automation Console. Repeat the same value for all infra services. | BHAC_STORAGE_CLASS=acme-nfs-storage |
Optimize storage details | ||
OPT_STORAGE_CLASS | Specify a ReadWriteMany storage class for BMC Helix Continuous Optimization. | OPT_STORAGE_CLASS=acme-opt-storage |
Self-signed/Custom CA/Public CA | ||
CUSTOM_CA_SIGNED_CERT_IN_USE | If you are using self-signed or custom CA signed certificate, set the value of the parameter CUSTOM_CA_SIGNED_CERT_IN_USE to true . Deployment-repository-service (DRS) requires a CA certificate file (full chain). If you set the value of the parameters CUSTOM_CA_SIGNED_CERT_IN_USE to false and MONITOR to yes (in configs/deployment.config ), you must name the public CA certificate file (full chain) as public_cacert.pem and copy it to the commons/certs directory; that is, commons/certs/public_cacert.pem. Additionally, you must add the self-signed or custom CA signed certificate in trust of each worker node. Important:
The default value is false. | CUSTOM_CA_SIGNED_CERT_IN_USE=false |
Service account details | ||
CUSTOM_SERVICEACCOUNT_NAME | If the user running the installation has permission to create ServiceAccount, Role, and RoleBinding, you must retain the If the user running the installation does not have permission to create ServiceAccount, Role, and RoleBinding, perform the following steps:
| CUSTOM_SERVICEACCOUNT_NAME=helix-onprem-sa |
JAVA keystore | ||
RSSO_CUSTOM_JAVA_KEYSTORE_IN_USE | Use this parameter if you want to integrate BMC Helix Single Sign-on(RSSO) To configure BMC Helix Single Sign-on server as a SAML service provider, To use custom Java keystore for RSSO SAML keystore configuration,
The default value is false. | RSSO_CUSTOM_JAVA_KEYSTORE_IN_USE=false |
Smart graph details | ||
SMART_SYSTEM_USERNAME | Specify a user name to connect to the BMC Discovery. | SMART_SYSTEM_USERNAME=system |
NGINX Controller details | ||
INGRESS_CLASS | Specify the Ingress class to be used while deploying the Ingress controller. The default value is nginx. For BHAC deployment, NGINX Plus is not supported. | INGRESS_CLASS=nginx |
NGINX_CONTROLLER new in 24.3 | Specify the value as NGINX_PLUS if you are using the F5 NGINX Plus Ingress Controller; else, specify the value as NGINX_OPENSOURCE. The default value is NGINX_OPENSOURCE. | NGINX_CONTROLLER=NGINX_OPENSOURCE |
INGRESS_TLS_SECRET_NAME new in 24.3 | If you are using the F5 NGINX Plus Ingress Controller, specify the secret that contains the certificate for SSL. The default value is blank. | INGRESS_TLS_SECRET_NAME=my-tls-secret |
Binary paths on your system | ||
HELM_BIN | Specify the absolute path of the Helm binary that is supported for the current release. | HELM_BIN=/usr/local/bin/helm |
KUBECTL_BIN | Specify the absolute path of the kubectl binary that is supported for the current release. | KUBECTL_BIN=/usr/bin/kubectl |
OC_BIN | Specify the absolute path of the OpenShift binary. Important: OC_BIN path should be set if CLUSTER_TYPE is openshift or ocp. | OC_BIN=/usr/local/sbin/oc |
Security Context details | ||
RUN_AS_USER | Set the security context that the infrastructure components must use to enforce security. Set this parameter only if the value of the CLUSTER_TYPE variable is openshift or ocp. Set the correct context for this variable according to the OpenShift namespace. oc describe namespace <namespace-name> After you run the command, look for the following line in the output: openshift.io/sa.scc.uid-range : 1000670000/10000. Important:The command and output changes for each namespace. | RUN_AS_USER=null |
RUN_AS_GROUP | Set the security context that the infrastructure components must use to enforce security. Set this parameter only if the value of the CLUSTER_TYPE variable is openshift or ocp. Set the correct context for this variable according to the OpenShift namespace. oc describe namespace <namespace-name> After you run the command, look for the following line in the output: openshift.io/sa.scc.uid-range: 1000670000/10000 Important: The command and output changes for each namespace. | RUN_AS_GROUP=null |
FS_GROUP | Set the security context that the infrastructure components must use to enforce security. Set this parameter only if the value of the CLUSTER_TYPE variable is openshift or ocp. Set the correct context for this variable according to the OpenShift namespace. oc describe namespace <namespace-name> After you run the command, look for the following line in the output: openshift.io/sa.scc.uid-range : 1000670000/10000 Important: The command and output changes for each namespace. | FS_GROUP=null |
OPT_FSGROUP | Specify the value for the Optimize File System Group. For BMC Helix Continuous Optimization, if the value of the CLUSTER_TYPE variable is openshift or ocp, If the value of the CLUSTER_TYPE variable is Kubernetes, set the value of this parameter to 1001: The default value is 1001. | OPT_FSGROUP=1001 |
ML_FSGROUP | Specify the value for the File System Group. If the value of CLUSTER_TYPE is openshift or ocp and the value of INSTALL_MODE is fresh, If the value of CLUSTER_TYPE is not openshift or ocp and the value of INSTALL_MODE is not fresh , The default value is 998. | ML_FSGROUP=998 |
ENABLE_PRIORITY_CLASS_SUPPORT | Use this parameter to enable the priority class for data lake and application services. Default value is set to no.
| ENABLE_PRIORITY_CLASS_SUPPORT=yes |
ENABLE_DEDICATED_NODES_FOR_INFRA | Use this parameter to dedicate nodes to infra components. Default value is set to no. FOr more information, see Preparing for deployment. | ENABLE_DEDICATED_NODES_FOR_INFRA=yes |
deployment.config file parameters
Refer to the following table for details about the deployment.config file:
Parameter | Description | Example |
---|---|---|
DEPLOYMENT_SIZE | Specify your deployment size. Possible values are:
Default value is small. To deploy only BMC Helix Automation Console, use the value as bhaccompact. | DEPLOYMENT_SIZE=small |
Docker registry project details | ||
IMAGE_REGISTRY_PROJECT | The name of the organization within the Docker registry (where the container image Construct the URL as shown: Example: | IMAGE_REGISTRY_PROJECT=bmc |
CORE_IMAGE_REGISTRY_ORG | The default value of the external repository. The default value is lp0lz. | CORE_IMAGE_REGISTRY_ORG=lp0lz |
IMAGE_REGISTRY_ORG | The default value of the external (public facing) repository. The default value is lp0lz. | IMAGE_REGISTRY_ORG=lp0lz |
IA_IMAGE_REGISTRY_ORG | The default value of the external (public facing) repository. The default value is lp0oz. | IA_IMAGE_REGISTRY_ORG=lp0oz |
OPTIMIZE_IMAGE_REGISTRY_ORG | The default value of the external (public facing) repository. The default value is lp0pz. | OPTIMIZE_IMAGE_REGISTRY_ORG=lp0pz |
BHOM_IMAGE_REGISTRY_ORG | The default value of the external (public facing) repository. The default value is lp0mz. | BHOM_IMAGE_REGISTRY_ORG=lp0mz |
AIOPS_IMAGE_REGISTRY_ORG | The default value of the external (public facing) repository. The default value is la0cz. | AIOPS_IMAGE_REGISTRY_ORG=la0cz |
BHAC_IMAGE_REGISTRY_ORG | The default value of the external (public facing) repository. The default value is lpdbt. | BHAC_IMAGE_REGISTRY_ORG=lpdbt |
Installation mode details | ||
INSTALL_MODE | Set the value of INSTALL_MODE to fresh for a new deployment of BMC Helix ITOM. The default value is fresh. | INSTALL_MODE=fresh |
Infrastructure service installation | ||
INFRA | Set the value of INFRA to yes to deploy all the infra services. | INFRA=yes |
Individual infra services installation | ||
_PTPOSTGRESS | Set the value of _PTPOSTGRESS to yes to deploy PostgreSQL database. The default value is yes . | _PTPOSTGRESS=yes |
_KAFKA | Set the value of _KAFKA to yes to deploy Kafka. | _KAFKA=yes |
_REDISCLUSTER | Set the value of _REDISCLUSTER to yes to deploy Redis cluster. During Fresh deployment:
During upgrade:
| _REDISCLUSTER=yes |
_RSSO | Set the value of _RSSO to yes to deploy RSSO. | _RSSO=yes |
_VICTORIAMETRICS | Set the value of _VICTORIAMETRICS to yes to deploy VictoriaMetrics. | _VICTORIAMETRICS=yes |
_ELASTICSEARCH | Set the value of _ELASTICSEARCH to yes to deploy Elasticsearch. | _ELASTICSEARCH=yes |
_MINIO | Set the value of _MINIO to yes to deploy MinIO. | _MINIO = yes |
Product services details | ||
HELIX_DASHBOARD_SERVICES | Set the value of HELIX_DASHBOARD_SERVICES to yes to deploy BMC Helix Dashboards. The default value is yes. During Fresh deployment:
During upgrade:
| HELIX_DASHBOARD_SERVICES=yes |
ITSMINSIGHT_SERVICES | Set the value of ITSMINSIGHT_SERVICES to yes to deploy The default value is no. | ITSMINSIGHT_SERVICES=no |
AIOPS_SERVICES | Set the value of AIOPS_SERVICES to yes to deploy BMC Helix AIOps. The default value is no. | AIOPS_SERVICES=no |
MONITOR | Set the value of MONITOR to yes to deploy BMC Helix Operations Management. Important: If you set the value of the parameters CUSTOM_CA_SIGNED_CERT_IN_USE to false and MONITOR to yes, you must name the public CA certificate file (full chain) as public_cacert.pem and copy it to the commons/certs directory; that is, commons/certs/public_cacert.pem. The default value is no. | MONITOR=no |
LOG_ANALYTICS_SERVICES | Set the value of LOG_ANALYTICS_SERVICES to yes to deploy BMC Helix Log Analytics and BMC Helix Developer Tools. The default value is no. | LOG_ANALYTICS_SERVICES=no |
INTELLIGENT_AUTOMATION | Set the value of INTELLIGENT_AUTOMATION to yes to deploy BMC Helix Intelligent Automation. The default value is no. | INTELLIGENT_AUTOMATION=no |
OPTIMIZE | Set the value of OPTIMIZE to yes to deployBMC Helix Continuous Optimization. The default value is no. | OPTIMIZE=no |
ARSERVICES | Set the value of ARSERVICES to yes to specify whether the The default value is no. | ARSERVICES=no |
AUTOANAMOLY
| The auto anomaly services are part of BMC Helix Operations Management and BMC Helix AIOps. To enable the automatic generation of anomaly events, set the value of the AUTOANAMOLY parameter to yes. The default value is no. For more information, see Autoanomalies in the BMC Helix Operations Management documentation. | AUTOANAMOLY=no |
AUTOMATION_CONSOLE | Set the value of AUTOMATION_CONSOLEto yes to deploy BMC Helix Automation Console. The default value is no. | AUTOMATION_CONSOLE=no |
To know more about configurations specific to each component, see the following sample configuration files: