Deploying BMC Helix common services for BMC Helix IT Service Management

Use the container images to deploy the BMC Helix Platform common services for use with BMC Helix IT Service Management.

The following BMC Helix Platform services are used by BMC Helix IT Service Management:

BMC Helix Dashboards
ITSM Insights
BMC Helix Platform logging

Related topic

Deployment scenarios

Before you begin

Create a namespace and configure the ingress controller before deploying the product. Perform the following actions:

Important

Only the root user is supported for deployment.

Create a namespace by running the following command. The namespace must be a DNS-1123 label. That is, it must consist of lowercase alphanumeric characters or '-', and must start and end with an alphanumeric character.
```
kubectl create ns <namespace>
```
Verify that nothing is installed in the namespace in which you plan to deploy the product. Perform the following steps:
1. Run the following command:
```
kubectl get all -n <namespace_created_earlier_in_this_procedure>
```
2. Make sure that the following message is displayed:
  
  No resources found.

Configure the ingress controller. Perform the following steps:

Identify the configmap name by running the following command:
```
kubectl get all -n <ingress_nginx_namespace>
```

Change the configmap name to use the configmap in your environment by running the following command:

kubectl edit cm <ingress_nginx_configmap> -n  <ingress_nginx_namespace>

data:
  enable-underscores-in-headers: "true"
  proxy-body-size: 250m
  server-name-hash-bucket-size: "1024"
  ssl-redirect: "false"
  use-forwarded-headers: "true"

If you are deploying BMC Helix AIOps, perform the following steps:
1. Open the ../products/aiops/aiops.json file.
2. Under the ml-model-mgmt-service entry, replace image.org with containers[0].org.
3. Save and close the file.

For EFK logging

Create a namespace called bmc-helix-logging by using the following command:

kubectl create ns bmc-helix-logging

The Elasticsearch, FluentD, and Kibana services are installed in this namespace. These services are required to access logs from the pods that are running on BMC Helix Platform.

For more information, see Preparing for BMC Helix logging.

To deploy the BMC Helix Platform common services

Log in to the controller or bastion machine from where the Kubernetes cluster is accessible.
Go to the directory where you downloaded the deployment manager from the EPD and give the execute permission to the helix-on-prem-deployment-manager-<release_version>.sh file.

Self-extract the deployment manager. Run the following command:

./helix-on-prem-deployment-manager-<release_version>.sh


cd helix-on-prem-deployment-manager

In the helix-on-prem-deployment-manager/config/infra.config file, modify the following parameters that are environment-specific.

Important

The following load balancer hosts are required. You do not need any subdomains.
- LB_HOST
- TMS_LB_HOST
- MINIO_LB_HOST
- Tenant URL that is derived based on the following parameters from the infra.config file:
  $COMPANY_NAME-$TENANT_TYPE-$ENVIRONMENT.$DOMAIN
Make sure that you have created a storage class.

