Example configuration files for BMC Helix Service Management deployment

To deploy required infrastructure services for BMC Helix Service Management, configure the parameters in the helix-on-prem-deployment-manager/configs/infra.config and helix-on-prem-deployment-manager/configs/deployment.config files according to the sample files provided in this topic.

Example infra.config file

##-----------------------------------------------------------------------------------##
##           BMC Helix Platform Common Services configuration file                   ##
##-----------------------------------------------------------------------------------##

#If you do not want to set a value for a parameter,leave it blank, and don't add double quotes.
##--------------------- Docker registry details --------------------------##
#IMAGE_REGISTRY_HOST=containers.bmc.com
#IMAGE_REGISTRY_USERNAME=<username to access registry>
IMAGE_REGISTRY_HOST=
IMAGE_REGISTRY_USERNAME=

##--------------------- Load balancer details ----------------------------##
#NAMESPACE=dark-helmet
#LB_HOST=host-india-app.mydomain.com
#LB_PORT=443
#TMS_LB_HOST=tms-private-poc.mydomain.com
#DOMAIN=mydomain.com
#MINIO_LB_HOST=minio-private-poc.mydomain.com
#TENANT_ENVIRONMENT=<Type of environment>
NAMESPACE=
LB_HOST=
LB_PORT=
TMS_LB_HOST=
DOMAIN=
# If you need MinIO web access,provide a URL (minio.domain.com) which is resolvable.otherwise,keep it blank.
MINIO_LB_HOST=
# Use minio api ingress(minio-api.domain.com)
MINIO_API_LB_HOST=
#The value of TENANT_ENVIRONMENT is based on the kind of setup you would create for example,dev,QA,production,POC,multi-service,canary, etc. It is not based on deployment size - compact,small,medium,large etc.
TENANT_ENVIRONMENT=dev

##--------------------- Cluster type -------------------------##
#CLUSTER_TYPE=<openshift or ocp>
#Cluster type can have values openshift or ocp for OpenShift.
#If CLUSTER_TYPE is not set to openshift or ocp then cluster type is treated as kubernetes cluster.
CLUSTER_TYPE=

##--------------------- Tenant details ------------------------##
#TENANT_NAME=<Tenant company name same as in the BMC Helix Discover URL>
#TENANT_EMAIL=<Tenant email address>
#TENANT_FIRST_NAME=<Tenant first name>
#TENANT_LAST_NAME=<Tenant last name>
#TENANT_TYPE=<Tenant type in tenant URL>
#TENANT_COUNTRY=<Tenant country where the servers are located or from where you are deploying BMC Helix ITOM.>
## Use only alphanumeric values in TENANT_NAME.
TENANT_NAME=
TENANT_EMAIL=
TENANT_FIRST_NAME=
TENANT_LAST_NAME=
#<The value that you specify for the Tenant type is used in the Discovery URL. >
TENANT_TYPE=
#<The tenant country name should be listed in the supported country names list. Example: "Virgin Islands, U.S." >
TENANT_COUNTRY="Virgin Islands, U.S."

##--------------------- SMTP details --------------------------##
#SMTP_ENABLE=<no/yes> This variable to enable or disable SMTP protocol, the default value: yes
#SMTP_HOST=<SMTP hostname of the IP address that is accessible from cluster>
#SMTP_PORT=<SMTP server port.Example:25>
#SMTP_USERNAME=<SMTP username>
#SMTP_FROM_EMAIL=<Sender's email address.SMTP[From]email address>
#SMTP_TLS=<true/false>
#The SMTP_AUTH variable is used by the BMC Helix Portal
#SMTP_AUTH=<PLAIN, LOGIN or NONE>
#Accepted authorization values for the SMTP server are PLAIN,LOGIN,or NONE. Use PLAIN or LOGIN for authenticated SMTP users and NONE to send emails without SMTP authentication.
#This variable is used to send report emails to the BMC Helix Dashboards. The default value is true.
#SMTP_AUTH_DASHBOARD=<true or false>
#OPS_GROUP_EMAIL=<Email address of your Operations team>
#APPROVAL_GROUP_EMAIL=<Email address of your Approval team>
SMTP_ENABLE=yes
SMTP_HOST=
SMTP_PORT=
SMTP_USERNAME=
SMTP_FROM_EMAIL=
#If you set the value of SMTP_TLS to true and the SMTP_HOST certificate is signed by a custom or self-signed CA,then you must #append the custom or self-signed CA certificate (full CA chain) to the commons/certs/custom_cacert.pem file.
SMTP_TLS=false
SMTP_AUTH_DASHBOARD=true
SMTP_AUTH=NONE
OPS_GROUP_EMAIL=
APPROVAL_GROUP_EMAIL=

