Jenkins Setup and Deployment Guide

Introduction

Welcome to the Automatics Jenkins Setup and Deployment Guide. This document will walk you through the steps to set up and deploy Automatics applications using Jenkins, ensuring a smooth and efficient process.

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\

Prerequisites

Before you begin, ensure you have the following:

• Virtual Machine (VM): A VM with root access.
• Git: Installed on your VM.
• Docker (Optional): Install using the following commands:

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

• Create a new user group named "docker" and add the Jenkins user to this group:

  sudo groupadd docker
  sudo usermod -aG docker $USER

• Log out and log back in to re-evaluate group membership. On a virtual machine, you may need to restart it. On Linux, you can also run:

  newgrp docker

• Verify Docker commands can be run without sudo:

  docker run hello-world

• Ensure access to pull Docker base images like Tomcat and MySQL from Docker Hub. If access is not available, ensure these images are available locally on the Jenkins VM.

Jenkins Server Setup

1. Clone the repository and navigate to the jenkinsServerSetup directory:

   git clone <repository_url>
   cd jenkinsServerSetup

   
   

2. Execute the installation script as sudo:

   
   

   
   

   sudo sh install_jenkins_server.sh

   
   

   This script installs Docker, pulls the Jenkins server image from Docker Hub, and installs necessary dependencies like Maven and Jenkins plugins. It also creates Automatics Core & RDKB Utils build jobs and build and deployment jobs.

   
   

3. During script execution, provide inputs such as the port for the Jenkins server. After setup, access Jenkins via the browser using the public IP and port (e.g., 192.168.91.44:8909).

4. Configure Jenkins security:

   • Go to "Manage Jenkins" → "Security".
   • Under Security Realm, select Jenkins’ own user database.
   • In the Authorization section, select "Logged-in users can do anything".
   • Unselect "Allow anonymous read access".
   • Click "Save".

5. Modify the necessary configurations in the pre-created Jenkins jobs (e.g., Maven repo URL, shell script file paths).

Running the jobs

Build Job

• Populate the parameters as shown in the sample images.

• Tick the checkbox like "BUILD_AUTOMATICS_ORCHESTRATION" for the orchestration build. You can tick or untick checkbox against each Automatics application to build the corresponding docker container
• Provide the repository URL, branch, and credentials for each Automatics project.
• Click "Build" to start the build.

Deployment Job

Prerequisite

1. Docker : All the VMs in which you are planning to deploy Automatics should have docker pre installed in them before executing the deployment job.

• Provide details of the VMs for deploying each tool, including user details for SSH access.
• Ensure SSH connection to the Jenkins VM for executing commands and copying Docker images.
• Select the tools to deploy and click "Build".

Mandatory Automatics Configurations for Test Execution

The below configurations needs to be available in Automatics Orchestration, Automatics Properties, Device Manager and Jenkins jobs inorder to trigger a successful Test case execution from Automatics Orchestration

Jenkins Jobs

The below set of jobs will be created after successful completion of Automated Build and Deployment execution.

Configure all the jenkins jobs with below mentioned details 

After completing the above set of configuration "CI_Automatics_Code_Deploy_And_3.0_Api_Parser" job should be executed. This job will build and deploy all the automatics dependencies to the repo and run the parsers needed for Automatics Scriptless automation (Automatics 3.0). After that "Deploy_RPi_Partner_Java_API" job needs to be executed. Once all these jobs are executed successfully it is good to go with jenkins job configuration for Automatics( Full manual configuration can be found here Jenkins Job for Test Execution#2.ConfigureJenkinsJob)

Automatics Orchestration

System Configuration

The below mandatory system configurations needs to be done in Automatics orchestration for running a first dummy Test execution and result verification from automatics.

Device Details

You need to configure the below data related to device in Automatics orchestration in order to trigger a Test case successfully for the first time.

• Device Models -  Automatics Orchestration Setup#DeviceModels
• Device Groups - Automatics Orchestration User Manual#ConfigureDeviceGroup 
• Resource Details (Jenkins job settings)- Automatics Orchestration Setup#ResourceDetails
• Source Code Repository - Automatics Orchestration Setup#SourceCodeRepository

Automatics Properties

All the mandatory properties mentioned in the document Automatics Properties should be configured in automatics properties for the successful execution of a test case.