Performing the installation
Install BMC Helix IT Service Management platform and applications by using the HELIX_ONPREM_DEPLOYMENT Jenkins pipeline. The HELIX_ONPREM_DEPLOYMENT Jenkins pipeline runs various deployment pipelines, in a sequence, and configures the BMC Helix Innovation Suite platform and service management applications.
The following image describes the actions to perform the installation:
Components deployed through pipelines
The following table lists the BMC Helix IT Service Management platform components and service management applications deployed through pipelines:
Pipeline | Pod name | Components deployed through the pipeline |
---|---|---|
HELIX_PLATFORM_DEPLOY |
Important: The platform-sr, platform-int, and platform-user pods are not deployed with the compact deployment size. |
|
| Mid Tier components:
| |
atriumwebsvc |
| |
HELIX_NONPLATFORM_DEPLOY |
| BMC Helix ITSM: Smart IT |
openfire | Openfire | |
| BMC Live Chat | |
| BMC Digital Workplace | |
catalog-itsm-plugin | BMC Digital Workplace Catalog and BMC Helix ITSM integration plug-in | |
These applications are deployed as smart bundles on the platform pod. | BMC Digital Workplace Catalog | |
BMC Helix Business Workflows | ||
BMC Helix Multi-Cloud Broker | ||
BMC Helix ITSM Insights | ||
HELIX_INTEROPS_DEPLOY | NA | Activates BMC Helix ITSM Insights and BMC Helix Innovation Suite services for the BMC Helix Platform tenant so that the services can be used through BMC Helix Portal. |
HELIX_SMARTREPORTING_DEPLOY | smartreporting | BMC Helix ITSM: Smart Reporting console Important:
|
SUPPORT_ASSISTANT_TOOL | assisttool-dep | Support Assistant tool |
Before you begin
If you have not already made the environment ready for the installation, perform the following preinstallation tasks:
- Download the installation files and access the container images.
- Set up the BMC Deployment Engine.
- Prepare your database.
- Set up the installation environment.
- Configure BMC Helix Single Sign-On and created BMC Helix Single Sign-On realm.
- Install Java 11 or later for AR System clients, such as Developer Studio, Atrium Integrator, and Kaazing.
- If you are installing BMC Helix IT Service Management in an OpenShift cluster, perform the steps given in the topic Preparing to install in an OpenShift cluster before you run the installation.
To install BMC Helix Innovation Suite platform and applications
Run the HELIX_ONPREM_DEPLOYMENT pipeline by performing the following steps:
Log in to your Jenkins server by using the following URL:
http://<Jenkins server host name>:8080Select the HELIX_ONPREM_DEPLOYMENT pipeline, and click Build with Parameters.
In the INFRASTRUCTURE section, specify the following parameters:
Parameter Description HELM_BINARY Name of the Helm binary that you have installed.
For example: helm
To find Helm binary name, run the command on the Jenkins server:
# which helm
Example output of the command is as follows:
/usr/local/bin/helm
In this output, helm is the Helm binary name.
AGENT Jenkins agent to run the pipeline. Select the agent added by the agent-add-pipeline.
For example: root-<Jenkins server host name>.
CHECKOUT_USING_USER Jenkins credential ID that contains the Git credentials. Specify the value as github.
KUBECONFIG_CREDENTIAL Jenkins credential ID that contains the kubeconfig file for the target Kubernetes cluster. To find the kubeconfig credential ID, go to http://<jenkinsurl>:8080/credentials.
The default value is kubeconfig.
In the CODE section, specify the following parameters:
Parameter Description LOCAL_GIT Local Git repositories.
Important: You must select this option.
GIT_USER_HOME_DIR Git user home directory.
For example: /home/git
DEVOPS_REPO Git repository for the HELIX_ONPREM_DEPLOYMENT pipeline.
For example: ssh://<Jenkins server host name>/home/git/Git_Repo/ITSM_REPO/itsm-on-premise-installer.git
CUSTOMER_CONFIGS GitHub repository to read database and BMC Helix Single Sign-On parameters and check in the input config file.
For example: ssh://<Jenkins server host name>/home/git/Git_Repo/CUSTOMER_CONFIGS/onprem-remedyserver-config.git
PLAYBOOKS_REPO Git repository for the platform and smart applications pipelines.
For example: ssh://<Jenkins server host name>/home/git/Git_Repo/PLAYBOOKS_REPO/helix-deploy-playbooks.git
HELM_REPO Repository URL to check out Helm charts.
For example: ssh://<Jenkins server host name>/home/git/GIT_REPO/HELM_REPO/containerization-certified.git
SMARTREPORTING_PLAYBOOKS_REPO Git repository for the Smart Reporting application pipeline.
For example: ssh://<Jenkins server host name>/home/git/Git_Repo/SMARTREPORTING_PLAYBOOKS_REPO/smartreporting-deploy-playbooks.git
Important: Specify the parameter value if you want to install Smart Reporting.
SMARTREPORTING_HELM_REPO Repository URL to check out Helm charts for Smart Reporting application.
For example: ssh://<Jenkins server host name>/home/git/GIT_REPO/SMARTREPORTING_HELM_REPO/smartreporting-containerization-certified.git
Important: Specify the parameter value if you want to install Smart Reporting.
SMARTAPPS_HELM_REPO Repository URL to check out Helm charts for applications.
For example: ssh://<Jenkins server host name>/home/git/GIT_REPO/SMARTAPPS_HELM_REPO/containerization-smartapps-certified.git
In the CUSTOMER-INFO section, specify the following parameters:
Parameter Description Select this check box your Kubernetes or Openshift cluster is in a cloud environment such as Amazon Web Services
Select this option to configure the following service types as LoadBalancer and creates an external load balancer in the cloud:
- platform-admin-ext
- platform-int-ext
- platform-user-ext
ROUTE_ENABLED Do not select this check box. ROUTE_TLS_ENABLED Do not select this check box. OS_RESTRICTED_SCC Do not select this check box. Specify the value as FRESH to perform a fresh installation of BMC Helix Innovation Suite.
CLUSTER Specify the name of your Kubernetes cluster.
Find the cluster from the kubeconfig file. The current-context value in the kubeconfig file is the cluster name.
For example: dev-k8s-cluster
apiVersion: v1 clusters: - cluster: server: https://<local host>/k8s/clusters/c-rxcc6 current-context: dev-k8s-cluster
CUSTOMER_NAME Specify the customer's full name.
For example: ABC Jenkins Limited.
IS_NAMESPACE Specify the namespace where you want to install BMC Helix Innovation Suite.
CUSTOMER_SERVICE and ENVIRONMENT Specify values of your service and environment.
The pipeline generates URLs in a specific format based on the inputs provided in the CUSTOMER_SERVICE, ENVIRONMENT, and CLUSTER_DOMAIN parameters.For example: If CUSTOMER_SERVICE=itsm, ENVIRONMENT=poc, and CLUSTER_DOMAIN=aus-ranch.bmc.com, the following URLs are be generated for different applications:
- Mid Tier—itsm-poc.aus-ranch.bmc.com
- Smart IT—itsm-poc-smartit.aus-ranch.bmc.com
- Smart Reporting—itsm-poc-sr.aus-ranch.bmc.com
- Innovation Studio—itsm-poc-is.aus-ranch.bmc.com
- Innovation Suite REST API or CMDB—itsm-poc-restapi.aus-ranch.bmc.com
- Atrium Web Services—itsm-poc-atws.aus-ranch.bmc.com
- Digital Workplace—itsm-poc-dwp.aus-ranch.bmc.com
- Digital Workplace Catalog—itsm-poc-dwpcatalog.aus-ranch.bmc.com
- Live Chat—itsm-poc-vchat.aus-ranch.bmc.com
- Openfire Chat—itsm-poc-chat.aus-ranch.bmc.com
- Support Assistant tool—itsm-poc-supportassisttool.aus-ranch.bmc.com
The platform and application URLs support only the HTTPS protocol.Important: When the ENVIRONMENT value is prod for production environments, the URLs are generated by excluding -<ENVIRONMENT> value.For example, the URL format for Mid Tier production environment is itsm.aus-ranch.bmc.com
The URL format for Smart IT production environment is itsm-smartit.aus-ranch.bmc.com
INGRESS_CLASS Specify the Ingress class name of the NGINX Ingress Controller that you used while installing BMC Helix Platform.
The default value is nginx.
CLUSTER_DOMAIN Specify the domain name of the cluster that you want to use. INPUT_CONFIG_METHOD Specify the deployment input configuration file, which helps you manage the inputs required for the installation. Select any of the following actions: - (Recommended) Generate_Input_File—Select this option to automatically generate the deployment input configuration file. The file is generated based on the parameter values that you provide in the PRODUCTS, OTHER_INPUT_PARAMS, and DATABASE_REGISTRY_STORAGE_PASSWORDS_SECRETS_DETAILS sections.
- Manual_Input_File—Select this option to upload your input configuration file manually.
Use the Manual_Input_File option only if you are familiar with the parameters in the input configuration file. The input configuration file consists of parameters with default values. You must update the values based on your installation environment.
INPUT_CONFIG_FILE If you select the Manual_Input_File option in the INPUT_CONFIG_METHOD parameter, click Browse and upload the deployment input configuration file.
Learn about how to manually provide inputs for the input configuration file and set up the file at Setting up the deployment input configuration file.
Important: If you select the Manual_Input_File option, you must provide the values for the parameters in the INFRASTRUCTURE, CODE, CUSTOMER-INFO,
and PRODUCT-DEPLOY section.Do not provide the values for the parameters in the PRODUCTS, OTHER_INPUT_PARAMS, DATABASE_REGISTRY_STORAGE_PASSWORDS_SECRETS_DETAILS, and RSSO_PARAMETERS sections.
CACERTS_FILE Click Browse and upload your custom cacerts file.
Important: Use this optional parameter when you want to use a custom cacerts file to authenticate communication between BMC Helix Innovation Suite platform and application components and third-party services.
For information about creating a custom cacerts file and ways to apply a custom cacerts file, see Applying security certificates to your applications.
CUSTOMER_SIZE Specify the deployment size such as, compact, small, medium, or large. Enter the value as C, S, M, or L.
SOURCE_VERSION Specify NA for the source version of the Helm repositories. PLATFORM_HELM_VERSION Specify 2021305.1.05.00 for the target version of the Helm repositories. SMARTREPORTING_SOURCE_VERSION Specify NA for the Smart Reporting application version of the Helm repositories.
SMARTAPPS_HELM_VERSION Specify 2021305.1.05.00 for the smart applications version of the Helm repositories.
HELM_NODE Specify the host name of the system where you have installed HELM. SERVICE_MODE Leave this option unselected to perform a fresh installation. Parameter Description Select this check box to install BMC Live Chat.
HELIX_OPENFIRE Select this check box to install Openfire. HELIX_DWP Select this check box to install BMC Digital Workplace.
HELIX_DWPA Select this check box to install BMC Digital Workplace Catalog.
HELIX_BWF Select this check box to install BMC Helix Business Workflows.
HELIX_MCSM Select this check box to install BMC Helix Multi-Cloud Broker.
HELIX_ITSM_INSIGHTS
Select this check box to install BMC Helix ITSM Insights.
HELIX_TSOMPLUGIN
Select this check box to install TrueSight Operations Management plug-ins.
Parameter Description SUPPORT_ASSISTANT_TOOL Select this parameter to install Support Assistant tool user interface.
Important: Make sure that you select the SUPPORT_ASSISTANT_TOOL and SIDECAR_SUPPORT_ASSISTANT_FPACK parameters to install Support Assistant tool.
SIDECAR_SUPPORT_ASSISTANT_FPACK Select this parameter to install Support Assistant tool.
Support Assistant tool is deployed as a sidecar container and runs as a non-root user. Support Assistant tool deployment requires namespace level permissions.
Important: Make sure that you select the SUPPORT_ASSISTANT_TOOL and SIDECAR_SUPPORT_ASSISTANT_FPACK parameters to install Support Assistant tool.
SUPPORT_ASSISTANT_CREATE_ROLE Select this check box to use a default role when installing the Support Assistant tool.
If you want to use a custom role for the Support Assistant tool installation, clear this check box and confirm the following actions:
In your BMC Helix Innovation Suite namespace, make sure that you have created a role and the role has the following rules:
rules: - apiGroups: [""] resources: ["pods"] verbs: ["get", "watch", "list"]
- Make sure that you specify the appropriate service account in the SUPPORT_ASSISTANT_SERVICE_ACCOUNT parameter.
SUPPORT_ASSISTANT_SERVICE_ACCOUNT Specify the value as default so that the default service account is used during the Support Assistant tool installation.
If you want to use a custom role for the Support Assistant tool installation, specify the service account name that is available in your BMC Helix Innovation Suite namespace. Make sure that the custom role is assigned to the service account by using the role binding permission.
SIDECAR_FLUENTBIT Select this parameter to install Fluent Bit, which is used to collect pods and cluster logs and send that to a central location.Fluent Bit is deployed as a sidecar container and runs as a non-root user.In the PRODUCT-DEPLOY section, specify the following parameters:
Parameter Description HELIX_GENERATE_CONFIG Select this check box to generate the deployment input configuration file automatically. HELIX_PLATFORM_DEPLOY Select this check box to install the platform components, such as Mid Tier and BMC Helix CMDB.
HELIX_SMARTREPORTING_DEPLOY Select this check box to install BMC Helix ITSM: Smart Reporting.
HELIX_NONPLATFORM_DEPLOY Select this check box to install BMC Helix ITSM: Smart IT and BMC Live Chat.
HELIX_CONFIGURE_ITSM Select this check box to update the hannah_admin user password in the CTM: People form with the value that you provide in the BAKEDUSER_HANNAH_ADMIN_PASSWORD parameter in the DATABASE_REGISTRY_STORAGE_PASSWORDS_SECRETS_DETAILS section.
Important: You must select this check box for successful installation of the smart applications.
HELIX_SMARTAPPS_DEPLOY Select this check box to install applications, BMC Helix ITSM, BMC Helix Digital Workplace Catalog, BMC Helix Digital Workplace, BMC Helix Business Workflows, BMC Helix Multi-Cloud Broker, and BMC Helix ITSM Insights.
HELIX_INTEROPS_DEPLOY Select this check box to activate services such as BMC Helix ITSM Insights, BMC Helix ITSM: Smart IT, BMC Helix Digital Workplace, BMC Helix Digital Workplace Catalog, and BMC Helix Business Workflows for the BMC Helix Platform users.
HELIX_POST_DEPLOY_CONFIG Select this check box to delete the Demo user.
The Demo user is deleted when you select this option and run the HELIX_ONPREM_DEPLOYMENT pipeline post-installation of BMC Helix Innovation Suite.
Important: Do not select this parameter while installing the platform and applications.
HELIX_DR Do not select this option.
SCALE_DOWN Do not select this option.
In the DATABASE_REGISTRY_STORAGE_PASSWORDS_SECRETS_DETAILS section, specify the following parameters:
Parameter Description AR_ADMIN_USER Do not specify any value in this field for fresh installation.
This field is used in the update deployment mode.
AR_ADMIN_PASSWORD Do not specify any value in this field for fresh installation.
This field is used in the update deployment mode.
REGISTRY_TYPE
Select the DTR option. HARBOR_REGISTRY_HOST Specify the host name of BMC Docker Trusted Registry (DTR) containers.bmc.com
If you use a local Harbor registry to synchronize with BMC DTR, specify the host name of your local registry.
IMAGE_REGISTRY_USERNAME Specify the user name to log in to BMC 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 Specify the 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.
To update the password, click Change Password.DB_TYPE Select the database type that you want to use: - mssql
- postgres
- oracle
DB_PORT Specify the database port value. ORACLE_SERVICE_NAME Specify the Oracle service name to use an Oracle database. DATABASE_HOST_NAME Specify the host name of the database server. DATABASE_ADMIN_USER User name to log in to the database.
If you select the DB_TYPE value as mssql or oracle, you can leave this field blank.
Important: For PostgreSQL database, if you use a user other than the postgres user, make sure that you create a database with the same name as that of the user.
DATABASE_ADMIN_PASSWORD Specify the password to log in to the database.
If you select the DB_TYPE value as mssql or oracle, you can leave this field blank.
To update the password, click Change Password.
IS_DATABASE_ALWAYS_ON Select this check box if your Microsoft SQL database is in a high availability cluster. LOGS_ELASTICSEARCH_HOSTNAME Specify the Elasticsearch service name that is running on the BMC Helix Logging namespace.
FTS_ELASTICSEARCH_HOSTNAME
Specify the external IP address that you created for FTS_ELASTICSEARCH or an internal cluster IP that is accessible for the namespace where you install BMC Helix IT Service Management.
For more information about external IP for FTS_ELASTICSEARCH, see Setting up the installation environment.
FTS_ELASTICSEARCH_PORT
Specify the port of Elasticsearch FTS instance. The port number is 9200. FTS_ELASTICSEARCH_USERNAME
Specify the user name of Elasticsearch FTS instance.
The default user name is admin.
Important: Do not change the user name.
FTS_ELASTICSEARCH_USER_PASSWORD
Specify the password for the user of Elasticsearch FTS instance.
The default password is admin.
Important: Do not change the password.
FTS_ELASTICSEARCH_SECURE
Select this check box if Secure Socket Layer (SSL) is enabled in your environment.
AR_LOCALE_TO_INSTALL Specify the locale to install the Action Request System.
For example: fr
Supported locales are fr, de, it, es, ja, ko, zh_CN, pt_BR, he, ru, and pl. English locale is installed by default.
Important: If you specify more locales to install, the installation time increases. It take approximately 2 hours to install one locale.
IMAGESECRET_NAME Specify the name used to create Kubernetes image registry secret.
Important: 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.
BAKEDUSER_HANNAH_ADMIN_PASSWORD Specify the password for BMC Helix Digital Workplace administrator user hannah_admin.
Specify a password that has minimum 8 characters, including one upper case character, one lower case character, and one special character.
To update the password, click Change Password.
AR_DB_NAME Specify the name of the BMC Helix Innovation Suite database.
Important:
- If you are using an Oracle database, specify the Oracle service name as the parameter value. Specify the same value as that of the ORACLE_SERVICE_NAME value.
- Make sure that you the database name starts with a character. You can specify numbers and only the following special characters in the name:
- Dollar $
- Hash #
- Underscore _
AR_DB_USER Specify the BMC Helix Innovation Suite database user.
Important: Make sure that you the database user name starts with a character. You can specify numbers and only the following special characters in the name:
- Dollar $
- Hash #
- Underscore _
AR_DB_PASSWORD Specify the password for BMC Helix Innovation Suite user.
To update the password, click Change Password.
AR_SERVER_APP_SERVICE_PASSWORD Specify the password to access applications.
To update the password, click Change Password.
Important: The maximum password limit is 19 characters.
AR_SERVER_DSO_USER_PASSWORD Specify the password to access the Distributed Server Option.
To update the password, click Change Password.
Important: The maximum password limit is 20 characters.
AR_SERVER_MIDTIER_SERVICE_PASSWORD Specify the password to access the Mid Tier.
To update the password, click Change Password.
Important: The maximum password limit is 20 characters.
SMARTREPORTING_DB_NAME Specify the name of the BMC Helix ITSM: Smart Reporting database.
Important: Make sure that you the database name starts with a character. You can specify numbers and only the following special characters in the name:
- Dollar $
- Hash #
- Underscore _
SMARTREPORTING_DB_USER Specify the BMC Helix ITSM: Smart Reporting database user.
Important: Make sure that you the database user name starts with a character. You can specify numbers and only the following special characters in the name:
- Dollar $
- Hash #
- Underscore _
SMARTREPORTING_DB_PASSWORD Specify the password for the BMC Helix ITSM: Smart Reporting user.
VC_RKM_USER_NAME Specify the user name for BMC Helix Virtual Agent.
VC_RKM_PASSWORD Specify the password for the BMC Helix Virtual Agent user.
To update the password, click Change Password.
VC_PROXY_USER_LOGIN_NAME Specify the proxy user login name for BMC Helix Virtual Agent.
VC_PROXY_USER_PASSWORD Specify the password for the BMC Helix Virtual Agentproxy user.
To update the password, click Change Password.
DWP_CONFIG_PRIMARY_ORG_NAME Specify the organization name for BMC Helix Digital Workplace.
For example: Petramco
DWP_CONFIG_SUBTENANT_USER_PASSWORD Specify the password for the BMC Helix Digital Workplace user.
AR_SERVER_ALIAS Specify the alias name of AR System server.
Important: Make sure that you specify the value for this parameter.
PLATFORM_ADMIN_PLATFORM_EXTERNAL_IPS Specify the external IP address to enable external access.
The external IP must be in JSON list format within square brackets. Multiple values must be separated by a comma with no space after the comma.
Example: [10.168.xx.xx,10.168.xx.xx]
Important: Make sure that you specify the value for this parameter your Kubernetes or Openshift cluster is not in a cloud environment
In the RSSO_PARAMETERS section, specify the following parameters:
Parameter Description RSSO_URL BMC Helix Single Sign-On URL that you used during the BMC Helix Platform services deployment.
For example, specify https://<LB_HOST>/rsso
LB_HOST is the load balancer host name that you used in the infra.config file during the BMC Helix Platform services deployment.
Important: Make sure that you do not specify a forward slash ( / ) at the end of the URL.
RSSO_ADMIN_USER
Administrator user name to login to BMC Helix Single Sign-On by using the RSSO_URL.
RSSO_ADMIN_PASSWORD Password to login to BMC Helix Single Sign-On by using the RSSO_URL.
TENANT_DOMAIN Value of the Tenant parameter that you specified while configuring the BMC Helix Single Sign-On realm.
In the ITSM_INTEROPS_PARAMETERS section, specify the following parameters:
Parameter Description HELIX_PLATFORM_DOMAIN Domain name of the cluster where BMC Helix Platform is installed. HELIX_PLATFORM_CLUSTER Cluster name where BMC Helix Platform is installed. HELIX_PLATFORM_NAMESPACE Namespace where BMC Helix Platform is installed. HELIX_PLATFORM_KUBECONFIG_CREDENTIAL Jenkins credential ID that contains the kubeconfig file for the Kubernetes cluster where BMC Helix Platform is installed.
If you have installed BMC Helix Platform on one cluster and you are installing BMC Helix IT Service Management on another cluster, add BMC Helix Platform cluster kubeconfig file as a credential in your Jenkins server.
Learn about configuring a kubeconfig file at Setting up BMC Deployment Engine.
HELIX_PLATFORM_CUSTOMER_NAME Registered tenant name in BMC Helix Platform. ITSM_USER User name to log in to BMC Helix ITSM.
Use the hannah_admin user.
ITSM_Password Password for BMC Helix ITSM user.
Use the BAKEDUSER_HANNAH_ADMIN_PASSWORD parameter value.
In the Select the services for interoperability configuration section, select the services that you want to enable for the tenant that was created during the BMC Helix Platform installation.
Parameter Description BMC_HELIX_ITSM_Insights Select this check box to enable BMC Helix ITSM Insights.
BMC_HELIX_SMART_IT Select this check box to enable BMC Helix ITSM: Smart IT.
BMC_HELIX_BWF Select this check box to enable BMC Helix Business Workflows.
Select this check box to enable BMC Helix Digital Workplace.
BMC_HELIX_INNOVATION_STUDIO Select this check box to enable BMC Helix Innovation Studio. BMC_HELIX_DWPA Select this check box to enable BMC Helix Digital Workplace Catalog.
Click Build.
The HELIX_ONPREM_DEPLOYMENT pipeline installs the platform and applications. After the BMC Helix IT Service Management installation is complete, you must apply application licenses within three days.To perform the post-installation configurations, rebuild the HELIX_ONPREM_DEPLOYMENT pipeline by selecting the HELIX_POST_DEPLOY_CONFIG check box in the PRODUCT-DEPLOY section.
Important
Make sure that you perform this step after the successful installation of BMC Helix IT Service Management because it deletes the Demo user that is used for installation.
To address a failed pipeline execution
If you encounter an error related to signatures, and the HELIX_ONPREM_DEPLOYMENT pipeline execution fails, you must approve the signature.
The following image shows an example error:
To approve a signature, perform the following steps:
- In the HELIX_ONPREM_DEPLOYMENT pipeline Console Output, in the logs, click Administrators can decide whether to approve or reject this signature.
You are redirected to http://<jenkins_host:port>/scriptApproval/. - Approve the signature.
- Rebuild the HELIX_ONPREM_DEPLOYMENT pipeline.
To install AR System clients
- In your local system, unzip the AR System clients installer ARSuiteKitDeveloperWindows21.3.02.zip file.
Navigate to the Disk 1 folder and run the setup.exe file.
- On the Introduction page, click Next.
On the License Agreement page, review the license agreement, click I agree to the terms of license agreement, and then click Next.
- On the User Inputs page, in the Destination Directory field, specify the directory in which you want to install the AR System clients, and click Next.
The default location is C:\Program Files\BMC Software\ARSystem - In the 64-bit JAVA Path field, specify the JRE path, and click Next.
- In the Workspace field, specify the the directory in which you want to install Developer Studio, and click Next.
The default location is C:\Users\Administrator\DeveloperStudio - In the field, Data Import Tool field, specify the location where you want to install Data Import Tool, and click Next.
The default location is C:\Users\Administrator\DataImportTool - Click Install.
The AR System clients are installed. - (Optional) To review the installer log for any errors, click View Log.
The install logs are available at the C:\Users\Administrator\AppData\Local\Temp\arsystem_install_log.txt location.
After you have analyzed the logs, close the log. - To exit the AR System clients installer, click Done.
To perform post-installation checks
Verify the platform and application components pod are running by using the following command:
kubectl get pod -n <namespace>
The following image shows an example:
Verify that the you can access the platform and application components by using the following URLs:
Application URL Mid Tier
https://<midtier-user ingress name>/arsys
Use the hannah_admin user credentials to login.
BMC Helix Innovation Studio
https://<platform-user ingress name>/innovationstudio/index.html
Use the hannah_admin user credentials to login.
BMC Helix CMDB
https://<platform-cmdbapi>/cmdb/index.html
Use the hannah_admin user credentials to login.
BMC Helix ITSM: Smart IT
https://<smartit ingress name>
To access
BMC Helix ITSM: Smart IT, you must set up a user with specific a Smart IT role.
Learn about Smart IT roles and adding a user at Smart IT roles and permissions
and Adding people without using templates
.
BMC Helix ITSM: Smart Reporting
https://<smartreporting ingress name>
Use the siadmin user credentials to login.
BMC Digital Workplace Catalog
https://<catalog ingress name>/dwpc/index.html
Use the hannah_admin user credentials to login.
BMC Digital Workplace
https://<dwp-default-ingress ingress name>
Use the hannah_admin user credentials to login.
BMC Live Chat
https://<virtualchatserver ingress name>
Use the admin user credentials to login.
Openfire
https://<openfire ingress name>
Use the admin user credentials to login.
Support Assistant tool
https://<supportassisttool ingress name>
Use the following default local user credentials:
User name—admin
Password—satAdmin1#
Important: When you login for the first time, the change password field is displayed in the login dialog box. Make sure that you change the login credentials.
To find the ingress names, in your Jenkins server, run the following command:
kubectl get ing -n <namespace>
The following image shows an example output of the command:
For example: URL to access Mid Tier is https://rtm-dev.aus-ranch.bmc.com/arsys.
Important
If your database IP or DNS address changes post-installation of BMC Helix IT Service Management, to update the database details, see the knowledge article
How to change Database IP / DNS post-installation
.
To install additional locales
After you perform a fresh installation of BMC Helix IT Service Management, if you want to install additional locales, perform the following steps:
- In the HELIX_ONPREM_DEPLOYMENT pipeline, in the Build History section, select the last job, and click Rebuild.
- In the CUSTOMER-INFO section, select the SERVICE_MODE check box.
- In the PRODUCT-DEPLOY section, select the HELIX_GENERATE_CONFIG, HELIX_PLATFORM_DEPLOY, HELIX_NONPLATFORM_DEPLOY, HELIX_SMARTAPPS_DEPLOY option.
- In the DATABASE_REGISTRY_STORAGE_PASSWORDS_SECRETS_DETAILS section, in the AR_LOCALE_TO_INSTALL parameter, add the additional locales that you want to install.
- Build the HELIX_ONPREM_DEPLOYMENT pipeline by using the Rebuild option.
To install additional products
After you perform a fresh installation of BMC Helix IT Service Management, if you want to install additional products later, perform the following steps:
- In the HELIX_ONPREM_DEPLOYMENT pipeline, in the Build History section, select the last job, and click Rebuild.
- In the CUSTOMER-INFO section, select the SERVICE_MODE check box.
- In the PRODUCTS section, select the additional products that you want to install.
For example, to install BMC Helix Business Workflows , select the HELIX_BWF option. - In the PRODUCT-DEPLOY section, select the HELIX_GENERATE_CONFIG, HELIX_PLATFORM_DEPLOY, HELIX_NONPLATFORM_DEPLOY, HELIX_SMARTAPPS_DEPLOY option.
- Build the HELIX_ONPREM_DEPLOYMENT pipeline by using the Rebuild option.
To scale down ITSM Insights services
If you select ITSM Insights during BMC Helix Platform services installation and you do not want to use the ITSM Insights services, scale down the services to save the resource utilization. To scale down the services, perform the following steps:
In the namespace where you install BMC Helix Platform services, run the following command:
kubectl get deployment -n <BMC Helix Platform namespace> | grep aif
Sample output:
aif-api-service 1/1 1 1 23d aif-clustering-ingestion-service 1/1 1 1 23d aif-clustering-query-service 1/1 1 1 23d aif-clustering-service 1/1 1 1 23d aif-core-service 1/1 1 1 23d aif-incident-ingestion-service 1/1 1 1 23d aif-job-manager-service 1/1 1 1 23d aif-machine-learning-utilities 1/1 1 1 23d aif-ticket-service 1/1 1 1 23d
Run the following command:
kubectl get deployment -n <BMC Helix Platform namespace> | grep victoria
Sample output:
victoria-metrics-cluster-vminsert 3/3 3 3 16d victoria-metrics-cluster-vmselect 3/3 3 3 16d
Run the following command:
kubectl get sts -n <BMC Helix Platform namespace> | grep victoria
Sample output:
victoria-metrics-cluster-vmstorage 3/3 16d
Scale down the services listed in steps 1, 2, and 3 to zero replicas.
For example, to scale down the aif-api-service and victoria-metrics-cluster-vmstorage services, run the following commands:kubectl scale deployment aif-api-service -n <BMC Helix Platform namespace> --replicas=0 kubectl scale sts victoria-metrics-cluster-vmstorage -n <BMC Helix Platform namespace> --replicas=0
Comments
What does the TENANT_DOMAIN refer to exactly?
Hi Ariel,
In the TENANT_DOMAIN parameter enter the Tenant parameter value that you specified while configuring the BMC Helix Single Sign-On realm. See Setting up the installation environment.
Thanks,
Poonam
Log in or register to comment.