##--------------------- Storage class details --------------------------##
#PG_STORAGE_CLASS=onprem-storage
#VMSTORAGE_STORAGE_CLASS=onprem-storage
#VMAGGSTORAGE_STORAGE_CLASS=onprem-storage
#ES_MASTER_STORAGE_CLASS=onprem-storage
#ES_DATA_STORAGE_CLASS=onprem-storage
#MINIO_STORAGE_CLASS=onprem-storage
#EFS_STORAGE_CLASS=onprem-storage
#REDIS_CLUSTER_STORAGE_CLASS=onprem-storage
#VALKEY_STORAGECLASS=onprem-storage
#KAFKA_STORAGECLASS=onprem-storage
#AIOPS_STORAGE_CLASS=onprem-storage

PG_STORAGE_CLASS=
VMSTORAGE_STORAGE_CLASS=
VMAGGSTORAGE_STORAGE_CLASS=
ES_MASTER_STORAGE_CLASS=
ES_DATA_STORAGE_CLASS=
MINIO_STORAGE_CLASS=
EFS_STORAGE_CLASS=
VALKEY_STORAGECLASS=
REDIS_CLUSTER_STORAGE_CLASS=
KAFKA_STORAGECLASS=
AIOPS_STORAGE_CLASS=
BHAC_STORAGE_CLASS=

#---------------------Optimize storage details --------------------------##
#OPT_STORAGE_CLASS=onprem-storage
OPT_STORAGE_CLASS=

##--------------------- Self-signed/Custom CA/Public CA -----------------------##
#CUSTOM_CA_SIGNED_CERT_IN_USE=<true/false>
#To use a self-signed or custom CA-signed certificate, set the value of the parameter to true,name the certificate file (fullchain) as custom_cacert.pem and copy it to the commons/certs/ directory.
#If you set the value of the parameter as false and the value of MONITOR to yes (in configs/deployment.config ),name the public CA certificate file (full chain) as public_cacert.pem and copy it to the commons/certs directory.
CUSTOM_CA_SIGNED_CERT_IN_USE=false

##--------------------- Service account details --------------------------##
#If you have permission to create ServiceAccount, Role, and RoleBinding, retain the value of CUSTOM_SERVICEACCOUNT_NAME as helix-onprem-sa. The installer will create the ServiceAccount during installation.
#If you do not have permission, an administrator must create a Service account, Role, and Role Binding. You cannot use the default name of helix-onprem-sa for this account and must choose a different name. You must then Assign the ServiceAccount to CUSTOM_SERVICEACCOUNT_NAME.
CUSTOM_SERVICEACCOUNT_NAME=helix-onprem-sa

##--------------------- JAVA keystore ------------------------------------##
#RSSO_CUSTOM_JAVA_KEYSTORE_IN_USE=<true or false>
#Use this parameter to integrate BMC Helix Single Sign-on (RSSO) with SAML identity provider (IdP).
#To use a custom Java Keystore for RSSO SAML keystore configuration, set the variable to true,save the java_keystore file in the commons/certs directory, and rename it to rsso_custom_java_keystore.
RSSO_CUSTOM_JAVA_KEYSTORE_IN_USE=false

##--------------------- Smart graph details ------------------------------##
#SMART_SYSTEM_USERNAME=system
SMART_SYSTEM_USERNAME=

##--------------------- Nginx controller details -------------------------##
#Ingress class used while deploying Ingress controller
INGRESS_CLASS=nginx
#NGINX_CONTROLLER=<NGINX_PLUS or NGINX_OPENSOURCE>
#If the Ingress controller is Nginx plus, set the value as NGINX_PLUS.Otherwise,leave it at the default value,NGINX_OPENSOURCE.
NGINX_CONTROLLER=NGINX_OPENSOURCE
# If NGINX_CONTROLLER is NGINX_PLUS then set INGRESS_TLS_SECRET_NAME.Otherwise,leave it blank.
INGRESS_TLS_SECRET_NAME=

##--------------------- Binary paths on your system -----------------------##
#HELM_BIN=/usr/local/bin/helm
#KUBECTL_BIN=/usr/bin/kubectl
HELM_BIN=
KUBECTL_BIN=
#OC_BIN=/usr/local/sbin/oc
#If you set CLUSTER_TYPE as openshift or ocp, you must set a value for OC_BIN.
OC_BIN=

