关于jenkins:Java开发者必看手把手带你搞定JenkinsMaven仓库Docker-仓库部署自动更新pom版本-一条龙部署服务

原文公布于：Java 开发者必看！手把手带你搞定 Jenkins+Maven 仓库 +Docker，欢送应用 RSS 订阅获取最新更新。

1. 写在结尾

为了调通这长长的一串破费了整整 4 天工夫。。。写完后将之前写的 API 都采取了这样的形式进行部署，极大水平的压缩了须要我部署的工夫，还是十分值得的。

比起上次写的 应用 Jenkins 对 springboot 我的项目进行 docker 镜像一键部署,jenkins + docker + springboot 集成了更多的内容，也更加动态化。

因为流程很长，如果你在看这篇博客的时候有任何问题能够通过邮箱：tangym@runnable.run 分割我，我会提供我能帮忙到的。

1.1 实现的性能

• 一次构建，能够实现如下所有操作

checkout code → build jar package → push package to nexus → build docker image → push image to repositories → deploy → update pom.xml version

当中没有接入 SonarQube 或者 墨菲平安 之类的 stage 是因为我把这个部份做到了 code 一提交时触发的 GitHub Actions 中。

废话不多说，马上开始教程。

2. 搭建过程

2.1 筹备内容

搭建环境：

• 一个简略的 Spring Boot 我的项目，应用 Java17，我曾经筹备好了这个，倡议先 clone 到本地：https://github.com/MingGH/dem…
• 阿里云账号（推送 nexus 和 docker image）
• 一台曾经装置了 docker 的电脑或者服务器，如果服务器装置 docker 有难度，能够参考这篇博客：应用官网装置脚本主动装置

2.2 通过 Docker 装置 Jenkins

创立一个目录，用来存在 Jenkins 的数据

mkdir -p /dockerData/jenkins/jenkins-data

进入到/dockerData/jenkins 目录，咱们在这创立Dockerfile

cd /dockerData/jenkins
vim Dockerfile

复制以下内容到文件Dockerfile 中

FROM jenkins/jenkins:2.375.1
USER root
RUN apt-get update && apt-get install -y lsb-release
RUN curl -fsSLo /usr/share/keyrings/docker-archive-keyring.asc \
  https://download.docker.com/linux/debian/gpg
RUN echo "deb [arch=$(dpkg --print-architecture) \
  signed-by=/usr/share/keyrings/docker-archive-keyring.asc] \
  https://download.docker.com/linux/debian \
  $(lsb_release -cs) stable" > /etc/apt/sources.list.d/docker.list
RUN apt-get update && apt-get install -y docker-ce-cli
USER jenkins
RUN jenkins-plugin-cli --plugins "blueocean:1.26.0 docker-workflow:563.vd5d2e5c4007f"

从 Dockerfile 中构建镜像

docker build -t myjenkins-blueocean:2.375.1-1 .

构建实现之后，应用 docker images 能够看到刚刚构建的镜像。

运行一个 Jenkins 容器

docker run \
  -u root \
  --name jenkins \
  --restart=on-failure \
  --detach \
  --publish 8080:8080 \
  --publish 50000:50000 \
  --volume /etc/localtime:/etc/localtime \
  --volume /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker \
  --volume /dockerData/jenkins/jenkins-data:/var/jenkins_home \
  myjenkins-blueocean:2.375.1-1

对当中的一些参数进行解释：

• -u root 容器中的过程以 root 用户权限运行
• --restart=on-failure如果容器因为谬误而退出，则将其重新启动
• --detach 放弃容器在后盾继续运行
• --publish 8080:8080 映射宿主机 8080 端口给容器 8080 端口
• --publish 50000:50000映射宿主机 50000 端口给容器 50000 端口
• --volume /etc/localtime:/etc/localtime 容器工夫如何与宿主机同步
• --volume /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker 挂载宿主机的/var/run/docker.sock 给容器，这样 Jenkins 容器就能够调用宿主机的 docker，创立其余的容器服务于 CICD
• --volume /dockerData/jenkins/jenkins-data:/var/jenkins_home 挂载 Jenkins 容器的数据到宿主机目录下

