Example configuration files for BMC Helix Intelligent Automation


To deploy BMC Helix Operations Management with BMC Helix Intelligent Automation, 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.


Sample 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
#KIBANA_LB_HOST=kibana-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=
KIBANA_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_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_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=
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_HA_GLOBAL_STORAGECLASS=onprem-storage
#KAFKA_STORAGECLASS=onprem-storage
#ESLOG_MASTER_STORAGE_CLASS=onprem-storage
#ESLOG_DATA_STORAGE_CLASS=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=
REDIS_HA_GLOBAL_STORAGECLASS=
KAFKA_STORAGECLASS=
ESLOG_MASTER_STORAGE_CLASS=
ESLOG_DATA_STORAGE_CLASS=
AIOPS_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 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-15-pool
PG_USER=postgres
PG_DATABASE=postgres

##---------------------Redis HA config-----------------------------------##
REDIS_HA_HOSTNAME=redis-redis-ha-haproxy

##---------------------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

#IS_HELIX_PORTAL_CUSTOM_URL=yes 


Sample deployment.config file

To install BMC Helix Intelligent Automation, set the following service flags to yes:

  • INTELLIGENT_AUTOMATION
  • (OptionalHELIX_DASHBOARD_SERVICES
#Size of deployment, values are compact, small, medium, large, itsmcompact, itsmsmall and itsmxlarge
DEPLOYMENT_SIZE=small

#Docker registry project details
IMAGE_REGISTRY_PROJECT=bmc
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

#Common config end

#Install mode as fresh or upgrade
INSTALL_MODE=fresh

#Flag controlling infra services installation
INFRA=yes

#Flag controlling individual infra services installation
_PTPOSTGRESS=yes
_KAFKA=yes
_REDIS=yes
_RSSO=yes
_VICTORIAMETRICS=yes
_ELASTICSEARCH=yes
_MINIO=yes

# Do not make changes to service flags it will break dependency
#Flag controlling helix dashboard services installation
HELIX_DASHBOARD_SERVICES=yes

#Flag controlling itsminsight services installation
ITSMINSIGHT_SERVICES=no

#Flag controlling aiops services installation
AIOPS_SERVICES=no

#Flag controlling monitor product installation
MONITOR=no

#Flag controlling intelligentintegrations services installation  
LOG_ANALYTICS_SERVICES=no

#Flag controlling intelligent automation product installation
INTELLIGENT_AUTOMATION=yes

#Flag controlling bmc-helix-logging product installation
BMC_HELIX_LOGGING=no

#Flag Controlling optimize installation
OPTIMIZE=no

#Flag AR Services installation
ARSERVICES=no

#Flag for autoanamoly services installation
#Autoanamoly services are part of MONITOR and AIOPS_SERVICES. Please refer documentation for more details
AUTOANAMOLY=no


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*