Setting up BMC Deployment Engine

Set up BMC Deployment Engine before deploying BMC Helix IT Service Management.

Related topic

The steps to set up BMC Deployment Engine are shown in the following figure:

The following table lists the tasks to set up the BMC Deployment Engine:

Task	Action
Install prerequisite software
1	Install EPEL-Repository
2	Install Python
3	Install Git
4	Set up Git server
5	Set up Git client
Install Ansible and other clients
6	Install Ansible
7	Install additional packages
8	Install kubectl
9	Install Helm
10	Configure kubeconfig file
11	Install OpenShift CLI on Linux
Set up BMC Deployment Engine
12	Install Docker
13	Install Jenkins server
14	Configure Jenkins server
15	Add credentials
16	Add Jenkins node
Add deployment pipelines
17	Add deployment pipelines from local Git server

Before you begin

Ensure that your system meets the following requirements for the Jenkins server:

Component	Node	vCPU	Operating System	RAM (GB)	Disk (GB)
Jenkins server	1	4	Cent OS 7.x and RHEL 7.x are certified. Equivalent releases of Fedora and Oracle Linux are supported.	Minimum 16 GB	200

For Kubernetes cluster requirements, see System Requirements.

Important

To login to the Jenkins server, use SSH clients, such as PuTTY, MobaXterm, or mRemoteNG.
By default, all the commands must be executed as non root user and the non root user must have sudo access.
Unless specified, user refers to non root user for this setup.
Make sure that the user has default shell as sh or bash.
Make sure that during configuration of Jenkins server and pipeline, the system has access to the Jenkins repository to automatically install all required plug-ins for a Jenkins pipeline.
The nomenclature used in pipeline development is as follows:
- The Home directory of non root user is referred to as <HOME> in all subsequent steps. By default, it is /home/git.
- Owner of git repository as well as owner of Jenkins is the same, which is the non root user referred to as <user>. By default, it is git.
- <hostname> is the host name of Deployment Engine server, which is resolvable by all the servers in this environment.
- <GIT_REPO_DIR> is the location of local git repository or it can be created in <HOME>.
- <Library_REPO_DIR> is the location of the local library repositories.

To create a non root user for Jenkins deployment

Create a user by running the following command:
```
sudo adduser git -m --home-dir /home/git
sudo passwd git
```
Enter the password for git user.
Important

Please consult with your system administrator to provide sudo access to user provisioned in the Step 1.
Do not use @ character in the password value.
Login as git user.
```
su - git
```

Perform the setup described in the following sections as git user.

To update Jenkins server with latest patches

Make sure that the Jenkins server is updated with the latest patches.

sudo yum update -y 
sudo yum upgrade

Back to top

Install prerequisite software

Perform the following tasks to install the prerequisite software.

To install EPEL-Repository

Download the latest Epel-release by using the following command:

sudo wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm

Install Epel-release by using the following commands:
```
sudo yum install -y ./epel-release-latest-*.noarch.rpm
```
Back to top

To install Python

Check whether you already have Python installed.
The installer currently uses Python 2 only.

# Check the system Python version 
python --version 
# Check the system Python 2 version 
python2 --version 
# Check the system Python 3 version 
python3 --version

If needed, install Python by using the following command:
```
sudo yum install -y python
```
Back to top

To install Git

Check if you already have Git installed on the Jenkins server.
```
git --version
```
If you do not have Git installed, run the following command:
```
sudo yum install git -y
```
Back to top

To set up the Git server

Create the local Git repositories as follows:
1. From EPD, download BMC_Remedy_Deployment_Manager_Configuration_Release_21.05.02.zip.
2. Copy this zip file to Deployment Engine server's git user's home directory by using tools, such as FileZilla or WinSCP.
  Important
  
  Make sure that minimum 60 GB space is available in the Deployment Engine server's git user's home directory.
3. Login to Jenkins server with your user credentials.
  Run the following commands.