解决 ECDSA host key is known for github.com and you have requested strict checking 问题

运行胜利之后，别急，还有一步须要操作，进入到 Jenkins 容器配置 ssh，如果不进行配置当拉取代码的时候会抛出异样 ECDSA host key is known for github.com and you have requested strict checking，你也能够在这篇文章找到更加具体的阐明：Jenkins 执行 pipeline 抛出异样 No ECDSA host key is known for github.com and you**

进入 Jenkins 容器并执行以下操作

docker exec -it -u root jenkins /bin/bash
mkdir -p /root/.ssh
cd ~/.ssh/
touch known_hostsknown_hosts
ssh-keyscan github.com >> ~/.ssh/known_hosts

你会看到以下输入，就示意 ok 了

而后输入 exit 能够间接推出容器

如果你是某某云的服务器，须要到某某云的控制台凋谢平安组端口能力进行拜访

当初咱们就能够以 ip+ 端口 的模式进行拜访到 Jenkins，关上浏览器http:// 服务器公网 ip:8080 提醒咱们须要输出明码。

咱们能够间接应用docker logs jenkins 拿到明码

2.3 Jenkins 配置：时区

抉择装置完举荐的插件之后，Jenkins 会进行重启，期待一段时间，而后刷新登录

时区配置

进入到 系统管理→脚本命令行

执行如下命令，设置时区为上海

System.setProperty('org.apache.commons.jelly.tags.fmt.timeZone', 'Asia/Shanghai')

2.4 Jenkins 配置：GitHub 凭据

回到系统管理，点击Manage Credentials

创立新的凭据

private-key 的起源：在部署 Jenkins 的服务器上生成对应的公钥

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

会有三个文件生成

而后公钥文件 id_rsa.pub 中的内容复制到 GitHub SSH 配置中

而后把私钥文件id_rsa 中的内容配置到刚刚 Jenkins 的那个中央

id_rsa 的文件内容相似：

-----BEGIN OPENSSH PRIVATE KEY-----

xxxxxxxxxxxxxxx==
-----END OPENSSH PRIVATE KEY-----

生成公钥的问题能够参考这篇博客：Git SSH 公钥配置

2.5 筹备阿里云效的 Maven 仓库

地址：https://packages.aliyun.com/maven

注册并登录进去之后，咱们能够看到有两个对应的仓库，生产库 -release 和 非生产库 -snapshot，别离用来寄存咱们不同环境的 jar 包，如果你的 pom.xml 中的 version 带 -snapshot，那么推送的就是 非生产库， 如果不带 -snapshot，推送的就是生产库。这里须要留神的是，生产库的 jar 包是不容许反复推送的。

点进 非生产库 -snapshot，在仓库指南中，咱们下载对应的 settings.xml 文件，这个文件当 Jenkins 须要推送 Jar 到 Maven 仓库的时候须要用到

在旁边的包文件列表能够看到之后 Jenkins 推送下来的包

将这个文件上传到服务器 /root/.m2/ 目录下

2.6 筹备 Docker容器镜像仓库

阿里云容器镜像服务地址：https://cr.console.aliyun.com/

登录之后抉择个人版

创立命名空间

创立 API 对应的镜像仓库

创立实现点击进去 根本信息 一栏有公网地址，这就是 Docker Image 须要推送的地址，咱们能够先复制进去。

设置明码

在个人版中，拜访凭证中，设置 固定明码，这个明码之后会在我的项目 demo-springboot-simple 中的deploy_docker.sh 用到。

之后 Jenkins 推送镜像上来，能够在这里 镜像版本 找到对应的镜像

3. 通过 pipeline 把下面内容都串起来

