Automatics Automated Build & Deployment

Introduction

Automatics provides Build and deployment pipeline by making use of Jenkins scripts for creating pipeline jobs to build Automatics projects like Orchestration, properties and Device Manager and giving Docker images as final output. The build job will pull the code of each Automatics Project from CMF repo and build the war files using maven, then the corresponding docker images will be created

Automatics Automated build and deployment Repo

Repo : https://code.rdkcentral.com/r/admin/repos/rdk/tools/automatics/dev-ops

Branch : rdk-next

Sub folder : 

• Build : automationScripts\build\
• Deployment : automationScripts\deployment\
• Jenkins Setup : jenkinsServerSetup\

Pre-Requisites

Jenkins Server Setup :

1. A VM should be available and an user with root access should be available
2. Git should be installed in the VM.

Build & Deployment of Automatics: 

1. A VM should be available and Jenkins server should be installed in it.
2. Also the below applications should be installed in the VM.
   1. Docker -  The below commands can be used for installing docker in a VM

curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh

1. 1. Maven - version 3
   2. JDK - 1.8
2. Create a new user group in the VM named "docker" and add the Jenkins user to this user groups the below commands can be referred for the same

   1. Create the docker group.

      $ sudo groupadd docker
      

   2. Add your user to the docker group.

      $ sudo usermod -aG docker $USER
      

   3. Log out and log back in so that your group membership is re-evaluated.

      If testing on a virtual machine, it may be necessary to restart the virtual machine for changes to take effect.

      On a desktop Linux environment such as X Windows, log out of your session completely and then log back in.

      On Linux, you can also run the following command to activate the changes to groups:

      $ newgrp docker 
      

   4. Verify that you can run docker commands without sudo.

      $ docker run hello-world
      

      This command downloads a test image and runs it in a container. When the container runs, it prints a message and exits.

3. Access to pull the docker base image like tomcat, mysql from dockerhub should be available. If access cannot be provided then those images should be available locally in the Jenkins VM for building docker images of Automatics tools.

Jenkins Server Setup

1. Clone the above repo and go to the directory "jenkinsServerSetup\"
2. Here you will find a file named "install_jenkins_server.sh" 
3. Execute this shell script. This will install Docker and pull the Jenkins server image from docker hub 
4. Then it will install all the necessary dependencies link maven, and Jenkins plugins.
5. Also Automatics Core & RDKB Utils build jobs as well as Build and Deployments jobs will be created.

Jenkins Pipeline Manual Setup

1. Login to Jenkins webpage
2. Click on New Item button at the Left hand side menu
   1. 
3. Now Enter the name of the pipeline job and select pipeline option from below and click OK, as shown in the image below
   1. 
4. Navigate to the pipeline menu in the options and select "Pipeline script from SCM" in the drop down menu under the header definition. Then select the option Git for SCM. After that provide the Repo URL credentials and the branch. Then click save
   1. when adding the script path the path to the Jenkinsfile from the home directory of the repo should be provided. For the example the home directory of the repo is "/home/automatics/" and the location of Jenkins file for build job is "/home/automatics/automationScripts/build/Jenkinsfile" then the script path should be entered as "automationScripts/build/Jenkinsfile"
   2. 

The above steps can be used for creating the build pipeline similarly the same steps could be used for creating the deployment pipeline as well.

Running the jobs

• Build Job

To pull the code from the repository and building the Docker images of each tools the below parameters as shown in the sample images should be populated.

1. "BUILD_AUTOMATICS_ORCHESTRATION" check box should be ticked for orchestration build to run
2. In the subsequent steps give the Repo URL, its branch and credentials for Git repo(if any)
3. Similarly enter the details for Automatics Properties and Device manager
4. At last press the Build button to start the build

Deployment Job

This job will get the details of VM's in which each of the tools - Orchestration, Automatics Properties and Device Manager should be deployed including the user details for logging in to the VM's and deploy the docker images of the corresponding tools. All the VM's should have the SSH connection to the Jenkins VM for executing the commands as well as copying the docker images from Jenkins VM.  All the tools can be deployed in one execution or each one can be executed individually based on the selection of check box provided. Sample images of the deployment job are as follows

Provide all the fields based on the description provided against each field and press the build button to build the job.