```
mkdir -p <GIT_REPO_DIR>
cd <GIT_REPO_DIR>
mv <GIT_REPO.zip-location> .
unzip BMC_Remedy_Deployment_Manager_Configuration_Release_21.05.02.zip
sudo chown -R git:git *
```
4. Make sure that the following folders are extracted from the unzip command in Step 1c:
- - DEVOPS_REPO (ITSM_REPO)
  - PLAYBOOKS_REPO
  - CUSTOMER_CONFIGS
  - HELM_REPO
  - SMARTAPPS_HELM_REPO

Unzip the Pipeline Library repository to create the local library repositories.

cd <GIT_REPO_DIR> 
mkdir <Library_REPO_DIR> 
cd <Library_REPO_DIR> 
cp <Library_REPO.zip> . 
unzip <Library_REPO.zip>

Run the following command:
```
cd <Library_REPO> 
sudo chown -R git:git .
```
The following Library repositories are created:

- pipeline-framework
- JENKINS-27413-workaround-library

Back to top

To set up the Git Client

This procedure configures passwordless access for the Jenkins pipeline.

Copy Jenkins server's ssh key to git user's known host file by using the following command:
```
sudo ssh-keygen 
ssh-keygen
```
1. This command prompts for location to save the key. By default, it is kept in /root/.ssh/id_rsa.
2. Press Enter to accept the default values.
3. Leave the passphrase blank.
  
  If a password is provided here, the execution of the Jenkins pipelines will be impacted.

Provide the password for the git user.

sudo ssh-copy-id git@<jenkins_server_name> 
ssh-copy-id git@<jenkins_server_name>

Verify that the ID is copied successfully by using the following command:
```
sudo ssh git@<jenkins_server_name> 
sudo ssh git@<jenkins_server_name>
```
Important

If your system asks for the password again, follow your OS vendor's documentation to set up login by using ssh keys (passwordless login) or ask your system administrator to set up passwordless login from root@<jenkins_server_name> to git@<jenkins_server_name> and git@<jenkins_server_name> to git@<jenkins_server_name>.

Back to top

Install Ansible and other clients

Perform the following tasks to install the Ansible and other clients.

To set up Ansible

Important

BMC has certified Ansible version 2.9 for this release.

Check whether you have Ansible version 2.9 installed by using the following command.
```
ansible --version
```
(Optional) If you do not have Ansible installed or you have a version earlier than 2.9 installed, perform the appropriate action:
1. To install Ansible, run the following command:
```
sudo yum install ansible -y
```
2. To update to version 2.9, update Epel-Repository with the latest version, and update Ansible again.
3. Verify that you have installed Ansible 2.9 by using the following command:
```
ansible --version
```
Update Ansible configurations by using the sudo vi /etc/ansible/ansible.cfg command.
Search for each of the following parameters by using any editor of your choice or vi editor.
Example, If you are using vi editor, search by using / bin_ansible_callbacks.
Update the /etc/ansible/ansible.cfg file with the values of the parameters mentioned as follows:
- bin_ansible_callbacks = True
- callback_whitelist = profile_tasks
- host_key_checking = False
- stdout_callback = yaml
Verify that Ansible is up and working as expected by running the following command:
```
ansible localhost -m ping
```
Back to top

To install additional packages

Install sqlcmd by using the following commands.

sudo curl https://packages.microsoft.com/config/rhel/7/prod.repo -o /etc/yum.repos.d/msprod.repo
sudo yum remove -y mssql-tools unixODBC-utf16-devel 
sudo yum install -y mssql-tools unixODBC-devel

Run the following commands:

echo 'export PATH="$PATH:/opt/mssql-tools/bin"' >> ~/.bash_profile 
echo 'export PATH="$PATH:/opt/mssql-tools/bin"' >> ~/.bashrc 
source ~/.bashrc

