Performing the BMC Helix Smart Reporting installation

Before you begin

Make sure that you perform the following preinstallation tasks before you start the installation:

• Download the Smart Reporting installation files.
  See Downloading-the-installation-files.
• Access the Smart Reporting container images.
  See Accessing-container-images and Setting-up-a-Harbor-repository-to-synchronize-container-images.
• Install BMC Helix Service Management.
  See Performing-the-BMC-Helix-Service-Management-installation.

Task 1: To update the Git repositories and add deployment pipelines

1. Log in to the BMC Deployment Engine as a Git user.
2. In your local Git repository, copy the SMARTREPORTING_REPO, SMARTREPORTING_PLAYBOOKS_REPO and SMARTREPORTING_HELM_REPO repositories that you downloaded from EPD.
   For example, copy the files to the local Git repository located at ssh://<Jenkins server host name>/home/git/Git_Repo.
3. Add the following installation pipelines by using the following steps:

   Pipeline	Repository URL	Branches to build	Script path
   HELIX_SMARTREPORTING	ssh://git@<jenkins_server>/GIT_REPO_DIR/SMARTREPORTING_REPO/itsm-on-premise-sr.git	*/master	pipeline/jenkinsfile/HELIX_SMARTREPORTING.jenkinsfile
   HELIX_SMARTREPORTING_DEPLOY	ssh://git@<jenkins_server>/GIT_REPO_DIR/SMARTREPORTING_REPO/itsm-on-premise-sr.git	*/master	pipeline/jenkinsfile/HELIX_SMARTREPORTING_DEPLOY.jenkinsfile
   HELIX_SMARTREPORTING_UPGRADE	ssh://git@<jenkins_server>/GIT_REPO_DIR/SMARTREPORTING_REPO/itsm-on-premise-sr.git	*/master	pipeline/jenkinsfile/HELIX_SMARTREPORTING_UPGRADE.jenkinsfile

   1. Log in to the Jenkins server by using the following URL:
      http://<Jenkins server host name>:8080
   2. On the Jenkins home page, click New Item.
   3. In the Enter an item name field, enter the pipeline name.
      Example: HELIX_SMARTREPORTING.
   4. Select Pipeline and click OK.
   5. Click the Pipeline tab.

   6. Enter the following information:

      Field	Description
      Definition	From the Definition list, select Pipeline script from SCM.
      SCM	From the SCM list, select Git.
      Repository URL	Enter the Repository URL as the path of your local Git repository in the format ssh://git@<jenkins_server>/<path to itsm-on-premise-sr.git>. Example: ssh://git@<Jenkins server host name>/home/git/git_repo/SMARTREPORTING_REPO/itsm-on-premise-sr.git
      Credentials	Enter the Git server credentials.
      Additional Behaviours	Specify the script path. Example: pipeline/jenkinsfile/HELIX_SMARTREPORTING.jenkinsfile.

   7. Click Apply and then click Save.
   8. From the Jenkins home page, select the pipeline, and click Build Now.
      The first build job fails because it needs to run the first time to load all the parameters of the pipeline script. 
   9. After the build job fails, select the pipeline name again from the Jenkins home page.
      The Build Now option changes to Build With Parameters.

Task 2: To install BMC Helix Smart Reporting

Run the HELIX_SMARTREPORTING pipeline by performing the following steps:

1. Log in to your Jenkins server by using the following URL:
   http://<Jenkins server host name>:8080
2. Select the HELIX_SMARTREPORTING pipeline, and click Build with Parameters.
3. In the INFRASTRUCTURE section, specify the following parameters:

   Parameter	Description
   AGENT	Specify the Jenkins agent to run the pipeline. Example: git-<Jenkins server host name>.
   CHECKOUT_USING_USER	Specify the Jenkins credential ID that contains the Git credentials. Specify the value as github.
   KUBECONFIG_CREDENTIAL	Specify the 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.