##--------------------- Security Context details --------------------------##
#For Infra component,on an OpenShift cluster (CLUSTER_TYPE is openshift or ocp),set the correct context according to the OpenShift namespace.Else,set RUN_AS_USER,RUN_AS_GROUP and FS_GROUP as null.
RUN_AS_USER=null
RUN_AS_GROUP=null
FS_GROUP=null

#Optimize Security Context
#OPT_FSGROUP must have value 87654321 if CLUSTER_TYPE is openshift or ocp and INSTALL_MODE is upgrade and fresh deployment was performed with 22.2.01 version.Otherwise,OPT_FSGROUP must have a value of 1001.
OPT_FSGROUP=1001

#If CLUSTER_TYPE is openshift or ocp, and INSTALL_MODE is fresh, then the value of ML_FSGROUP must be the same as FS_GROUP.Else, set the value of ML_FSGROUP as 998.
ML_FSGROUP=998

################################### DO NOT CHANGE ANYTHING BELOW THIS LINE ##########################################

##---------------------Patroni Postgres config--------------------------##
PG_HOSTNAME=postgres-bmc-pg-ha-17-pool
PG_USER=postgres
PG_DATABASE=postgres

##---------------------Valkey config-----------------------------------##
VALKEY_HOSTNAME=valkey-primary

##---------------------Redis CLUSTER config------------------------------##
REDIS_CLUSTER_HOSTNAME=redis-cluster

##---------------------Kafka & Zookeeper config--------------------------##
KAFKA_HOSTNAME=kafka
ZOOKEEPER_HOSTNAME=kafka-zookeeper

##---------------------RSSO Config---------------------------------------##
RSSO_PG_DB=ade_rsso

##---------------------OpenSearch config---------------------------------##
ES_EVENTS_HOSTNAME=opensearch-events-data
ES_LOGS_HOSTNAME=opensearch-logs-data

##---------------------MinIO config--------------------------------------##
MINIO_HOSTNAME=minio

##---------------------Misc ---------------------------------------------##
IMAGE_REGISTRY_SECRET=bmc-dtrhub
TENANT_PHONE=1234567890
LOGIN_ID=hannah_admin

# Enable/disable dedicated nodes for infra components.
# Default value is no. Allowed values are yes and no.
ENABLE_DEDICATED_NODES_SUPPORT_FOR_INFRA=no

# Enable/disable priortiyClass for infra and important product services.
# Default value is no. Allowed values are yes and no.
# Ensure priortiyClass objects are created by running script utilities/priority_class/create_priority_class.sh
# from a user having cluster-admin privileges as priortiyClass is a cluster scoped object.
# The priortiyClass objects must be created before the deployment starts.
ENABLE_PRIORITY_CLASS_SUPPORT=no

#IS_HELIX_PORTAL_CUSTOM_URL=yes

Example deployment.config file for BMC Helix Service Management CORE mode

For deploying only the required infrastructure services for BMC Helix Service Management CODE mode deployment, set the SM_PLATFORM_CORE parameter in the deployment.config file.

#Common config begin
##-------------------------------------------------------------------------------##
## BMC Helix Platform Common Services configuration file ##
##-------------------------------------------------------------------------------##

##--------------------- Deployment Size -----------------------------------------##
#Values are compact, small,xsmall, medium, large, itsmcompact, itsmsmall and itsmxlarge
DEPLOYMENT_SIZE=small

##--------------------- Docker Registry Project/Repo ----------------------------##
IMAGE_REGISTRY_PROJECT=bmchelix
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
BHAC_IMAGE_REGISTRY_ORG=lpdbt
BHAC_COMMON_IMAGE_REGISTRY_ORG=lpcs5
SWP_INTELLIGENT_INTEGRATIONS_IMAGE_REGISTRY_ORG=lp0jz
#Common config end

##--------------------- Install Mode ------------------------ -------------------##
# <fresh or upgrade>
INSTALL_MODE=fresh

# RedisCluster gets deployed if the flag is set to yes alongwith any of the following products selected as yes ITSMINSIGHT_SERVICES, AIOPS_SERVICES, MONITOR, LOG_ANALYTICS_SERVICES, INTELLIGENT_AUTOMATION, OPTIMIZE, or AUTOMATION_CONSOLE.
# Valid values yes/no.
# Default value is no.
RedisCluster=no

