Shulou(Shulou.com)06/01 Report--

This article is to share with you about how to achieve Pipeline automation deployment in Jenkins, the editor thinks it is very practical, so I share it with you to learn. I hope you can get something after reading this article.

Some settings before using Jenkins

To quickly build Jenkins, I use the Docker installation here to run Jenkins:

$sudo docker run-it-d\-- rm\-u root\-p 808080 jenkins-data:/var/jenkins_home\-v / var/run/docker.sock:/var/run/docker.sock\-v "$HOME": / home\-- name jenkins jenkinsci/blueocean

When you use jenkins for the first time, you need to verify your password before entering the Jenkins page. You need to enter the docker container to check your password:

$sudo docker exec-it jenkins / bin/bash$ vi / var/jenkins_home/secrets/initialAdminPassword

The Jenkins installed by Docker has a slight defect. The shell version is not compatible with the CenOS host version. In this case, we need to enter the Jenkins container to manually set the shell:

$sudo docker exec-it jenkins / bin/bash$ ln-sf / bin/bash / bin/sh

Since our Pipeline still needs to perform tasks on the remote server and needs to connect through ssh, we need to generate the public key of ssh in Jenkins:

$sudo docker exec-it jenkins / bin/bash$ ssh-keygen-C "root@jenkins"

Add the public key (id_rsa.pub) of jenkins to the ~ / .ssh/authorized_keys of the remote node

You also need to install some necessary plug-ins:

Pipeline Maven Integration

SSH Pipeline Steps

After installing the plug-in, you also need to add maven to the global tool:

Jenkinsfile is useful in the back here.

MutiBranch multi-branch construction

Because our development is based on multi-branch development, each development environment corresponds to a branch, so the ordinary Pipeline automatic build can not meet the existing development and deployment needs, so we need to use Jenkins mutiBranch Pipeline.

The first step, of course, is to create a new mutiBranch multi-branch to build job:

Then set the branch source. The branch source is the git address of your project. Select the path of Jenkinsfile in the project.

Next, Jenkins will scan the Jenkinsfile under each branch in the branch source. If there is a Jenkinsfile under that branch, then a branch Job will be created.

The branch job under this job is as follows:

It should be noted here that Jenkinsfile is added only for the branches that need to be deployed, otherwise Jenkins will create a branch job for the rest of the branches as well.

Generalized Pipeline script

Before you get here, you can basically automate deployment based on Pipeline scripts, but if you are a programmer who pursues the extreme and is not willing to be mediocre, you must think that with the increase of projects, Pipeline scripts continue to increase, which will cause more and more maintenance costs. As the business grows, it is inevitable to modify things in scripts, which will involve too many Pipeline scripts, and these scripts are basically the same. So for a good programmer like me, how could I not think of this problem? I immediately thought of generalizing pipeline scripts. Fortunately, Jenkins had seen my restless heart, and Jenkins gave me a Shared Libraries.

What is Shared Libraries? As the name implies, it is a shared library, its main function is to put the general Pipeline script in one place, other projects can get a global universal Pipeline script from it, and the projects can achieve the purpose of generalization by passing parameters of variables that are not common to each other.

Next, let's create a git repository for storing generic Pipeline scripts:

The warehouse catalog is not added randomly. Jenkins has a strict specification. Here is the official description:

Officials have made it very clear that the vars directory is used to store generic Pipeline scripts and resources is used to store non-Groovy files. So I put the build scripts and orchestration files needed by Pipeline here, completely hidden from the business engineer, in order to prevent the business engineer from making random changes that lead to bug.

After creating the git repository, we also need to define the global library in jenkins's Manage Jenkins »Configure System »Global Pipeline Libraries:

The name here can be referenced in jenkinsfile with the following command:

@ Library 'objcoding-pipeline-library'

Let's take a look at the general rules for writing Pipeline scripts:

#! groovydef getServer () {def remote = [:] remote.name = 'manager node' remote.user =' dev' remote.host = "${REMOTE_HOST}" remote.port = 22 remote.identityFile ='/ root/.ssh/id_rsa' remote.allowAnyHosts = true return remote} def call (Map map) {pipeline {agent any environment {REMOTE_HOST = "${map .remote _ HOST} "REPO_URL =" ${map.REPO_URL} "BRANCH_NAME =" ${map.BRANCH_NAME} "STACK_NAME =" ${map.STACK_NAME} "COMPOSE_FILE_NAME =" docker-compose- "+" ${map.STACK_NAME} "+"-"+" ${map.BRANCH_NAME} "+" .yml "} Stages {stage ('get code') {steps {git ([url: "${REPO_URL}") Branch: "${BRANCH_NAME}"])} stage ('compiled code') {steps {withMaven (maven: 'maven 3.6') {sh "mvn-U-am clean package-DskipTests"} }} stage ('build image') {steps {sh "wget-O build.sh https://git.x-vipay.com/docker/jenkins-pipeline-library/raw/master/resources/shell/build.sh" sh" sh build.sh ${BRANCH_NAME} " }} stage ('init-server') {steps {script {server = getServer ()} stage (' execute the release') {steps { WriteFile file: 'deploy.sh' Text: "wget-O ${COMPOSE_FILE_NAME}" + "https://git.x-vipay.com/docker/jenkins-pipeline-library/raw/master/resources/docker-compose/${COMPOSE_FILE_NAME}\ n" + "sudo docker stack deploy-c ${COMPOSE_FILE_NAME} ${STACK_NAME}" sshScript remote: server Script: "deploy.sh"}

Since we need to perform tasks on the remote server, we define the information of a remote server where remote.identityFile is the address of the key we generated in the container above.

Define a call () method that is used to call in the Jenkinsfile of each project. Note that it must be called call

Define a pipeline in the call () method

The environment parameter is a variable general parameter, which is given by passing the parameter Map, which is a parameter defined from each project.

The next step is a step of operation, "compile code" this step needs to fill in the above we set in the global tool class maven, "build image" build script cleverly use wget to pull down from this remote warehouse, "execute hair version" orchestration file is also done, "init-server" step is to initialize a server object, for "implementation of distribution use".

From the script, we can see a kind of thinking that Jenkins will promote in the future: configuration is code.

After writing the generic Pipeline script, we need to create a new Jenkinsfile script in the root directory of the branch of each project that needs to be deployed automatically:

Next, let me explain the content of Jenkinsfile:

#! groovy// under multi-branch construction It is strictly stipulated that Jenkinsfile only exists on branches that can be distributed / / references are made in jenkins's globally defined librarylibrary 'objcoding-pipeline-library'def map = [:] / / remote management node address (for performing distribution) map.put (' REMOTE_HOST','xxx.xx.xx.xxx') / / project gitlab code address map.put ('REPO_URL') 'https://github.com/objcoding/docker-jenkins-pipeline-sample.git')// branch name map.put (' BRANCH_NAME','master') / / service stack name map.put ('STACK_NAME','vipay') / / call build.groovy script build (map) under the var directory in library

Define a map parameter by referencing the global library we defined in Jenkins through library' objcoding-pipeline-library'

The next step is to save the specific parameters of the project to map and call the build () method to pass to the generic Pipeline script.

This is how to automate the deployment of Pipeline in Jenkins. The editor believes that there are some knowledge points that we may see or use in our daily work. I hope you can learn more from this article. For more details, please follow the industry information channel.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.