BMC Helix Innovation Suite parameters in the deployment input configuration file
BMC Helix Innovation Suite database service parameters
Use the following parameters to set the database usage options:
Parameter name | Description | Example |
---|---|---|
AR_DB_ALWAYS_ON | (Microsoft SQL) Setup the clustered database. Valid values:
| AR_DB_ALWAYS_ON="Yes" |
AR_DB_HOSTNAME | Name of the BMC Helix Innovation Suite database server. | AR_DB_HOSTNAME="dbServer" |
AR_DB_INSTANCE | BMC Helix Innovation Suite database server instance. | AR_DB_INSTANCE="" |
AR_DB_NAME | Name of the BMC Helix Innovation Suite database. | AR_DB_NAME="calbrodb" |
AR_DB_PASSWORD | Database password. | AR_DB_PASSWORD="Demo123" |
AR_DB_PORT | BMC Helix Innovation Suite database port. | AR_DB_PORT="5432" |
AR_SERVER_DB_TYPE | Select database type. Valid values:
| AR_SERVER_DB_TYPE="postgres" |
AR_DB_USER | BMC Helix Innovation Suite database user. | AR_DB_USER="demo" |
COMPACT_DEPLOYMENT_ENABLED | Determines deployment type, full deployment or compact deployment. Use a compact deployment for non-production environments. In a compact deployment, only a single platform pod platform-fts is deployed. The platform-fts pod performs all the platform roles such as platform-admin, platform-user, platform-int, and platform-sr. Valid values:
| COMPACT_DEPLOYMENT_ENABLED="true" |
PLATFORM_ADMIN_REPLICA_COUNT | Defines the number of platform admin pod to be created. | PLATFORM_ADMIN_REPLICA_COUNT="1" |
PLATFORM_COMMON_AR_HOST_ALIAS | Modify the host file in the container. Must be in a minimized JSON format, enclosed in single quotes. | PLATFORM_COMMON_AR_HOST_ALIAS=='[{"hostnames":["hostname1","hostname2"],"ip":"10.205.66.95"}]' |
PLATFORM_COMMON_AR_MON_VAR_ARDATE | Set the date and time for the AR System server. | PLATFORM_COMMON_AR_MON_VAR_ARDATE="JUN-30 2021" |
PLATFORM_COMMON_AR_MON_VAR_ARDATEONLY | Set only the date for the AR System server. | PLATFORM_COMMON_AR_MON_VAR_ARDATEONLY="JUN-30 2021" |
PLATFORM_COMMON_AR_MON_VAR_ARTIMEONLY | Set only the time for the AR System server. | PLATFORM_COMMON_AR_MON_VAR_ARTIMEONLY="13:10" |
PLATFORM_COMMON_AR_MON_VAR_TZ | Set time zone for the AR System server. | PLATFORM_COMMON_AR_MON_VAR_TZ="pdt" |
PLATFORM_COMMON_AR_MON_VAR_JAVA_TOOL_OPTIONS | Insert AR Monitor environment variables in the armonitor.conf file. | PLATFORM_COMMON_AR_MON_VAR_JAVA_TOOL_OPTIONS="" |
PLATFORM_COMMON_CACERTS_SSL_TRUSTSTORE_PASSWORD | Specify a password for your cacerts file. By default, the cacerts file password is changeit. Leave this field blank if you want to use the default password for the cacerts file. Important:
| PLATFORM_COMMON_CACERTS_SSL_TRUSTSTORE_PASSWORD='' |
BMC Helix Innovation Suite administrator service parameters | ||
PLATFORM_ADMIN_APPLY_CONFIGURATION_TEMPLATE_FORCE | Set this parameter to true If you want to use the configuration template saved on the AR System server. Valid values:
| PLATFORM_ADMIN_APPLY_CONFIGURATION_TEMPLATE_FORCE="false" |
PLATFORM_ADMIN_AR_SERVER_JAVA_OPTS | Set the minimum and maximum memory for JVM. | PLATFORM_ADMIN_AR_SERVER_JAVA_OPTS="" |
PLATFORM_ADMIN_MEMORY_LIMIT | Memory Limit for each platform admin pod. | PLATFORM_ADMIN_MEMORY_LIMIT="15Gi" |
PLATFORM_ADMIN_MEMORY_REQUEST | Memory Request for each platform admin pod. | PLATFORM_ADMIN_MEMORY_REQUEST="10Gi" |
PLATFORM_ADMIN_VOLUME_ENABLED | Set this parameter to true to mount custom certificate in the pod. Valid values:
| PLATFORM_ADMIN_VOLUME_ENABLED="true" |
PLATFORM_ADMIN_VOLUME_MOUNT_ENABLED | Set this parameter to true to mount custom certificate in the pod. Valid values:
| PLATFORM_ADMIN_VOLUME_MOUNT_ENABLED="true" |
AR connection parameters
Use the following AR connection parameters to establish a connection with an external port:
Parameter name | Description | Example |
---|---|---|
AR_PASSWORD | AR System server password. | AR_PASSWORD='Demo123' |
AR_USER | AR System server user name. | AR_USER="Demo" |
PLATFORM_ADMIN_EXTERNAL_HOST | IP address of the external load balancer. | PLATFORM_ADMIN_EXTERNAL_HOST="192.0.5.1" |
PLATFORM_ADMIN_REPLICA_COUNT | Replica count for the platform admin pod. | PLATFORM_ADMIN_REPLICA_COUNT="1" |
BMC Helix Innovation FTS service parameters
Use the following parameters to set the full-text search (FTS) service:
Parameter name | Description | Example |
---|---|---|
PLATFORM_FTS_APPLY_CONFIGURATION_TEMPLATE_FORCE | When set to true, uses the FTS configuration templates. Valid values:
| PLATFORM_FTS_APPLY_CONFIGURATION_TEMPLATE_FORCE="false" |
PLATFORM_FTS_AR_SERVER_JAVA_OPTS | Insert additional parameters for FTS AR System server JVM. | PLATFORM_FTS_AR_SERVER_JAVA_OPTS="" |
PLATFORM_FTS_CONFIGURATION_TEMPLATE_NAME | Name of the FTS configuration template. | PLATFORM_FTS_CONFIGURATION_TEMPLATE_NAME="template1" |
PLATFORM_FTS_ENABLE_SERVICES | Enable FTS services. | PLATFORM_FTS_ENABLE_SERVICES= |
PLATFORM_FTS_MEMORY_REQUEST | Memory Request for each platform FTS pod. | PLATFORM_FTS_MEMORY_REQUEST="13Gi" |
PLATFORM_FTS_MEMORY_LIMIT | Memory limit for each platform FTS pod. | PLATFORM_FTS_MEMORY_LIMIT="18Gi" |
PLATFORM_FTS_REPLICA_COUNT | Number of FTS servers. | PLATFORM_FTS_REPLICA_COUNT="1" |
PLATFORM_FTS_VOLUME_CLAIM_TEMPLATE_STORAGE_CLASS | Kubernetes storage class for platform FTS. | PLATFORM_FTS_VOLUME_CLAIM_TEMPLATE_STORAGE_CLASS="ceph-rbd-storage" |
PLATFORM_FTS_VOLUME_ENABLED | Set to true to enable custom cacerts. Valid values:
| PLATFORM_FTS_VOLUME_ENABLED="true" |
PLATFORM_FTS_VOLUME_MOUNT_ENABLED | Set to true to enable custom cacert. Valid values:
| PLATFORM_FTS_VOLUME_MOUNT_ENABLED="true" |
BMC Helix Innovation Suite integration service parameters
Use the following parameters to integrate BMC Helix Innovation Suite services:
Parameter name | Description | Example |
---|---|---|
PLATFORM_INT_APPLY_CONFIGURATION_TEMPLATE_FORCE | When set to true, uses the configuration template. Valid values:
| PLATFORM_INT_APPLY_CONFIGURATION_TEMPLATE_FORCE="false" |
PLATFORM_INT_AR_SERVER_JAVA_OPTS | Insert additional parameters to FTS AR System server JVM. | PLATFORM_INT_AR_SERVER_JAVA_OPTS="" |
PLATFORM_INT_CONFIGURATION_TEMPLATE_NAME | Name of the configuration template. | PLATFORM_INT_CONFIGURATION_TEMPLATE_NAME="template1" |
PLATFORM_INT_ENABLE_SERVICES | Enable integration services | PLATFORM_INT_ENABLE_SERVICES="true" |
PLATFORM_INT_INGRESS_ENABLED | Enable or disable Ingress creation for platform integration service. Valid values:
| PLATFORM_INT_INGRESS_ENABLED="true" |
PLATFORM_INT_INITIMAGE | Sequence the deployment process. Valid values:
| PLATFORM_INT_INITIMAGE="false" |
PLATFORM_INT_INGRESS_DOMAIN | Ingress domain name. | PLATFORM_INT_INGRESS_DOMAIN="${CLUSTER_DOMAIN}" |
PLATFORM_INT_INGRESS_HOST | Ingress host name. | PLATFORM_INT_INGRESS_HOST |
PLATFORM_INT_MEMORY_LIMIT | Integration memory limit. | PLATFORM_INT_MEMORY_LIMIT="11Gi" |
PLATFORM_INT_MEMORY_REQUEST | Request to change the memory limit. | PLATFORM_INT_MEMORY_REQUEST="9Gi" |
PLATFORM_INT_PLATFORM_EXTERNAL_IPS | Enable access to external services. Enter the external IP in JSON format. | PLATFORM_INT_PLATFORM_EXTERNAL_IPS="[10.168.0.1,10.168.0.2]" |
PLATFORM_INT_REPLICA_COUNT | Number of servers running the platform integration service. | PLATFORM_INT_REPLICA_COUNT=1 |
PLATFORM_INT_ROUTE_DOMAIN | Integration service route domain name. | PLATFORM_INT_ROUTE_DOMAIN="service.com" |
PLATFORM_INT_ROUTE_ENABLED | Enable or disable route creation for platform integration service. Valid values:
| PLATFORM_INT_ROUTE_ENABLED="false" |
PLATFORM_INT_ROUTE_HOST | Host name. | PLATFORM_INT_ROUTE_HOST="server1.calbro.com" |
PLATFORM_INT_VOLUME_ENABLED | Set to true to enable custom cacert. Valid values:
| PLATFORM_INT_VOLUME_ENABLED="true" |
PLATFORM_INT_VOLUME_MOUNT_ENABLED | Set to true to enable custom cacert. Valid values:
| PLATFORM_INT_VOLUME_MOUNT_ENABLED="true" |
AR Service password parameters
Use the following password parameters to set password for platform services:
Parameter name | Description | Example |
---|---|---|
AR_SERVER_APP_SERVICE_PASSWORD | Password to access applications. | AR_SERVER_APP_SERVICE_PASSWORD="App123" |
AR_SERVER_DSO_USER_PASSWORD | Password to access the Distributed Server Option. | AR_SERVER_DSO_USER_PASSWORD="Dso123" |
AR_SERVER_MIDTIER_SERVICE_PASSWORD | Password to access Mid Tier. | AR_SERVER_MIDTIER_SERVICE_PASSWORD="Midtier123" |
AR_LOCALE_TO_INSTALL | Defines the locale that you want to install. | AR_LOCALE_TO_INSTALL="jp" |
BAKEDUSER_HANNAH_ADMIN_PASSWORD | Password for BMC Digital Workplace administrator user hannah_admin. Specify a password that has minimum 8 characters, one upper case character, one lower case character, and one special character. | BAKEDUSER_HANNAH_ADMIN_PASSWORD="User123" |
PLATFORM_ADMIN_LICENSE_KEY | (Fresh install) Pre-generated AR System server license key. | PLATFORM_ADMIN_LICENSE_KEY="xyz23rwrw" |
PLATFORM_FTS_PLATFORM_EXTERNAL_IPS | External IP address for the platform FTS service. | PLATFORM_FTS_PLATFORM_EXTERNAL_IPS="10.168.0.1,10.168.0.2" |
Route parameters
These parameters are not used by operations in the production environment.
Parameter name | Description | Example |
---|---|---|
PLATFORM_ADMIN_ROUTE_ENABLED | (Openshift) Enable or disable creating Route directory for platform-admin service. Valid values:
| PLATFORM_ADMIN_ROUTE_ENABLED="false" |
PLATFORM_ADMIN_ROUTE_DOMAIN | Route Domain for platform admin service. | PLATFORM_ADMIN_ROUTE_DOMAIN="" |
PLATFORM_ADMIN_ROUTE_HOST | Route Host for platform admin service. | PLATFORM_ADMIN_ROUTE_HOST="server1" |
PLATFORM_SR_ROUTE_DOMAIN | Domain name for route to platform Smart Reporting service. | PLATFORM_SR_ROUTE_DOMAIN="" |
PLATFORM_SR_ROUTE_ENABLED | (Openshift) Enable or disable route creation for platform BMC Helix ITSM: Smart Reporting service. Valid values:
| PLATFORM_SR_ROUTE_ENABLED="false" |
PLATFORM_SR_ROUTE_HOST | URL for the route host. | PLATFORM_SR_ROUTE_HOST="" |
PLATFORM_USER_ROUTE_DOMAIN | Domain name for route to platform user service. | PLATFORM_USER_ROUTE_DOMAIN="" |
PLATFORM_USER_ROUTE_ENABLED | Enable or disable the route creation for platform-user service. Valid values:
| PLATFORM_USER_ROUTE_ENABLED="false" |
PLATFORM_USER_ROUTE_HOST | Host name. | PLATFORM_USER_ROUTE_HOST="Server1" |
Ingress parameters
Set up the Ingress controller for Kubernetes environment.
Parameter name | Description | Example |
---|---|---|
PLATFORM_ADMIN_INGRESS_DOMAIN | Domain name of the Ingress host. | PLATFORM_ADMIN_INGRESS_DOMAIN="server.calbro.com" |
PLATFORM_ADMIN_INGRESS_ENABLED | Enable or disable Ingress creation for platform admin services. Valid values:
| PLATFORM_ADMIN_INGRESS_ENABLED="false" |
PLATFORM_ADMIN_INGRESS_HOST | URL for the Ingress host. | PLATFORM_ADMIN_INGRESS_HOST="<CUSTOMER_SERVICE_NAME><ENVIRONMENT_URL>-adminip" |
PLATFORM_SR_INGRESS_DOMAIN | Domain name. | PLATFORM_SR_INGRESS_DOMAIN="server.calbro.com" |
PLATFORM_SR_INGRESS_ENABLED | Enable or disable Ingress creation for platform BMC Helix ITSM: Smart Reporting service. Valid values:
| PLATFORM_SR_INGRESS_ENABLED="false" |
PLATFORM_SR_INGRESS_HOST | URL for the Ingress host. | PLATFORM_SR_INGRESS_HOST="server.calbro.com" |
PLATFORM_USER_INGRESS_DOMAIN | User Ingress domain name. This can be same as the admin Ingress domain name. | PLATFORM_USER_INGRESS_DOMAIN="server.calbro.com" |
PLATFORM_USER_INGRESS_ENABLED | Enable or disable Ingress creation for platform-user service. Valid values:
| PLATFORM_USER_INGRESS_ENABLED="true" |
PLATFORM_USER_INGRESS_HOST="" | URL for the user Ingress host. | PLATFORM_ADMIN_INGRESS_HOST="<CUSTOMER_SERVICE_NAME><ENVIRONMENT_URL>-userip" |
Platform common services parameters
Use these parameters to define the common services such as, default web path, server alias for the BMC Helix Innovation Suite:
Parameter name | Description | Example |
---|---|---|
PLATFORM_COMMON_AR_SERVER_ALIAS | Define the server alias. | PLATFORM_COMMON_AR_SERVER_ALIAS="onbmc-s" |
PLATFORM_COMMON_AR_SERVER_DOMAIN | Configure the domain name. | PLATFORM_COMMON_AR_SERVER_DOMAIN="server.calbro.com" |
PLATFORM_COMMON_CMDB_REDIRECT_URL | Configure the URL for redirecting to BMC Helix CMDB. | PLATFORM_COMMON_CMDB_REDIRECT_URL= |
PLATFORM_COMMON_DEFAULT_WEB_PATH | Configure the default web path for BMC Helix Innovation Suite. | PLATFORM_COMMON_DEFAULT_WEB_PATH= |
PLATFORM_COMMON_ENABLE_TLS_INSECURE_PROTOCOLS | Set the flag to enable Transport Layer Security (TLS) insecure protocols. Valid values:
If you set the value as false, TLS 1.0 and 1.1 versions are not supported. | PLATFORM_COMMON_ENABLE_TLS_INSECURE_PROTOCOLS="false" |
Mailbox configuration parameters
Use the following parameters to configure mailbox:
Parameter name | Description | Example |
---|---|---|
SMTP_HOSTNAME | Outgoing mail server name | SMTP_HOSTNAME="somehostname" |
MAILBOX_NAME | Name for your mailbox. | MAILBOX_NAME= |
MAILBOX_PASSWORD | Password for mailbox | MAILBOX_PASSWORD="password123" |
BMC Helix Innovation Suite user service parameters
Use the following parameters to set the user services:
Parameter name | Description | Example |
---|---|---|
PLATFORM_USER_APPLY_CONFIGURATION_TEMPLATE_FORCE | When set to yes, uses the configuration template. Valid values:
| PLATFORM_USER_APPLY_CONFIGURATION_TEMPLATE_FORCE="false" |
PLATFORM_USER_AR_SERVER_JAVA_OPTS | Insert additional parameters for the INT AR System server JVM. | PLATFORM_USER_AR_SERVER_JAVA_OPTS="" |
PLATFORM_USER_CONFIGURATION_TEMPLATE_NAME | Name of the configuration template. | PLATFORM_USER_CONFIGURATION_TEMPLATE_NAME="template1" |
PLATFORM_USER_ENABLE_SERVICES | Enable services. | PLATFORM_USER_ENABLE_SERVICES |
PLATFORM_USER_INITIMAGE | Use for sequencing the deployment. Valid values:
| PLATFORM_USER_INITIMAGE="false" |
PLATFORM_USER_MEMORY_LIMIT | Memory Limit for each platform user pod. | PLATFORM_USER_MEMORY_LIMIT="14Gi" |
PLATFORM_USER_MEMORY_REQUEST | Memory Request for each platform user pod. | PLATFORM_USER_MEMORY_REQUEST="11Gi" |
PLATFORM_USER_PARALLELDEPLOYMENT_ENABLED | Enable parallel deployment. Valid values:
| PLATFORM_USER_PARALLELDEPLOYMENT_ENABLED="false" |
PLATFORM_USER_PLATFORM_EXTERNAL_IPS | Enable BMC Helix Innovation Suite to access the external environment. Enter the external IP in JSON format. | PLATFORM_USER_PLATFORM_EXTERNAL_IPS="10.168.0.1,10.168.0.2" |
PLATFORM_USER_REPLICA_COUNT | Replica count for the platform user pod. | PLATFORM_USER_REPLICA_COUNT=1 # Pod count - replicas |
PLATFORM_USER_VOLUME_ENABLED | Set to true to enable custom cacerts. Valid values:
| PLATFORM_USER_VOLUME_ENABLED="true" |
PLATFORM_USER_VOLUME_MOUNT_ENABLED | Set to true to enable custom cacerts. Valid values:
| PLATFORM_USER_VOLUME_MOUNT_ENABLED="true" |
BMC Helix ITSM: Smart Reporting service parameters
Use the following parameters to set the Smart Reporting service:
Parameter name | Description | Example |
---|---|---|
PLATFORM_SR_APPLY_CONFIGURATION_TEMPLATE_FORCE | Use the configuration template. Valid values:
| PLATFORM_SR_APPLY_CONFIGURATION_TEMPLATE_FORCE="false" |
PLATFORM_SR_AR_SERVER_JAVA_OPTS | Insert additional parameters to SR AR Server JVM. | PLATFORM_SR_AR_SERVER_JAVA_OPTS="" |
PLATFORM_SR_CONFIGURATION_TEMPLATE_NAME | Name of the configuration template | PLATFORM_SR_CONFIGURATION_TEMPLATE_NAME="template1" |
PLATFORM_SR_INITIMAGE | Define the sequence of the deployment. Valid values:
| PLATFORM_SR_INITIMAGE="false" |
PLATFORM_SR_MEMORY_LIMIT | Memory limit for each platform BMC Helix ITSM: Smart Reporting pod. | PLATFORM_SR_MEMORY_LIMIT="11Gi" |
PLATFORM_SR_REPLICA_COUNT | Replica Count for platform BMC Helix ITSM: Smart Reporting pod. | PLATFORM_SR_REPLICA_COUNT |
PLATFORM_SR_VOLUME_ENABLED | Set to true to enable custom cacerts. Valid values:
| PLATFORM_SR_VOLUME_ENABLED="false" |
PLATFORM_SR_VOLUME_MOUNT_ENABLED | Set to true to enable custom cacerts. Valid values:
| PLATFORM_SR_VOLUME_MOUNT_ENABLED="false" |
BMC Helix Innovation Suite license parameters
Use the following parameters to configure application licenses:
Parameter name | Description | Example |
---|---|---|
LICENSE_REMEDY_SERVICE_DESK_CONCURRENT_USER | Number of floating licenses for BMC Helix ITSM: Service Desk concurrent user. | LICENSE_REMEDY_SERVICE_DESK_CONCURRENT_USER |
LICENSE_REMEDY_SERVICE_DESK_USER | Number of fixed licenses for BMC Helix ITSM: Service Desk user. | LICENSE_REMEDY_SERVICE_DESK_USER |
LICENSE_REMEDY_SERVICE_MANAGEMENT_SUITE_CONCURRENT_USER | Number of floating licenses for BMC Helix Innovation Suite concurrent user. | LICENSE_REMEDY_SERVICE_MANAGEMENT_SUITE_CONCURRENT_USER |
LICENSE_REMEDY_SERVICE_MANAGEMENT_SUITE_USER | Number of fixed licenses for BMC Helix ITSM Suite user. | LICENSE_REMEDY_SERVICE_MANAGEMENT_SUITE_USER |
LICENSE_REMEDY_SERVICE_OPTIMIZATION_CONCURRENT_USER | Number of floating licenses for service optimization concurrent user. | LICENSE_REMEDY_SERVICE_OPTIMIZATION_CONCURRENT_USER |
LICENSE_REMEDY_SERVICE_OPTIMIZATION_USER | Number of fixed licenses for service optimization user. | LICENSE_REMEDY_SERVICE_OPTIMIZATION_USER |
BMC Helix Innovation Suite tenant parameters
Use the following parameters to configure a tenant:
Parameter name | Description | Example |
---|---|---|
HELIX_PLATFORM_NAMED_LIC | Number of Helix platform users. | HELIX_PLATFORM_NAMED_LIC=100 |
PLATFORM_TENANT_CREATE | Determines whether to create tenants. Valid values:
| PLATFORM_TENANT_CREATE="true" |
TENANT_DOMAIN | Tenant domain. | TENANT_DOMAIN="petramco.com" |
TENANT_ID | Tenant identifier. | TENANT_ID="Petramco" |
TENANT_HOST_NAME | Fully qualified host name used in BMC Helix Innovation Suite URL. | TENANT_HOST_NAME="petramco1-is.onbmc.com" |
TENANT_NAME | Tenant name. | TENANT_NAME="Petramco" |
BMC Helix Innovation Suite Web API parameters
Use the following parameters to use WEB API:
Parameter name | Description | Example |
---|---|---|
WEBAPI_CONN_CREATE | Web API connection name. The name must be unique. Valid values:
| WEBAPI_CONN_CREATE="true" |
WEBAPI_HOST_NAME | Web API host name. | WEBAPI_HOST_NAME |
WEBAPI_PORT | Port where Web API are configured. | WEBAPI_PORT="443" |