Now, reconnect to the new shell by using PuTTY, MobaXterm, or mRemoteNG so that the changes made in Step 2 will be available for all subsequent commands.
Install JRE by using the following command:
```
sudo yum install java -y
```
Make sure that you have 64-bit Java version by using the following command:
```
 java -version
```

Install the following packages:

sudo yum install -y xmlstarlet zip unzip jq dos2unix

Back to top

To install kubectl

Download the kubectl binary by using the following command:

curl -o kubectl https://amazon-eks.s3.us-west-2.amazonaws.com/1.18.9/2020-11-02/bin/linux/amd64/kubectl

Apply execute permissions to the binary and copy the binary to a folder in your PATH by using the following command:

chmod +x ./kubectl
sudo cp kubectl /usr/bin/kubectl
mkdir -p $HOME/bin && cp ./kubectl $HOME/bin/kubectl && export PATH=$PATH:$HOME/bin
echo 'export PATH=$PATH:$HOME/bin' >> ~/.bash_profile
echo 'export PATH=$PATH:$HOME/bin' >> ~/.bashrc
source ~/.bashrc

Verify kubectl version by using the following command:
```
kubectl version --short --client
```
If the kubectl version --short --client command does not show the kubectl version, perform any one of the following steps:

- Run source ~/.bashrc to load ~/.bashrc again OR
- Open a new shell and run the kubectl version --short --client command to load ~/.bashrc again.

Back to top

To install Helm

Install Helm by running the following command:

wget https://get.helm.sh/helm-v3.2.3-linux-amd64.tar.gz
tar -zxvf helm-v3.2.3-linux-amd64.tar.gz
sudo mv linux-amd64/helm /usr/local/bin/helm
echo 'export PATH="$PATH:/usr/local/bin/"' >> ~/.bashrc

Run source ~/.bashrc to load ~/.bashrc again or
Open a new shell or connect with new login

Run the following command:
```
helm version --short
```
The output of this command should show the Helm version as 3.2.3 or later.

Back to top

To configure the kubeconfig file

Add the kubeconfig file in one of the following ways:
- For a self-hosted cluster, get kubeconfig file from $HOME/.kube/config of master node of cluster.
  Configure your Kubernetes cluster and get the kubeconfig file or get in touch with your Kubernetes Administrator for the kubeconfig file.
  For more information, see Configure Access to Multiple Clusters .
- For a rancher-based cluster:
  1. Log into Rancher.
  2. From the Global view, open the cluster that you want to access with kubectl.
  3. Click Kubeconfig File.
  4. Copy the contents displayed to your clipboard.
Create a directory with the name .kube in home directory of git user if does not already exist.
```
mkdir  $HOME/.kube
```
Download the kubeconfig.yaml file to the $HOME directory.

Copy the kubeconfig.yaml file to $HOME/.kube/config.

cp <kubeconfig complete file path> $HOME/.kube/config

Check the cluster connectivity by using the following command:
```
sudo kubectl get pod -n <namespace>
```
Replace <namespace> with the name of your namespace.
If you receive the following output, the connection to the Kubernetes cluster is successful and the output shows that there are no pods running in the namespace:
```
No resources found in <namespace> namespace.
```
Back to top

To install OpenShift CLI on Linux

Refer to this section only if you want to use an OpenShift cluster while setting up the pipeline. Use the OpenShift Container Platform command-line interface (CLI) (oc) to develop, build, deploy, and run your applications on an OpenShift cluster.

Perform the following steps to install the OpenShift CLI (oc) binary on Linux:

Run the following commands and download the OpenShift CLI (oc):

sudo mkdir /root/openshift_client4_6
sudo "cd /root/openshift_client4_6/ && wget https://github.com/openshift/okd/releases/download/4.6.0-0.okd-2021-02-14-205305/openshift-client-linux-4.6.0-0.okd-2021-02-14-205305.tar.gz"

Unzip the archive.