有了下面的筹备的内容，那咱们就能够通过 Jenkins pipeline 把这些内容都串在一起了。

3.1 Jenkins 新建 pipeline

再次登录 Jenkins，这次咱们新建一条 pipeline,pipeline 的名字就叫 API 的名字，这里大家照着我的配置一样的填写就行，须要留神的中央我会说进去。

点击确定后配置一些参数

增加参数化构建过程，总共会增加三个参数ENV_INFO，GIT_Branch，Deploy_Port

ENV_INFO

GIT_Branch

Deploy_Port

Pipeline script from SCM

点击新建，此时一条 pipeline 就创立胜利，是不是曾经急不可待的想点击 build 试试？等等，先听我把前面这一部份讲完，当呈现问题时才晓得去哪找解决方案

3.2 我的项目 demo-springboot-simple 解说

回到最开始须要让你下载那个我的项目：demo-springboot-simple

application-dev.yaml 和application-prod.yaml

我的项目是一个很简略的 Spring Boot 我的项目, 默认端口是5002。定义了两个不同的配置文件，别离是application-dev.yaml 和application-prod.yaml 用来模仿不同环境时切换不同的参数。

HelloController

创立了一个 HelloController 用来演示最简略的 GET 申请，会依据不同的部署环境，返回不同的内容。

HelloController 的内容如下：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import run.runnable.demospringbootsimple.config.AppConfig;

/**
 * @author Asher
 * on 2023/1/3
 */
@Controller
public class HelloController {@GetMapping("/hello")
    @ResponseBody
    public String hello(){return "hello" + appConfig.getEnv();
    }

    private AppConfig appConfig;
    @Autowired
    public void setAppConfig(AppConfig appConfig) {this.appConfig = appConfig;}
}

3.3 我的项目配置：Jenkinsfile (有须要批改内容)

当 Jenkins 在面板上点击构建时，会找到对应目录下的 Jenkinsfile, 所以第一个咱们须要阐明的就是 Jenkinsfile。

在 Jenkinsfile 中我定义了 7 个 stage, 别离是Build, Unit Test, Push Nexus, Package Image, Push Image, Deploy, Update version

当 Jenkins 进行 build 的时候就会呈现对应的这几个阶段。

这里因为篇幅过长，应用了新的一篇文章来进行解说：demo-springboot-simple 中 Jenkinsfile 详解

须要批改的内容为：

在这个 Update version Stage 中须要批改你的 git 邮箱地址和 username，因为在步骤 2.4 中曾经 配置了公钥在 GitHub 上 ， 且在 Jenkins agent 中配置了 /root/.ssh 的目录映射，所以这里只须要配置用户名和邮箱就行。

3.5 我的项目配置：deploy_docker.sh

说完了 Jenkinsfile，心愿你曾经明确 Jenkins 执行时的次要的流程，那么在 deploy_docker.sh 中的内容是 docker 部署到本地和 docker 推送到Docker 容器镜像仓库时的一些命令。

你须要配置的内容如图：

3.4 我的项目配置：pom.xml (有须要批改内容)

须要批改的配置

在 pom.xml 文件中你须要批改 properties 中的内容，

• docker.namespace是在阿里云的 Docker 容器镜像仓库时创立的。
• docker.registry.address 则是镜像仓库根本信息中的公网地址，例如：registry.cn-hangzhou.aliyuncs.com

<properties>
        <java.version>17</java.version>
        <docker.namespace></docker.namespace>
        <docker.registry.address></docker.registry.address>
    </properties>

在 plugin 中我减少了 dockerfile-maven-plugin，通过这个 plugin 能够应用 maven 构建 docker image，然而须要我的项目中存在 Dockerfile，这个会马上说到。

