Installing BMC Helix Platform services 22.2.01
The following services provided by BMC Helix Platform are used by BMC Helix IT Service Management:
- Infrastructure services
- Common services
- BMC Helix Dashboards
- BMC Helix ITSM Insights
Important
After you install BMC Helix Platform services to 22.2.01 version, you must apply the 22.2.01 hotfix 1.
Before you begin
Create a namespace.
Configure the ingress controller.
The following host names must be created with a DNS entry that points to the load balancer. The property names are used in the infra.config and deployment.config files during deployment. Make sure that the URLs are in the same domain.
Description Product Format Example Must be configured in the load balancer? Must have a DNS entry? File name Property name Host for Helix RSSO All <any unique string>.$DOMAIN
mycomputer-rsso.lab.bmc.com Yes Yes configs/infra.config LB_HOST
Host for tenant management system All <any unique string>.$DOMAIN
mycomputer-tms.lab.bmc.com Yes Yes configs/infra.config TMS_LB_HOST
MinIO storage URL All <any unique string>.$DOMAIN
mycomputer-minio.lab.bmc.com Yes Yes configs/infra.config MINIO_LB_HOST
Tenant URL All $COMPANY_NAME-$TENANT_TYPE-$ENVIRONMENT.$DOMAIN
acme-private-poc.lab.bmc.com Yes Yes configs/deployment.config for ENVIRONMENT
and configs/infra.config for the othersCOMPANY_NAME TENANT_TYPE ENVIRONMENT DOMAIN
Discovery Appliance URL
- BMC Helix IT Operations Management
- BMC Helix Continuous Optimization
$COMPANY_NAME-disc-$TENANT_TYPE-$ENVIRONMENT.$DOMAIN
acme-disc-private-poc.lab.bmc.com No Yes configs/deployment.config for ENVIRONMENT
and configs/infra.config for the othersCOMPANY_NAME TENANT_TYPE ENVIRONMENT DOMAIN
BMC Helix Continuous Optimization
BMC Helix Continuous Optimization
$COMPANY_NAME-optimize-$TENANT_TYPE-$ENVIRONMENT.$DOMAIN
acme-optimize-private-poc.lab.bmc.com No Yes configs/deployment.config for ENVIRONMENT
and configs/infra.config for the othersCOMPANY_NAME TENANT_TYPE ENVIRONMENT DOMAIN
To deploy the BMC Helix Platform services
- Log in to the controller or bastion machine from where the Kubernetes cluster is accessible.
- Download the deployment manager BMC_Helix_Platform_Services_for_Service_Management_Version_22.2.01.zip from BMC Electronic Product Distribution (EPD) and extract it, if you haven't already.
The ZIP file contains the following files:- helix-on-prem-deployment-manager-22.2.01.sh—This file contains the deployment manager.
- jsons_22201_002.bzip2—This file contains the fix for the incorrect deployment file repository location issue.
- hotfix-22.2.01.001-17.tar.gz—This file contains the 22.2.01 hotfix 1 artifacts.
- helix-on-prem-deployment-manager-22.2.01.sh—This file contains the deployment manager.
- Download the only_ITSM_configs_22201_003.tar.xz file from EPD, if you haven't already.
This file contains the latest deployment size templates.
To download the files from EPD, see Downloading the installation files. 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-22.2.01.sh file.
Self-extract the deployment manager. Run the following command:
./helix-on-prem-deployment-manager-22.2.01.sh cd helix-on-prem-deployment-manager
- If you are installing BMC Helix Platform services on Kubernetes 1.24 version, perform the following steps:
- Navigate to the commons directory.
- Open the preinstall-checker.sh file.
- Comment the code for Kubernetes version check.
Prepare for password encryption:
To apply the fix for the incorrect deployment file repository location issue, perform the following steps:
- Copy the jsons_22201_002.bzip2 file in the helix-on-prem-deployment-manager directory.
Unzip the file by running the following command:
tar xvf jsons_22201_002.bzip2
After you unzip the file, the following folders are replaced in the helix-on-prem-deployment-manager/Products directory:
- aiops
- common-services
- helixdashboard-services
- intelligentautomation
- intelligentintegrations
- itsminsight-services
- monitor
- platform
- Copy the jsons_22201_002.bzip2 file in the helix-on-prem-deployment-manager directory.
- Update the deployment size templates.
- In the helix-on-prem-deployment-manager directory, copy the only_ITSM_configs_22201_003.tar.xz file.
Extract the only_ITSM_configs_22201_003.tar.xz file by using the following command:
tar xvf only_ITSM_configs_22201_003.tar.xz
After you unzip the file, the following folders are replaced with the new deployment size templates in the helix-on-prem-deployment-manager directory.
- configs/
- configs/compact.config
- configs/compact.json
- configs/compact_jvm.config
- configs/small.config
- configs/small.json
- configs/small_jvm.config
- In the helix-on-prem-deployment-manager directory, copy the only_ITSM_configs_22201_003.tar.xz file.
In the helix-on-prem-deployment-manager/configs/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
Ensure that the LB_HOST value is not the same as the tenant URL. - 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
- LB_HOST
- Make sure that you have created a storage class.
Parameter Name
Description
Example
IMAGE_REGISTRY_HOST
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.
(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.
ENVIRONMENT
Type of environment such as poc, dev, and qa.
Do not use special characters for the environment value.
You can use the same environment value while performing the BMC Helix Innovation Suite installation.
poc NAMESPACE
Namespace in which to install the services.
You must have separate namespaces to install BMC Helix Platform services and BMC Helix Innovation Suite and applications.
dark-helmet
LB_HOST
Host for load balancer for BMC Helix Innovation Suite.
Specify the BMC Helix Innovation Suite URL.
LB_PORT
Port for load balancer. 443
TMS_LB_HOST
Host for tenant management system.
Specify the host of the load balancer that points to the tenant management system service.
Domain
Domain name of the Load Balancer
MINIO_LB_HOST
URL for Minio storage.
minio-private-poc.mydomain.com 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
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.
photon2
TENANT_EMAIL
Email address of the admin user of initial tenant. TENANT_FIRST_NAME
First name of the admin user for initial tenant. TestName
TENANT_LAST_NAME
Last name of the admin user for initial tenant. TestLastName
TENANT_TYPE
Unique identifier of the tenant.
The COMPANY_NAME value is used as the tenant name. In addition to the tenant name, use the TENANT_TYPE parameter to identify the tenant.tyrion
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$.DOMAIN
acme-private-poc.acme.com COUNTRY
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.
"United States"
NFS_MOUNT_PATH
Leave it blank ""
This parameter is not required for BMC Helix ITSM.
"" NFS_SERVER
Leave it blank ""
Leave blank. This parameter is not required for BMC Helix ITSM.
"" NFS_STORAGE_CLASS Leave it blank ""
Leave blank. This parameter is not required for BMC Helix ITSM.
"" SMTP_HOST
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.
All SMTP mail servers are supported.
To use a temporary SMTP server to receive BMC Helix Platform services installation emails, see the knowledge article 000396217
.
mailhost.mycompany.com
SMTP_PORT
An integer value for the port of the SMTP server. For example. 25
This parameter is required.
25
SMTP_USERNAME
User name to connect to the SMTP server.
If
SMTP_AUTH
value is set toNONE
, keep theSMTP_USERNAME
andSMTP_PASSWORD
values blank as shown below:SMTP_USERNAME=""
SMTP_PASSWORD=""
This parameter is required.
abc@mycompany.com
SMTP_FROM_EMAIL
A valid email ID for the From address in all emails
This parameter is required.
helix-rd@mycompany.com
SMTP_TLS
The SMTP server TLS. If not in use, leave the parameter blank as shown below:
SMTP_TLS=""
""
SMTP_AUTH_DASHBOARD
The value can be
true
orfalse
.true
SMTP_AUTH
One of the following values:
PLAIN
This value is case sensitive. If you set the value asPLAIN
, it is mandatory to set valid values forSMTP_USER
andSMTP_PASSWORD
.LOGIN
This value is case sensitive. If you set the value asLOGIN
, it is mandatory to set valid values forSMTP_USER
andSMTP_PASSWORD
.NONE
This value is case sensitive. Use this value when you want to skip SMTP authentication. If you set the value asNONE
, set the user name and password values as shown below:SMTP_USERNAME=""
SMTP_PASSWORD=""
PLAIN
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.
ops-grp@mycompany.com
APPROVAL_GROUP_EMAIL
email address for approval
When a new tenant is created, an email is sent for tenant approval to this email group.
grp-rd@mycompany.com
PG_STORAGE_CLASS
Storage class used. Usually there is one Storage class configured for all the infra services. Please repeat the same value in that case
ceph-block-storage
VMSTORAGE_STORAGE_CLASS
Storage class for VictoriaMetrics. onprem-storage
VMAGGSTORAGE_STORAGE_CLASS
Storage class for VictoriaMetrics. onprem-storage
ES_MASTER_STORAGE_CLASS Storage class for Elasticsearch master nodes block-store-class ES_DATA_STORAGE_CLASS Storage class for Elasticsearch data nodes. block-store-class MINIO_STORAGE_CLASS
Storage class for Minio. onprem-storage
EFS_STORAGE_CLASS Leave it blank "" "" REDIS_HA_GLOBAL_STORAGECLASS Storage class for REDIS block-store-class KAFKA_STORAGECLASS Storage class for Kafka block-store-class ESLOG_MASTER_STORAGE_CLASS
Storage class for Elasticsearch log block-store-class ESLOG_DATA_STORAGE_CLASS Storage class for Elasticsearch log block-store-class AIOPS_STORAGE_CLASS Leave it blank "" "" 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
.
Important: If you are using a self-signed or custom CA certificate, make sure that you use the same custom certificate during BMC Helix Platform and BMC Helix IT Service Management installation.
false OPT_STORAGE_CLASS Leave it blank "" "" REPOPV_MOUNT_PATH Leave it blank "" "" MIGRATORPV_MOUNT_PATH Leave it blank "" "" ETLPV_MOUNT_PATH Leave it blank "" "" CLIENT_ROOT_CERT Leave it blank "" "" SMART_SYSTEM_USERNAME Leave it blank "" "" INGRESS_CLASS
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.
nginx
INGRESS_API_VERSION
Specify the value as
true
if your Ingress controller version is 1.2.0 or higher.true
HELM_BIN
Absolute path of the HELM binary
/usr/local/bin/helm
KUBECTL_BIN
Absolute path of the kubectl binary
/usr/bin/kubectl
OC_BIN
OC_BIN path should be set if CLUSTER_TYPE is openshift or ocp
/usr/local/sbin/oc
- The following load balancer hosts are required. You do not need any subdomains.
In the helix-on-prem-deployment-manager/configs/deployment.config file, modify the following parameters:
Parameter Name 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
When asked, enter a password of your choice for encryption or decryption.
This password is used to encrypt all passwords that you added in the commons/certs/secrets.txt file.
Important
Save this password. The deployer uses this password in all future product deployments.
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://<masternodeip>:5601/
All installation logs are located in the following directory:
helix-on-prem-deployment-manager/logs
To apply the hotfix
- Log in to the controller or bastion machine from where the Kubernetes cluster is accessible.
In the helix-on-prem-deployment-manager/configs/deployment.config file, make sure that the
INFRA
and_RSSO
parameter values are set toyes
.Important
The
INFRA
and_RSSO
parameter values must be set toyes
. All other parameters in the file must be set to valueno
.Extract the hotfix-22.2.01.001-17.tar.gz file that you downloaded from EPD by using the following command:
tar xvf hotfix-22.2.01.001-17.tar.gz
Navigate to the hotfix directory by using the following command:
cd hotfix
If you are not using BMC Helix ITSM Insights, disable the aif chart installation in this hotfix by commenting the following line in the hotfix/new-service-list.config file:
ITSMINSIGHT_SERVICES=aif-core-service,aif-ticket-service
Run the hotfix script file hf_script.sh by using the following command and pass the full path of the previous deployment manager directory.
bash hf_script.sh </path/to/directory/22.2.01>/helix-on-prem-deployment-manager
This command creates a copy of the helix-on-prem-deployment-manager directory.
For example:bash hf_script.sh /data/22.2.01/helix-on-prem-deployment-manager
This command creates a new directory named helix-on-prem-deployment-manager_HF1 at /data/22.2.01
After the hotfix script execution is complete, the Please enter password for encryption/decryption command prompt is displayed.- Enter the password.
Sample configuration files
Where to go from here
Next task | Proceed with Setting up the installation environment |
---|---|
Back to process | If you are finished setting up the installation environment, return to the appropriate installation, update, or upgrade process: |
Comments
The second line below seems very important. We should highlight it to ensure it is not missed:
In the helix-on-prem-deployment-manager/configs/deployment.config file, make sure that the INFRA and _RSSO parameter values are set to yes. All other parameters in the file must be set to value no.
Log in or register to comment.