sudo "cd /root/openshift_client4_6/ && tar -zvxf openshift-client-linux-4.6.0-0.okd-2021-02-14-205305.tar.gz"

Copy the oc files into a directory that is in your PATH.

sudo "cd /root/openshift_client4_6/ && cp oc kubectl /usr/local/bin/"

Verify that OpenShift client is installed successfully by using the oc command.
The command should run successfully and show the output as OpenShift Client.
Back to top

To set up BMC Deployment Engine

Depending on your environment, you can choose to install Jenkins by using a docker container or set up Jenkins locally on a node.

To install Jenkins locally on a node

Important

Refer to this section to install Jenkins locally on a node.

Run the following commands on the Jenkins node:
```
sudo wget -O /etc/yum.repos.d/jenkins.repo https://pkg.jenkins.io/redhat-stable/jenkins.repo
sudo rpm --import https://pkg.jenkins.io/redhat-stable/jenkins.io.key
sudo yum upgrade
sudo yum install epel-release java-11-openjdk-devel
sudo yum install jenkins-2.314
sudo systemctl daemon-reload
sudo systemctl start jenkins
```
Important

If you want to update the plug-ins automatically or by using the web UI, firewall ports should be configured to allow connections to Jenkins repositories. By default, ports 8080 and 8443 are used for this access.
If your organization's security policies do not allow the opening of firewall ports to internet, use Jenkins offline plug-in installation steps on Jenkins official documentation page.
After Jenkins is installed, access Jenkins by using the following URL:
http://<jenkins_hostname>:8080
To unlock Jenkins, run the following command on the Jenkins host:
```
sudo cat /var/lib/jenkins/secrets/initialAdminPassword
```
Copy the generated token and paste it on the Jenkins UI as the Administrator password.
On the next page of the Jenkins UI click Install Suggested Plugins before proceeding further.
After the plugins are installed, create the Admin user on the next page.
Follow the instructions on the page and click Save and Finish to complete the Jenkins installation and initial setup.
After the Jenkins setup is complete, configure SSH for Jenkins user and Git user for passwordless authentication by using the following commands:
1. Login as a Jenkins user.
```
sudo su -s /bin/bash jenkins
```
2. Create SSH public keys for the Jenkins user.
```
ssh-keygen 
```
  1. This command prompts for a location to save the key. By default, it is kept in <Home_dir_of_Jenkins>/.ssh/id_rsa.
  2. Press Enter to accept the default values.
  3. Leave the passphrase blank.
3. Copy the SSH public keys to Git user authorized_keys.
```
ssh-copy-id git@<git_server_hostname>
```
4. Make sure that SSH is configured between the Jenkins user and Git user.
```
ssh git@<git_server_hostname>
```

Back to top

To install the Jenkins container

Important

Refer to this section only if you are installing Jenkins on a docker container. Ensure that you have logged in as a git user.

(optional) To install Docker

Before installing Jenkins container, ensure that you have installed Docker.

Note

BMC recommends that you should not install Podman.

Perform the following steps to install Docker, if Docker is not already installed.

Run the following command:
```
sudo yum install docker -y 
```
- If this command is successful, proceed to Step 2.
- If you are unable to install Docker by using this command, see Install Docker Engine .
  Note: If you encounter SELinux related issue, run the following command:
```
sudo yum install -y http://mirror.centos.org/centos/7/extras/x86_64/Packages/
container-selinux-2.107-3.el7.noarch.rpm
```
Start Docker by using the following command and also check if it has started successfully:
```
sudo systemctl start docker
sudo systemctl status docker 
```
Back to top

To install Jenkins container

