×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')

   

This documentation supports an earlier version of BMC Helix IT Service Management on-premises deployment.

To view the documentation for the latest version, select 22.1.06 from the Product version picker.

BMC Helix IT Service Management Deployment 21.3.06 ... Installing Preparing for installation Setting up the deployment input configuration file

Inventory parameters in the deployment input configuration file


The inventory parameters in the deployment configuration file define the hosts and registry details for the Jenkins pipeline.  

Important

The customertemplate.sh file contains several parameters, however, the following table lists only those parameters that are used for deploying BMC Helix IT Service Management on-premises.

Related topics

The following table describes inventory parameters that you set in the deployment input configuration file:

Parameter nameDescriptionExample
CLUSTER_NAME

Name of the Kubernetes cluster available in the Kubernetes configuration file.


CLUSTER_NAME="bmc-k8s-cluster"
CUSTOMER_COMPANY_NAME

Customer company name.


CUSTOMER_COMPANY_NAME="Calbro Services"
DB_ADMIN_USER

Admin details to connect with the PostgreSQL database for creating users.


DB_ADMIN_USER="Demo"
DB_ADMIN_PASSWORD

Password for the admin user.


DB_ADMIN_PASSWORD="Demo123"
HELM_CHECKOUT_LOCATION

Location from where Helm charts are checked out on the HELM_NODE.



HELM_CHECKOUT_LOCATION="/jenkinsnfs/HELM_CHARTS"
HELM_NODE

Host name where HELM is installed. Typically, this is a computer where Ansible is installed.


HELM_NODE="<Host name of the Jenkins node>"
HELM_REPO

Repository URL to checkout Helm charts.


ssh://<Jenkins server host name>/home/git/GIT_REPO/HELM_REPO/containerization-certified.git
IMAGEPULLSECRETS_NAME

Kubernetes secret name for pulling images from docker registry.

Warning: Use lower case alphanumeric characters and a hyphen (-) in the secret. The secret must start and end with an alphanumeric character. For example, image-1.

For manual input file method, create the secret manually by using the below command:

kubectl create secret docker-registry <secret_name> --docker-server=<ex:containers.bmc.com> --docker-username=<ex:AWS> --docker-password='<password token>' -n <cluster namespace>



IMAGEPULLSECRETS_NAME"private_repo-1"
IMAGE_REGISTRY_USERNAME

User name to log in to BMC Docker Trusted Registry (DTR). Specify your EPD user name.

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

Password to log in to BMC DTR. Specify the BMC DTR (containers.bmc.com) token that you download from EPD.

If you use a local Harbor registry to synchronize with BMC DTR, specify the password to log in to your local registry.


IS_HELM_NODE_MASTERNODE

Location ($HOME/.kube/config) from where the Jenkins pipeline uses the Kubernetes configuration file.

Valid values:

  • (Default) true
  • false



IS_HELM_NODE_MASTERNODE="true"
JAVA_HOME

JAVA home set on the Ansible server.


JAVA_HOME="/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.262.b10-0.el7_8.x86_64/jre"
MIDTIER_INT_URL

Mid Tier integration service URL.

Syntax:

"https://${CUSTOMER_SERVICE_NAME}${ENVIRONMENT_URL}-int.${CLUSTER_DOMAIN}"


MIDTIER_URL_PORT

Mid Tier URL port.



MIDTIER_URL_PORT="443"
MIDTIER_URL_PROTOCOL

Mid Tier URL protocol.


MIDTIER_URL_PROTOCOL="https"
MIDTIER_USER_URL

Add the Mid Tier user URL to enable the WSDL.

Syntax:

"https://${CUSTOMER_SERVICE_NAME}${ENVIRONMENT_URL}.${CLUSTER_DOMAIN}"


OPENFIRE_DB_TYPE

Determines if the database type is correct.

Valid values:

  • postgres
  • mssql
  • oracle



OPENFIRE_DB_TYPE="postgres"
OPENFIRE_XMPP_DOMAIN

OpenFire XMPP domain name.



OPENFIRE_XMPP_DOMAIN="openfire"
POD_CHECKER_TIMEOUT

The maximum amount of time each pod is checked by the pipeline (300 minutes).