<plugin>
    <groupId>com.spotify</groupId>
    <artifactId>dockerfile-maven-plugin</artifactId>
    <version>1.4.13</version>
    <configuration>
        <repository>${docker.registry.address}/${docker.namespace}/${project.artifactId}</repository>
        <tag>${project.version}</tag>
        <buildArgs>
            <JAR_NAME>${project.artifactId}</JAR_NAME>
            <JAR_FILE>target/${project.build.finalName}.jar</JAR_FILE>
        </buildArgs>
    </configuration>
</plugin>

这里须要留神的是标签 <buildArgs> 下定义的<JAR_NAME> 和<JAR_FILE> 将会传递到 Dockerfile 中用于进行构建镜像

3.4 我的项目配置：Dockerfile (无批改)

Dockerfile 中配置了构建 image 时的一些参数，如下：

FROM openjdk:17-jdk-slim-buster

ARG JAR_NAME
ENV PROJECT_NAME ${JAR_NAME}
ENV PROJECT_HOME /usr/local/${PROJECT_NAME}

RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime
RUN echo 'Asia/Shanghai' >/etc/timezone
RUN mkdir $PROJECT_HOME && mkdir $PROJECT_HOME/logs

ARG JAR_FILE
COPY ${JAR_FILE} $PROJECT_HOME/${JAR_NAME}.jar

ENTRYPOINT java -jar -Xmn128m -Xms256m -Xmx256m $PROJECT_HOME/$PROJECT_NAME.jar

当中一些参数的解释，如果须要更加具体的阐明，能够参考这个：什么是 Dockerfile？

• FROM openjdk:17-jdk-slim-buster image 基于 openjdk:17-jdk-slim-buster
• ENV PROJECT_NAME ${JAR_NAME} 设置环境变量，定义了环境变量，那么在后续的指令中，就能够应用这个环境变量。这个参数 ${JAR_NAME}的起源是 pom.xml 中的<JAR_NAME>${project.artifactId}</JAR_NAME>
• RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime 指定容器运行时区
• RUN mkdir $PROJECT_HOME && mkdir $PROJECT_HOME/logs 创立我的项目门路
• COPY ${JAR_FILE} $PROJECT_HOME/${JAR_NAME}.jar 将 maven 构建进去的 Jar 文件复制到容器的具体位置
• ENTRYPOINT java -jar -Xmn128m -Xms256m -Xmx256m $PROJECT_HOME/$PROJECT_NAME.jar 容器的入口，通过 java -jar 进行启动，并指定运行时的一些参数

实现以上配置之后，提交你的代码到具体的分支。

4. Build with Parameters

终于到了最初一步，回到 Jenkins 的面板, 点击Build with Parameters, 填入你的参数，进行构建

此时你就能够看到 pipeline 曾经在跑了

执行实现的状态应该是所有的 stage 都是绿色，且在你服务器上能看到有一个新的容器产生

[root@ecs-205431 ~]# docker ps -s
CONTAINER ID   IMAGE                                                                          COMMAND                  CREATED         STATUS         PORTS                                       NAMES                        SIZE
9c0ee6e2726f   registry.cn-hangzhou.aliyuncs.com/xxxx/demo-springboot-simple:0.0.4-SNAPSHOT   "/bin/sh -c'java -j…"   3 minutes ago   Up 3 minutes   0.0.0.0:5002->5002/tcp, :::5002->5002/tcp   demo-springboot-simple-dev   32.8kB (virtual 419MB)

5. 问题排查

因为流程很长，呈现问题不要慌。间接点击那一个构建过程，进去看看日志。

6. 参考内容

The Problem With‘src refspec does not match any’

Error: src refspec master does not match any – How to Fix in Git

git 获取以后分支名

git: rename local branch failed

Change System Time Zone

Jenkins 分布式构建与并行构建

build-a-java-app-with-maven

Installing Jenkins

cut or awk command to print first field of first row

How to automatically increment pom version with maven, for example 1.2.0 to 1.3.0

Starting Spring Boot Application in Docker With Profile

应用 Jenkins 对 springboot 我的项目进行 docker 镜像一键部署,jenkins + docker + springboot