#Product config begin

##--------------------- Helix Dashboard Services Installation -------------------##
HELIX_DASHBOARD_SERVICES=yes

##--------------------- Itsminsight Services Installation -----------------------##
ITSMINSIGHT_SERVICES=no

##--------------------- Aiops Services Installation -----------------------------##
AIOPS_SERVICES=no

##--------------------- Monitor Product Installation ----------------------------##
MONITOR=no

##--------------------- Log Analytics Services Installation ---------------------##
LOG_ANALYTICS_SERVICES=no

##--------------------- Intelligent Automation Product Installation -------------##
INTELLIGENT_AUTOMATION=no

##--------------------- Optimize Installation -------------------- -------------##
OPTIMIZE=no

##--------------------- Automation Console Services Installation ----------------##
AUTOMATION_CONSOLE=no

##--------------------- BMC Helix Intelligent Integrations Installation -----------------##
##Note: Deploys only a minimal set of services for BMC Helix Intelligent Integrations
##For more details on the scope of use cases supported through these services, refer to the BMC Helix IT Operations Management documentation.
SWP_INTELLIGENT_INTEGRATIONS=no

##----------------- Service Management for ITSM Services Installation -----------##
SM_PLATFORM_CORE=yes

#Product config end

#Feature config begin

##--------------------- Helix AIOps GPT Services Installation -------------------##
#Helix AIOps GPT services are part of AIOPS_SERVICES.
AIOPS_GPT=no

##--------------------- Autoanamoly Services Installation -------- --------------##
#Autoanamoly services are part of MONITOR and AIOPS_SERVICES.
AUTOANAMOLY=no

##----------------- Service Management Platform Full SKU Installation -----------##
SM_PLATFORM_FULL=no

##----------------- Dynamic Service Modeling Installation ------------------------##
DYNAMIC_SERVICE_MODELING=no

#Feature config end

##-------------------------------End Of file-------------------------------------##

Example deployment.config file for BMC Helix Service Management FULL mode

For deploying all the required infrastructure services for BMC Helix Service Management FULL mode deployment, set the SM_PLATFORM_FULL parameter in the deployment.config file.

#Common config begin
##-------------------------------------------------------------------------------##
## BMC Helix Platform Common Services configuration file ##
##-------------------------------------------------------------------------------##

##--------------------- Deployment Size -----------------------------------------##
#Values are compact, small,xsmall, medium, large, itsmcompact, itsmsmall and itsmxlarge
DEPLOYMENT_SIZE=small

##--------------------- Docker Registry Project/Repo ----------------------------##
IMAGE_REGISTRY_PROJECT=bmchelix
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
BHAC_IMAGE_REGISTRY_ORG=lpdbt
BHAC_COMMON_IMAGE_REGISTRY_ORG=lpcs5
SWP_INTELLIGENT_INTEGRATIONS_IMAGE_REGISTRY_ORG=lp0jz
#Common config end

##--------------------- Install Mode ------------------------ -------------------##
# <fresh or upgrade>
INSTALL_MODE=fresh

# RedisCluster gets deployed if the flag is set to yes alongwith any of the following products selected as yes ITSMINSIGHT_SERVICES, AIOPS_SERVICES, MONITOR, LOG_ANALYTICS_SERVICES, INTELLIGENT_AUTOMATION, OPTIMIZE, or AUTOMATION_CONSOLE.
# Valid values yes/no.
# Default value is no.
RedisCluster=no

#Product config begin

##--------------------- Helix Dashboard Services Installation -------------------##
HELIX_DASHBOARD_SERVICES=yes

##--------------------- Itsminsight Services Installation -----------------------##
ITSMINSIGHT_SERVICES=no

##--------------------- Aiops Services Installation -----------------------------##
AIOPS_SERVICES=no

##--------------------- Monitor Product Installation ----------------------------##
MONITOR=no

##--------------------- Log Analytics Services Installation ---------------------##
LOG_ANALYTICS_SERVICES=no

##--------------------- Intelligent Automation Product Installation -------------##
INTELLIGENT_AUTOMATION=no

##--------------------- Optimize Installation -------------------- -------------##
OPTIMIZE=no

##--------------------- Automation Console Services Installation ----------------##
AUTOMATION_CONSOLE=no

##--------------------- BMC Helix Intelligent Integrations Installation -----------------##
##Note: Deploys only a minimal set of services for BMC Helix Intelligent Integrations
##For more details on the scope of use cases supported through these services, refer to the BMC Helix IT Operations Management documentation.
SWP_INTELLIGENT_INTEGRATIONS=no