4. In the CODE section, specify the following parameters:

   Parameter	Description
   GIT_USER_HOME_DIR	Specify the Git user home directory. Example: /home/git
   GIT_REPO_DIR	Specify the directory that contains all the Git repositories for the deployment pipelines. Example: ssh://<Jenkins server host name>/home/git/git_repo

5. In the CUSTOMER-INFO section, specify the following parameters:

   Parameter	Description
   CLUSTER	Specify the value of the Kubernetes cluster context. Find the cluster from the kubeconfig file. The current-context value in the kubeconfig file is the cluster name. 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. Example: ABC Jenkins Limited.
   IS_NAMESPACE	Specify the namespace where you want to install BMC Helix Innovation Suite. Important: The maximum namespace name limit is 33 characters.
   CUSTOMER_SERVICE and ENVIRONMENT	Specify values of your service and environment. The pipeline generates URL in a specific format based on the inputs provided in the CUSTOMER_SERVICE, ENVIRONMENT, and CLUSTER_DOMAIN parameters. Example: If CUSTOMER_SERVICE=itsm, ENVIRONMENT=poc, and CLUSTER_DOMAIN=aus-ranch.bmc.com, the following URL is generated for Smart Reporting: itsm-poc-sr.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. The URL format for Smart Reporting production environment is itsm-sr.aus-ranch.bmc.com Make sure that you specify the correct values. You cannot change the application domain and URLs after installing BMC Helix Service Management. If you need to make changes, you will have to reinstall BMC Helix Service Management.
   CUSTOMER_SIZE	Specify the deployment size such as, compact, small, medium, large, or extra large. Enter the value as C, S, M, L, or XL.
   SMARTREPORTING_SOURCE_VERSION	Specify NA for the Smart Reporting application version of the Helm repositories.

6. In the PRODUCTS section, in the DEPLOYMENT_MODE parameter, specify the value as FRESH.
7. In the OTHER_INPUT_PARAMS section, specify the following parameters:

   Parameter	Description
   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.
   ROUTE_ENABLED	Do not select this check box.
   OS_RESTRICTED_SCC	Select this check box if you are using an OpenShift cluster and have restricted security context constraints enabled.
   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. Important: Make sure you select this parameter to use BMC Helix Logging or an external log source such as Splunk.
   CLUSTER_DOMAIN	Specify the Ingress controller domain name that is used for application URLs.
   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. Important: Do not specify the host path; specify only the host name.
   IMAGE_REGISTRY_USERNAME	Specify your EPD 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	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.
   REGISTRY_TYPE	Select the DTR option.
   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.
   (Only for PostgreSQL database) DATABASE_ADMIN_USER	If you select the DB_TYPE value as mssql or oracle, you can leave this field blank. For a PostgreSQL database, specify the administrator user name that is used to create and restore database dumps. Important: For a 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.
   (Only for PostgreSQL database)  DATABASE_ADMIN_PASSWORD	If you select the DB_TYPE value as mssql or oracle, leave this field blank. For a PostgreSQL database, specify the administrator user password. To update the password, click Change Password.
   (Only for PostgreSQL database) DATABASE_RESTORE	By default, this check box is selected to restore PostgreSQL database dumps automatically. If you have restored the database dumps manually, clear this check box.
   IS_DATABASE_ALWAYS_ON	Select this check box if your Microsoft SQL database is in a high availability cluster.
   HELM_NODE	Specify the host name of the Jenkins server where you have installed HELM.
   SMARTREPORTING_ADMIN_PWD	Specify the Smart Reporting administrator user password.
   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. Example: image-1.
   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. Important: The maximum password character limit is 28 characters.

8. Click Build.
   The HELIX_SMARTREPORTING pipeline installs the Smart Reporting application. After the installation is complete, you must apply application licenses within three days.

Task 3: To perform post-installation checks

1. Verify that the Smart Reporting pod is running by using the following command:
   kubectl get pod -n <BMC Helix Innovation Suite namespace>
2. Verify that the you can access Smart Reporting by using the following URL:

   https://<smartreporting ingress name>

   Use the siadmin user credentials to log in.

Where to go from here

Obtaining-license-keys