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.

Navigate through below stages to bring up Automatics Test System.

• To be installed in all VMs where Automatics components has to be deployed

• Self Hosted Maven Artifact Repository : (Optional)

  • This is where Automatics maven artifacts will be deployed and used during test execution using maven. If this setup is not available, please press enter for inputs asking maven artifact repo details. If planning to keep the artifacts in maven local repo in the same machine, please replace the command clean deploy with clean install in jenkins jobs configuration where ever applicable.

Docker Setup Steps

Please follow below steps to setup docker in your VMs.

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

Note: 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.

Clone Automated Deployment Repository

After the pre-requisites are done, clone the automated deployment repository in the VM where Jenkins is planned to setup.

Automatics Automated build and deployment Repo

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

(Please open the above url in browser and git clone url is available in the page)

Branch : rdk-next

Sub folder : 

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

Clone the

repository https://code.rdkcentral.com/r/admin/repos/rdk/tools/automatics/dev-ops(Please open the above url in browser and git clone url is available in the page) and navigate to the jenkinsServerSetup directory:

git clone <repository_url>
cd dev-ops/jenkinsServerSetup

Setup Automatics Jenkins

• Execute the installation script as sudo

• from dev-ops/jenkinsServerSetup. 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

sudo sh install_jenkins_server.

sh

• • Maven Repository Selection

During the installation, you will be prompted to specify whether you have a cloud-based Maven artifact repository.

 If you have cloud Maven artifact repository, enter ‘Y’ and provide the URL of the private cloud Maven artifact repository along with the username and password.

 If you do not have a cloud Maven artifact repository and want to configure a local Maven repository instead, enter ‘N’. In this case, the .m2 folder will be used by default as the local Maven repository inside the Docker container.

Image Added

• Next, user has to provide the port on which Jenkins to be run. Please provide the port when below prompt comes in. 

Image Added

• • Jenkins Configurations
    • After setup, access Jenkins via the browser using the public IP and port (e.g.,

• • •  192.168.91.44:8909).

• • • And, 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"

• • • • .
    • Create Jenkins Admin User.
      • Once first step is done, it will automatically launch below page to create admin user. Please create admin user.

Image Added

• • • Add the ssh credentials under Manage Jenkins->Credentials->System→Global Credentials. ie  ssh credentials of Jenkins VM if all Automatics components are planned to be executed in single VM. Otherwise ssh credentials of other VMs where Automatics Components are planned to be deployed.
      Image Added

Below set of jobs will be created after successful setup of Jenkins.

Image Added

Execute Automatics Build Job

First execute Automatics_Build_Job. This will build the source code of Automatics tools and services and generate war or jar files. 

• 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.

Populate the parameters as shown in the sample images.

Image AddedImage Added

Image AddedImage Added

Execute Automatics Deployment Job

Next, execute Automatics_Deployment_Job. This will create docker files and deploy dockers on the destination VMs. After this execution, Automatics tools should be up and running.

While running this 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".

• Check the logs to ensure that deployment was success.
• The tools and services deployment urls are available at the end of the console log. All the URLs and DB credentials used for the deployment can be found as a YAML file in "archived artifacts" of Automatics Deployment Job execution DeploymentJob

Run Jenkins Jobs

After completing the above set of configuration execute Jenkins Jobs in below order.

1.  "CI_Automatics_Code_Deploy_And_3.0_Api_Parser"

1. .  
   1. 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).

1. 1.  
2.  "Deploy_RPi_Partner_Java_API"

1. 1.  This job will build and deploy rpi provider partner implementation.

Configure Devices in Device Manager

Configure devices in device manager

• Add Device Models. Follow steps in Automatics Orchestration Setup#DeviceModels
• Add Device Groups. Follow steps inAutomatics Orchestration User Manual#ConfigureDeviceGroup 
• Add Device Model. Follow steps in Device Manager UI User Manual#Adddevicedetails

Configurations in 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. Please follow Automatics Orchestration Setup#Configuration to configure required configs System Config page of Automatics Properties to make use of features like scriptless automation, review management etc

 All the URLs and DB credentials used for the deployment can be found as a YAML file in "archived artifacts" of Automatics Deployment Job execution DeploymentJob

Configure 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.

Restart Debugger Service

After all configuration are done, please login to the VM where debugger service is running and restart the debugger docker container.

docker start debugger-service-spring-boot-1