##----------------- Service Management for ITSM Services Installation -----------##
SM_PLATFORM_CORE=no

#Product config end

#Feature config begin

##--------------------- Helix AIOps GPT Services Installation -------------------##
#Helix AIOps GPT services are part of AIOPS_SERVICES.
AIOPS_GPT=no

##--------------------- Autoanamoly Services Installation -------- --------------##
#Autoanamoly services are part of MONITOR and AIOPS_SERVICES.
AUTOANAMOLY=no

##----------------- Service Management Platform Full SKU Installation -----------##
SM_PLATFORM_FULL=yes

##----------------- Dynamic Service Modeling Installation ------------------------##
DYNAMIC_SERVICE_MODELING=no

#Feature config end

##-------------------------------End Of file-------------------------------------##

Example deployment.config file for BMC Helix Service Management with dynamic service modelling

For deploying all the required infrastructure services for BMC Helix Service Management deployment with the dynamic service modeling option, set the following parameters in the infra.config and deployment.config files:

SMART_SYSTEM_USERNAME=system
SM_PLATFORM_FULL
DYNAMIC_SERVICE_MODELING

#Common config begin
##-------------------------------------------------------------------------------##
## BMC Helix Platform Common Services configuration file ##
##-------------------------------------------------------------------------------##

##--------------------- Deployment Size -----------------------------------------##
#Values are compact, small,xsmall, medium, large, itsmcompact, itsmsmall and itsmxlarge
DEPLOYMENT_SIZE=small

##--------------------- Docker Registry Project/Repo ----------------------------##
IMAGE_REGISTRY_PROJECT=bmchelix
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
BHAC_IMAGE_REGISTRY_ORG=lpdbt
BHAC_COMMON_IMAGE_REGISTRY_ORG=lpcs5
SWP_INTELLIGENT_INTEGRATIONS_IMAGE_REGISTRY_ORG=lp0jz
#Common config end

##--------------------- Install Mode ------------------------ -------------------##
# <fresh or upgrade>
INSTALL_MODE=fresh

# RedisCluster gets deployed if the flag is set to yes alongwith any of the following products selected as yes ITSMINSIGHT_SERVICES, AIOPS_SERVICES, MONITOR, LOG_ANALYTICS_SERVICES, INTELLIGENT_AUTOMATION, OPTIMIZE, or AUTOMATION_CONSOLE.
# Valid values yes/no.
# Default value is no.
RedisCluster=no

#Product config begin

##--------------------- Helix Dashboard Services Installation -------------------##
HELIX_DASHBOARD_SERVICES=yes

##--------------------- Itsminsight Services Installation -----------------------##
ITSMINSIGHT_SERVICES=no

##--------------------- Aiops Services Installation -----------------------------##
AIOPS_SERVICES=no

##--------------------- Monitor Product Installation ----------------------------##
MONITOR=no

##--------------------- Log Analytics Services Installation ---------------------##
LOG_ANALYTICS_SERVICES=no

##--------------------- Intelligent Automation Product Installation -------------##
INTELLIGENT_AUTOMATION=no

##--------------------- Optimize Installation -------------------- -------------##
OPTIMIZE=no

##--------------------- Automation Console Services Installation ----------------##
AUTOMATION_CONSOLE=no

##--------------------- BMC Helix Intelligent Integrations Installation -----------------##
##Note: Deploys only a minimal set of services for BMC Helix Intelligent Integrations
##For more details on the scope of use cases supported through these services, refer to the BMC Helix IT Operations Management documentation.
SWP_INTELLIGENT_INTEGRATIONS=no

##----------------- Service Management for ITSM Services Installation -----------##
SM_PLATFORM_CORE=no

#Product config end

#Feature config begin

##--------------------- Helix AIOps GPT Services Installation -------------------##
#Helix AIOps GPT services are part of AIOPS_SERVICES.
AIOPS_GPT=no

##--------------------- Autoanamoly Services Installation -------- --------------##
#Autoanamoly services are part of MONITOR and AIOPS_SERVICES.
AUTOANAMOLY=no

##----------------- Service Management Platform Full SKU Installation -----------##
SM_PLATFORM_FULL=yes

##----------------- Dynamic Service Modeling Installation ------------------------##
DYNAMIC_SERVICE_MODELING=yes

#Feature config end

##-------------------------------End Of file-------------------------------------##