Default value — 300 seconds



POD_CHECKER_TIMEOUT=300
REGISTRY

Docker Container Registry.

  • If you use the BMC Docker Trusted Registry (DTR), use containers.bmc.com.
  • If you have setup the local harbor registry, describe the harbor registry hostname.



REGISTRY="DTR"
SMARTREPORTING_DATA_SOURCE_REFRESH_INTERVAL

Time interval for refresh.


SMARTREPORTING_DATA_SOURCE_REFRESH_INTERVAL="15"
STORAGE_CLASS

Define persistent volume storage.



STORAGE_CLASS=ceph


Parameters to control the product pipeline

Use the following parameters to determine which product you want to install or update in your environment. The valid values for the following parameters are true or false:

Parameter nameDescriptionExample
PLATFORM

Platform deployment controller.


PLATFORM="true"

MIDTIER

Mid Tierdeployment controller.


MIDTIER="true"

SMARTIT

BMC Helix ITSM: Smart IT deployment controller.


SMARTIT="true"

SMARTREPORTING

BMC Helix ITSM: Smart Reporting deployment controller.


SMARTREPORTING="true"

TSOMPLUGIN

BMC TrueSight Operation Management deployment controller.



TSOMPLUGIN="false"

ATRIUMWEBSERVICE

Atrium Web Service deployment controller.



ATRIUMWEBSERVICE="true"

VIRTUALCHATPLUGIN

Live Chat Plug-in deployment controller.



VIRTUALCHATPLUGIN="true"

VIRTUALCHATSERVER

Live Chat Server deployment controller.


VIRTUALCHATSERVER="true"

SCCM

SCCM deployment controller.



SCCM="false"

BCM

BMC Helix Client Management deployment controller.


BCM="false"

OPENFIRE

Openfire deployment controller.


OPENFIRE="false"


Parameters to control the database restoration


Use the following parameters to restore the database. The valid values for the following parameters are true or false:

Parameter nameDescriptionExample
AR_DB_RESTORE

Restore BMC Helix Innovation Suite database by using pipeline.



AR_DB_RESTORE="true"

LOCALES

Deploy locale packages.


LOCALES="false"

LOGS_UPLOAD_FTP

Enable log upload to an FTP.


LOGS_UPLOAD_FTP="FALSE"

PLATFORM_INT_PARALLELDEPLOYMENT_ENABLED

Launch or terminate all platform integration pods in parallel.


PLATFORM_INT_PARALLELDEPLOYMENT_ENABLED="false"

PLATFORM_SR_PARALLELDEPLOYMENT_ENABLED

Launch or terminate all BMC Helix ITSM: Smart Reporting pods in parallel.

PLATFORM_SR_PARALLELDEPLOYMENT_ENABLED="false"

SMARTREPORTING_DB_RESTORE

Restore BMC Helix ITSM: Smart Reporting database by using pipeline.

SMARTREPORTING_DB_RESTORE="true"

SMARTIT_DB_RESTORE

Restore BMC Helix ITSM: Smart Reporting database by using pipeline.

SMARTIT_DB_RESTORE="true"


Platform database service parameters for BMC Helix ITSM: Smart Reporting

Use the following parameters to set the Smart Reporting database

Parameter nameDescriptionExample
PLATFORM_SR_DB_HOSTNAME

Name of the SBMC Helix ITSM: Smart Reporting database.

PLATFORM_SR_DB_NAME="Testdata"

PLATFORM_SR_DB_PASSWORD

Password for the BMC Helix ITSM: Smart Reporting database.

PLATFORM_SR_DB_PASSWORD="Demo123"

PLATFORM_SR_DB_USER

BMC Helix ITSM: Smart Reporting database user name.

PLATFORM_SR_DB_USER="demo"


Was this page helpful? Yes No Submitting... Thank you
Last modified by Poonam Morti on Sep 25, 2023
deployment_input_configuration_file inventory_parameters jenkins_pipeline user_input

Comments

Log in or register to comment.

Setting up the deployment input configuration file
Version parameters in the deployment input configuration file
© Copyright 1991-2023 BMC Software, Inc. © Copyright 1991-2023 BladeLogic, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2023 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.