Copy and extract the ITSM_Jenkins_Setup2.314.02.zip file to the Jenkins server location. Verify that the downloaded zip file has MD5 checksum as 15e024c2916a3e6de34caa6c245616bd.
Extract the zip file by using the following commands:
```
mkdir opt/bmc/Jenkins.serversetup
sudo "cd /opt/bmc/Jenkins.serversetup && unzip /opt/bmc/Jenkins.serversetup"
```
After unzipping the file, run following commands from the unzipped directory:
```
sudo "cd <path of unzipped file> && chmod -R 755 *"
```
In the unzipped directory, locate the build.properties file.
Edit build.properties file and update the following parameters as per your requirements.

#HOST_SERVER_DATA
DOCKER_NAME=onprem_itsm_jenkins
JENKINS_URL=<Jenkins host url>:8080
(The default port is 8080. You can change the port number, if required)
HOST_SERVER_LOCATION=/data1/jenkins_home
(You can specify your host server location to set up Jenkins)
SSH_HOST_DOCKER_MAPPING=/home/git/.ssh:/home/root/.ssh
JENKINS_ADMIN_USER=<Jenkins admin user>
JENKINS_ADMIN_PWD=<Jenkins admin password>
HOST_2_DOCKER_PORT_MAPPING=8080:8080
(The default port 8080 is taken from Jenkins URL port. The second port number 8080 is the Jenkins port number inside Docker.
You can customize the port numbers, if required.)
# INSIDE_JENKINS_SERVER_DATA (Inside Docker)
INSIDE_DOCKER_JENKIN_HOME_PATH=/var/jenkins_home
Run the following command:
```
sudo <path of unzipped file>/build.sh
```
Verify that the Jenkins server is up.
Log in to the Jenkins server from browser by using the <JENKINS_URL> provided in Step 3.
Keep the browser open and wait for the configuration to be completed.
After that, click the login link.
Specify the user name and password that you have provided in build.properties file in Step 3.
Make sure to reset the default login credentials before proceeding further.

Important

If you want to update the plug-ins automatically or by using the web UI, firewall ports should be configured to allow connections to Jenkins UI. By default, ports 8080 and 8443 are used for this access. Make sure that the ports 8443 and 443 have outbound access and the port 8080 has inbound access.
If you use any custom port that Jenkins is listening, make sure that port has inbound access.
If your organization's security policies do not allow the opening of firewall ports to internet, use Jenkins offline plug-in installation steps on Jenkins official documentation page.

Back to top

To configure the Jenkins server

After you have installed Jenkins either on a local node or in a container, you must configure the Jenkins server.

Log into the Jenkins server.
Install the Parameter Separator plug-in.
1. On the Jenkins home page, click Manage Jenkins.
2. Click Manage plug-ins, and select the Available tab.
3. In the search box, type Parameter Separator.
4. Select the check box for the Parameter Separator plug-in from the search results.
5. Click Install without restart.
Install the Validating String Parameter plug-in.
1. On the Jenkins home page, click Manage Jenkins.
2. Click Manage plug-ins, and select the Available tab.
3. In the search box, type Validating String Parameter.
4. Select the check box for Validating String Parameter plug-in from the search results.
5. Click Install without restart.
Install the Jira plug-in.
1. On the Jenkins home page, click Manage Jenkins.
2. Click Manage Plugins, and select the Available tab.
3. In the search box, type Jira.
4. Select the check box for Jira plug-in from the search results.
5. Click Install without restart.
Install the Rebuilder plug-in.
1. On the Jenkins home page, click Manage Jenkins.
2. Click Manage plug-ins, and select the Available tab.
3. In the search box, type Rebuilder.
4. Select the check box for Rebuilder plug-in from the search results.
5. Click Install without restart.
Install the Mask Passwords plug-in.
1. On the Jenkins home page, click Manage Jenkins.
2. Click Manage plug-ins, and select the Available tab.
3. In the search box, type Mask Passwords.
4. Select the check box for Mask Passwords plug-in from the search results.
5. Click Install without restart.
Install the BlueOcean Aggregator plug-in.
1. On the Jenkins home page, click Manage Jenkins.
2. Click Manage plug-ins, and select the Available tab.
3. In the search box, type BlueOcean Aggregator.
4. Select the check box for BlueOcean Aggregator plug-in from the search results.
5. Click Install without restart.
Add the pipeline-framework library from local Git repository.
1. On the Jenkins home page, click Manage Jenkins.
2. Select Configure System.
3. In Global Pipeline Libraries, add the pipeline-framework library that you created by using the local Git repository.
4. In the Project Repository field, specify the path that is the complete path of pipeline-framework.git as shown in the following figure:
Add JENKINS-27413-workaround-library that you created by using the local Git repository as shown in the following figure.
1. Select Load implicitly.
Save the changes.