Property	Example Value	Description
`IMAGE_REGISTRY_HOST`	containers.bmc.com (or local repo if copied down)	Image registry from where the nodes on the cluster download the images. If you have synchronized the images to local Harbor registry, make sure Harbor registry is set up with HTTPS.
`IMAGE_REGISTRY_USERNAME`	abc@bmc.com	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.
`IMAGE_REGISTRY_PASSWORD`	1234578abcdefgh	Password to log in to BMC DTR. If you use a local Harbor registry to synchronize with BMC DTR, specify the password to log in to your local registry.
`ENVIRONMENT`	poc	Type of environment such as poc, dev, qa, and prod. Do not use special characters for the environment value. You can use the same environment value while performing the BMC Helix Innovation Suite installation.
`NAMESPACE`	dark-helmet	Namespace in which to install the services. You must have separate namespaces to install BMC Helix Platform services and BMC Helix Innovation Suite platform and applications. Learn about the required namespaces at Deployment process overview.
`LB_HOST`	host-india-app.mydomain.com	Host for load balancer for BMC Helix Innovation Suite. Specify the BMC Helix Innovation Suite URL.
`LB_PORT`	443	Port for load balancer.
`TMS_LB_HOST`	tms-private-poc.mydomain.com	Host for tenant management system. Specify the host of the load balancer that points to the tenant management system service.
`Domain`	mydomain.com	Domain name of the Load Balancer
`MINIO_LB_HOST`	minio-private-poc.mydomain.com	URL for Minio storage.
`CLUSTER_TYPE`	""	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.
`COMPANY_NAME`	photon2	This will be used in the tenant URL formation like $COMPANY_NAME-$TENANT_TYPE-$ENVIRONMENT.$DOMAIN Do not use special characters for the Company name. COMPANY_NAME value is used to generate the tenant URL.
`TENANT_EMAIL`	pqr@mycompany.com
`TENANT_FIRST_NAME`	TestName
`TENANT_LAST_NAME`	TestLastName
`TENANT_TYPE`	private
`COUNTRY`	"United States"	The country name must match the value in the OS locale. Important Add the country name within double quotes. For example: `"India"` Do not use abbreviation in country names. Click here to view a list of the supported country names.
`NFS_MOUNT_PATH`	""	Leave it as blank "" This parameter is not required for BMC Helix IT Service Management.
`NFS_SERVER`	""	Leave it as blank "" Leave blank. This parameter is not required for BMC Helix IT Service Management.
`NFS_STORAGE_CLASS`	""	Leave it as blank "" Leave blank. This parameter is not required for BMC Helix IT Service Management.
`SMTP_HOST`	mailhost.mycompany.com	SMTP host name of IP address accessible from cluster This parameter is required. SMTP parameters are required for the emails that are sent to the administrator for tenant activation after the BMC Helix Platform deployment is complete.
`SMTP_PORT`	25	SMTP server port, e.g. 25 This parameter is required.
`SMTP_USERNAME`	abc@mycompany.com	SMTP user name This parameter is required.
`SMTP_PASSWORD`	test123	SMTP password This parameter is required.
`SMTP_FROM_EMAIL`	helix-rd@mycompany.com	Email to use for the from address in all emails This parameter is required.
`SMTP_TLS`	""	SMTP server TLS, Leave it blank if not in use This parameter is required.
`SMTP_AUTH`	plain	Use values as "plain" or "login" This parameter is required.
`OPS_GROUP_EMAIL`	ops-grp@mycompany.com	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`	grp-rd@mycompany.com	email address for approval When a new tenant is created, an email is sent for tenant approval to this email group.
`PG_STORAGE_CLASS`	ceph-block-storage	Storage class used. Usually there is one Storage class configured for all the infra services. Please repeat the same value in that case
`VMSTORAGE_STORAGE_CLASS`	onprem-storage	Storage class for VictoriaMetrics.
`VMAGGSTORAGE_STORAGE_CLASS`	onprem-storage
`ES_MASTER_STORAGE_CLASS`	block-store-class	Storage class for Elasticsearch master nodes
`ES_DATA_STORAGE_CLASS`	block-store-class	Storage class for Elasticsearch data nodes.
`MINIO_STORAGE_CLASS`	onprem-storage	Storage class for Minio.
`EFS_STORAGE_CLASS`	""	Leave it as blank ""
`REDIS_HA_GLOBAL_STORAGECLASS`	block-store-class	Storage class for REDIS
`KAFKA_STORAGECLASS`	block-store-class	Storage class for Kafka
`ESLOG_MASTER_STORAGE_CLASS`	block-store-class	Storage class for Elasticsearch log
`ESLOG_DATA_STORAGE_CLASS`	block-store-class	Storage class for Elasticsearch log
`AIOPS_STORAGE_CLASS`	""	Leave it as blank ""
`OPT_STORAGE_CLASS`	""	Leave it as blank ""
`REPOPV_MOUNT_PATH`	""	Leave it as blank ""
`MIGRATORPV_MOUNT_PATH`	""	Leave it as blank ""
`ETLPV_MOUNT_PATH`	""	Leave it as blank ""
`CUSTOM_CA_SIGNED_CERT_IN_USE`	false	The default value is `false`.
`CLIENT_ROOT_CERT`	""	Leave it as blank ""
`SMART_SYSTEM_USERNAME`	""	Leave it as blank ""
`SMART_SYSTEM_PASSWORD`	""	Leave it as blank ""
`INGRESS_CLASS`	nginx	Ingress class used while deploying Ingress controller. Change if multiple ingress controllers on cluster. By default rancher will have nginx. If you have more than one ingress controllers in your cluster, use INGRESS_CLASS to specify the ingress class name that you want to use.
`HELM_BIN`	/usr/local/bin/helm	Absolute path of the HELM binary
`KUBECTL_BIN`	/usr/bin/kubectl	Absolute path of the kubectl binary
`OC_BIN`	/usr/local/sbin/oc	OC_BIN path should be set if CLUSTER_TYPE is openshift or ocp
`PG_HOSTNAME`	postgres-postgresql-ha-pgpool	Host of the PostgreSQL database.
`PG_USER`	postgres	User name of the PostgreSQL database.
`PG_PASSWD`	pGTest2020	Password for the PostgreSQL database user.
`PG_DATABASE`	postgres	Name of the PostgreSQL database.
`REDIS_HA_HOSTNAME`	redis-redis-ha-haproxy	Host of the Redis database.
`KAFKA_HOSTNAME`	kafka	Host of the Kafka database.
`ZOOKEEPER_HOSTNAME`	kafka-zookeeper	Host of the Zookeeper database.
`RSSO_PG_DB`	ade_rsso	Host of the BMC Helix Single Sign-On PostgreSQL database.
`ES_EVENTS_HOSTNAME`	elasticsearch-events-opendistro-es-data-svc	Host name of Elasticsearch events instance.
`ES_LOGS_HOSTNAME`	elasticsearch-logs-opendistro-es-data-svc	Host name of Elasticsearch log instance.
`MINIO_HOSTNAME`		Leave it as blank, no double quotes. MINIO_HOSTNAME=
`IMAGE_REGISTRY_SECRET`	bmc-dtrhub	Kubernetes secret name for accessing the images from BMC DTR or a local Harbor registry.
`LOGIN_ID`	hannah_admin	Tenant admin

In the helix-on-prem-deployment-manager/configs/deployment.config file, modify the following parameters:

Parameter	Required value
`DEPLOYMENT_ENVIRONMENT`	`small`
`HELIX_DASHBOARD_SERVICES`	`yes`
`VICTORIAMETRICS`	`yes`
`MINIO`	`yes`
(Optional) `ITSMINSIGHT_SERVICES`	`yes` If you are not using ITSM Insights, set this parameter to `No`.
`BMC_HELIX_LOGGING`	`yes`

To install the product, run the following command:
```
./deployment-manager.sh
```
To run the deployment in the background, run the following command:
```
nohup ./deployment-manager.sh </dev/null &
```
To view the logs during installation, run the following command:
```
tail -f logs/deployment.log
```

After the BMC Helix Platform services are deployed, the tenant administrator receives the following emails:

An email with details about the BMC Helix Platform account
An email to change the BMC Helix Platform account password at the first login

After the installation, you can see the Elasticsearch, Fluentd, and Kibana pods in the bmc-helix-logging namespace. You can access Kibana with the following URL:

http://<masternodeio>:5601/

All installation logs are located in the following directory:

helix-on-prem-deployment-manager/logs

Where to go from here

Set up your environment to make it ready for installing BMC Helix Innovation Suite. For more information, see the BMC Helix Innovation Suite documentation Open link .

Sample configuration files

Sample infra.config file

#Docker registry details
#IMAGE_REGISTRY_HOST=containers.bmc.com
#IMAGE_REGISTRY_USERNAME=<user name to access registry>
#IMAGE_REGISTRY_PASSWORD=<password to access registry>
IMAGE_REGISTRY_HOST=<hostA>.bmc.com
IMAGE_REGISTRY_USERNAME=<username> 
IMAGE_REGISTRY_PASSWORD=<password>

# keep double quotes in all variables if not required, don't leave them blank or empty
#Infra details
#NAMESPACE=dark-helmet
#LB_HOST=<hostB>.mydomain.com
#LB_PORT=443
#TMS_LB_HOST=<hostC>.com
#DOMAIN=mydomain.com
MINIO_LB_HOST=minio<hostD>.com
#ENVIRONMENT=<Type of environment>
ENVIRONMENT=poc
NAMESPACE=onpremlab22
LB_HOST=star-lb.dsmlab.bmc.com
LB_PORT=443
TMS_LB_HOST=star-tms.dsmlab.bmc.com
DOMAIN=dsmlab.bmc.com
MINIO_LB_HOST=star-minio-poc.dsmlab.bmc.com

#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 for onboarding
#COMPANY_NAME=<tenant company name same as in tenant discover appliance 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 same as in tenant discovery appliance url>
## Please use only alphanumeric value in COMPANY_NAME
COMPANY_NAME=star1
TENANT_EMAIL=Peter_Adams@bmc.com
TENANT_FIRST_NAME=Peter
TENANT_LAST_NAME=Adams
TENANT_TYPE=private
# Ensure that the value of COUNTRY is enclosed within double quotes
COUNTRY="Virgin Islands, U.S."

#NFS details
## fully qualified mount path (e.g. /data/ade-stack/export) with folder (e.g. volumes), it will use static pvc with nfs storage
## Create a folder under mount path and change the owner to 786:998, e.g. chown -R 786:998 /data/ade-stack/export/volumes
#NFS_MOUNT_PATH=/data/ade-stack/export/volumes
#NFS_SERVER=<nfs server host name or IP address accessible from cluster>
#NFS_STORAGE_CLASS=onprem-nfs-storage
## keep NFS_STORAGE_CLASS empty if default storage class value should be used.

#NFS_MOUNT_PATH=/data1
#NFS_SERVER=172.19.121.10
#NFS_STORAGE_CLASS=""
NFS_MOUNT_PATH=""
NFS_SERVER=""
NFS_STORAGE_CLASS=""


#SMTP Config
#SMTP_HOST=<SMTP host name of IP address accessible from cluster>
#SMTP_PORT=<SMTP server port, e.g. 25>
#SMTP_USERNAME=<SMTP user name>
#SMTP_PASSWORD=<SMTP password>
#SMTP_FROM_EMAIL=<SMTP from email address>
#SMTP_TLS=<SMTP server TLS, Leave it blank if not in use>
#SMTP_AUTH=<plain or login>
#OPS_GROUP_EMAIL=<ops email address>
#APPROVAL_GROUP_EMAIL=<email address for approval>
SMTP_HOST=mailhost.bmc.com
SMTP_PORT=25
#Ensure blank values for SMTP username password is in double quotes
SMTP_USERNAME=Alok_Khare@bmc.com
SMTP_PASSWORD=test123
SMTP_FROM_EMAIL=helix-activation@bmc.com
## SMTP_TLS value can be blank, use double quotes to give blank value
SMTP_TLS=
SMTP_AUTH=plain
OPS_GROUP_EMAIL=Alok_Khare@bmc.com
APPROVAL_GROUP_EMAIL=Alok_Khare@bmc.com

#storage class, set value as per storage class in cluster 
#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=star-nfs-storage
VMSTORAGE_STORAGE_CLASS=star-nfs-storage
VMAGGSTORAGE_STORAGE_CLASS=star-nfs-storage
ES_MASTER_STORAGE_CLASS=star-nfs-storage
ES_DATA_STORAGE_CLASS=star-nfs-storage
MINIO_STORAGE_CLASS=star-nfs-storage
EFS_STORAGE_CLASS=""
REDIS_HA_GLOBAL_STORAGECLASS=star-nfs-storage
KAFKA_STORAGECLASS=star-nfs-storage
ESLOG_MASTER_STORAGE_CLASS=star-nfs-storage
ESLOG_DATA_STORAGE_CLASS=star-nfs-storage
OPT_STORAGE_CLASS=star-nfs-storage
AIOPS_STORAGE_CLASS="

# Deployment Repository Service client root cert
# Ensure that the value of CLIENT_ROOT_CERT is enclosed within double quotes
#CLIENT_ROOT_CERT="jEV0lsYSEY1QSte="
CLIENT_ROOT_CERT=""

# Smart Graph
#SMART_SYSTEM_USERNAME=username
#SMART_SYSTEM_PASSWORD=password
SMART_SYSTEM_USERNAME=""
SMART_SYSTEM_PASSWORD=""

# Ingress class used while deploying Ingress controller
INGRESS_CLASS=nginx

#Binary paths on your system
#HELM_BIN=/usr/local/bin/helm
#KUBECTL_BIN=/usr/bin/kubectl
HELM_BIN=/usr/local/bin/helm
KUBECTL_BIN=/usr/local/bin/kubectl
#OC_BIN path should be set if CLUSTER_TYPE is openshift or ocp
#OC_BIN=/usr/local/sbin/oc
OC_BIN=

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

#Postgres config
PG_HOSTNAME=postgres-postgresql-ha-pgpool
PG_USER=postgres
PG_PASSWD=pGTest2020
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

#Elasticsearch config
ES_EVENTS_HOSTNAME=elasticsearch-events-opendistro-es-data-svc
ES_LOGS_HOSTNAME=elasticsearch-logs-opendistro-es-data-svc

#MinIO config

MINIO_HOSTNAME=minio

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

Sample deployment.config file

#Common config begin
#Type of deployment, values are poc, small, medium, large
DEPLOYMENT_ENVIRONMENT=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 
_POSTGRES=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=yes

#Flag controlling aiops services installation 
AIOPS_SERVICES=no

#Flag controlling monitor product installation
MONITOR=no

#Flag controlling intelligentintegrations services installation 
INTELLI_INT_SERVICES=no

#Flag controlling intelligent automation product installation
INTELLIGENT_AUTOMATION=no
#Flag controlling bmc-helix-logging product installation
BMC_HELIX_LOGGING=yes

#Flag Controlling optimize installation
OPTIMIZE=no

Deploying BMC Helix common services for BMC Helix IT Service Management

Before you begin

To deploy the BMC Helix Platform common services

Where to go from here

Sample configuration files

Comments