Back to top

To add credentials

Add credentials in the ID: kubeconfig file.

In a browser, go to http://<Jenkins server host name>:<Jenkins port>/credentials/store/system/domain/_/newCredentials
For example, http://calbro-eur-upnnld:8080/credentials/store/system/domain/_/newCredentials

Enter the following details:

Kind	Secret file
Scope	Global
File	Click Browse and select the kubeconfig file. The kubeconfig file must have a context that refers to the cluster name used for deployment. Example: If cluster name used for deployment is aus-k8s-cluster, the context must be specified as follows. contexts: - context: cluster: aus-k8s-cluster namespace: ade-poc user: aus-k8s-cluster name: aus-k8s-cluster - context: ---
ID	kubeconfig This name is used as an input to the KUBECONFIG_CREDENTIAL parameter in the HELIX_ONPREM_DEPLOYMENT pipeline.
Description	Description that you enter.

Click OK.

Add credentials in the ID: github account.

Enter the following details:

Kind	User name with password
Scope	Global
Username	git
Password	Password to access Git. The password is configured in the section where you set up the Git Server.
ID	github
Description	Description that you enter.

Click OK.

Add credential in the ID: ansible_host account.
Add the user name and password that you use to connect to the virtual machine where you have installed Ansible.

Enter the following details:

Kind	User name with password
Scope	Global
Username	User name to connect to the Ansible machine; for example, git
Password	Password to connect to the Ansible machine.
ID	ansible_host
Description	Description that you enter.

Click OK.

Add credentials in the ID: ansible file.
Add the username and password that you use to connect the Jenkins server machine to the tools/helm machine.

Enter the following details:

Kind	Username with password
Scope	Global
Username	User name to connect to the Ansible machine; for example, git
Password	Password to connect to Ansible machine.
ID	ansible
Description	Description that you enter.

Click OK.

Add credentials in the ID: TOKENS JSON file.
1. Create a blank file named tokens.json in your local system.
2. Enter the following details:
  Kind Secret file
  Scope Global
  File Click Browse and select the tokens.json file.
  ID TOKENS
  Description Description that you enter.

Back to top

To add Jenkins node

Create the Jenkins node.

Go to <Jenkins server host name>:<Jenkins port>/computer/new
Example, calbro-eur-upnnld:8080/computer/new.
Select Permanent Agent.
The following figure shows an example where the Permanent Agent has been selected:
Enter the name of the Jenkins server in the Node name field.
Click OK.

Enter the details as shown in the following table, and click Save.

Name	Virtual machine name where you have installed Ansible.
(Optional) Description	Description of the machine.
# of executors	Number of executors required to run parallel jobs. Example: 3
Remote root directory	Directory on the virtual machine where you have installed Ansible. This directory is used as the root directory for jobs. Ensure that you have created the directory and have given all permissions for the user that are provided in ansible_host credentials. For example, /data1. Note: Make sure that this directory is owned by git user. If not, run the following command: `sudo chown -R git:git /data1`
Labels	ansible-master Make sure that you enter the label as ansible-master.
Usage	Use this node as much as possible.
Launch Method	Launch the agent through SSH. Host: Virtual machine host name on which you have installed Ansible Credentials: Select credentials with the ID ansible_host. Host Key Verification Strategy: Non verifying Verification Strategy.

The page is as shown in the following figure:

The ansible-master node is created as shown in the following figure:

Add agent-add-pipeline.
1. On the Jenkins home page, click New Item.
2. In Enter an item name field, enter agent-add-pipeline, select Pipeline, and click OK.
3. Scroll down and select the This project is parameterized check box.
4. Add a string parameter named UserName and a password parameter named Password as shown in the following figures:
5. From the Definition list, select Pipeline script.
6. Copy and paste the script from the agent-add-pipeline.groovy file.
  Important
  
  Make sure that you do not select the Use Groovy Sandbox option that is shown in the following figure:
7. Update the value of def Hosts in agent-add-pipeline.groovy script with the Jenkins server hostname as follows:
```
def Hosts = [ "<jenkins_server_hostname>" ];
```
  Ensure that /opt/workspace has permission for non root user (git).
8. Click Apply and then click Save.
Configure agent-add-pipeline.
1. From agent-add-pipeline, click Build with Parameters.
2. Enter the user name of the virtual machine where you have installed Ansible.
  For example, git.
3. Click Change Password and enter the password of the virtual machine where you have installed Ansible.
4. Click Build.
  Make sure that the job is completed successfully.
The Jenkins node is created.
To verify the successful creation of the node, go to http://<Jenkins server host name>:8080/computer, and verify that you see one master node and two agent nodes as shown in the following figure.
root-<jenkins node> is the new node added by the agent-add-pipeline.

Back to top

Add deployment pipelines

After setting up the Git repositories, add the deployment (Jenkins) pipelines from the local Git server.

To add deployment pipelines from local Git server

On the Jenkins home page, click New Item.
In the Enter an item name field, enter a pipeline name as listed in the Deployment pipelines table.
Example, HELIX_ONPREM_DEPLOYMENT.
Select the pipeline and click OK.
Click the Pipeline tab.
Enter the following information:
1. From the Definition list, select Pipeline script from SCM.
2. From the SCM list, select Git.
3. Enter the Repository URL as the path of your local Git repository in the format ssh://git@<jenkins_server>/<path to itsm-on-premise-installer.git>.
  Example: ssh://git@<jenkinsSrv>/data1/git/GIT_REPO_DIR/ITSM_REPO/itsm-on-premise-installer.git.
4. Enter the Git server credentials.
5. Specify the script path.
  Example: pipeline/jenkinsfile/HELIX_ONPREM_DEPLOYMENT.jenkinsfile..
Click Apply & Save.
After the pipeline is created, make sure that the pipeline is selected from Jenkins home page.
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.
After the build job fails, select the pipeline name again from the Jenkins home page.
The Build Now option changes to Build With Parameters.
Perform step 1 to step 8 for each of the pipelines described in the Deployment pipelines table by modifying the pipeline name, repository, branch and script path.

The following table lists the deployment pipelines for your reference:

Deployment pipelines

Pipeline name	Repository URL	Branches to build	Script path
HELIX_ONPREM_DEPLOYMENT	ssh://git@<jenkins_server>/GIT_REPO_DIR/ITSM_REPO/itsm-on-premise-installer.git Refer to Step 5c for the path to ITSM on-premise installer git	*/master	pipeline/jenkinsfile/HELIX_ONPREM_DEPLOYMENT.jenkinsfile
HELIX_GENERATE_CONFIG	ssh://git@<jenkins_server>/GIT_REPO_DIR/ITSM_REPO/itsm-on-premise-installer.git Refer to Step 5c for the path to ITSM on-premise installer git	*/master	pipeline/jenkinsfile/HELIX_GENERATE_CONFIG_ONPREM.jenkinsfile
SUPPORT_ASSISTANT_TOOL	ssh://git@<jenkins_server>/GIT_REPO_DIR/ITSM_REPO/itsm-on-premise-installer.git Refer to Step 5c for the path to ITSM on-premise installer git	*/master	pipeline/jenkinsfile/assisttool_deploy.jenkinsfile
HELIX_PLATFORM_DEPLOY	ssh://git@<jenkins_server>/GIT_REPO_DIR/ITSM_REPO/itsm-on-premise-installer.git Refer to Step 5c for the path to ITSM on-premise installer git	*/master	pipeline/jenkinsfile/HELIX_PLATFORM_DEPLOY_ONPREM.jenkinsfile
HELIX_NON_PLATFORM_DEPLOY	ssh://git@<jenkins_server>/GIT_REPO_DIR/ITSM_REPO/itsm-on-premise-installer.git Refer to Step 5c for the path to ITSM on-premise installer git	*/master	pipeline/jenkinsfile/HELIX_NON_PLATFORM_DEPLOY_ONPREM.jenkinsfile
HELIX_SMARTAPPS_DEPLOY	ssh://git@<jenkins_server>/GIT_REPO_DIR/ITSM_REPO/itsm-on-premise-installer.git Refer to Step 5c for the path to ITSM on-premise installer git	*/master	pipeline/jenkinsfile/HELIX_SMARTAPPS_DEPLOY_ONPREM.jenkinsfile
HELIX_FLUENTBIT_DEPLOY	ssh://git@<jenkins_server>/GIT_REPO_DIR/ITSM_REPO/itsm-on-premise-installer.git Refer to Step 5c for the path to ITSM on-premise installer git	*/master	pipeline/jenkinsfile/HELIX_FLUENTBIT_DEPLOY.jenkinsfile

Back to top

Troubleshooting

Refer to the troubleshooting information if you encounter any of the following issues while setting up BMC Deployment Engine.

Issue symptom

You get the following error while adding deployment pipelines from local Git server:

Failed to connect to repository : Command "git ls-remote -h -- ssh://git@<jenkins_server>/var/git/ITSM_REPO/itsm-on-premise-installer.git HEAD" returned status code 128:
stdout:
stderr: Host key verification failed.
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.

Resolution

Verify that you have performed all the steps in To set up the Git client.

Issue symptom

You get one of the following errors while adding libraries to Jenkins server from local Git server:

Error 1

Pipeline HELIX_ONPREM_DEPLOY failed:
hudson.plugins.git.GitException: Command "git ls-remote -h -- ssh://git@<jenkins_server>/var/git/LIB_REPO/LIBRARY_REPO/pipeline-framework/pipeline-framework.git" returned status code 128:
stdout:
stderr: fatal: '/var/git/LIB_REPO/LIBRARY_REPO/pipeline-framework/pipeline-framework.git' does not appear to be a git repository
fatal: Could not read from remote repository.

Error 2

hudson.plugins.git.GitException: Command "git fetch --tags --progress --prune -- origin +refs/heads/master:refs/remotes/origin/master" returned status code 128:
stdout: 
stderr: fatal: Could not read from remote repository.

Resolution

Run the following commands:

chown -R git:git <LIBRARY REPO>
chmod -R 777 <LIBRARY_REPO>

Verify that you have performed all the steps in To set up the Git client.

For other issues, see Troubleshooting deployment pipeline failure issues.

Where to go from here

Setting up the installation environment

Setting up BMC Deployment Engine

To create a non root user for Jenkins deployment

To update Jenkins server with latest patches

To install EPEL-Repository

To install Python

To install Git

To set up the Git server

To set up the Git Client

Install Ansible and other clients

To set up Ansible

To install additional packages

To install kubectl

To install Helm

To configure the kubeconfig file

To install OpenShift CLI on Linux

To set up BMC Deployment Engine

To install the Jenkins container

To install Jenkins container

To configure the Jenkins server

To add credentials

To add Jenkins node

Add deployment pipelines

To add deployment pipelines from local Git server

Troubleshooting

Issue symptom

Issue symptom

Resolution

Where to go from here

Comments