--- theme: channing-cyan --- ## 前言 > 本文如果对你有所帮助，求收藏、点赞、评论，转载请注明出处。 ## 前置介绍本文中使用的软硬件信息、项目简介如下： 1. 系统：CentOs 2. OpenJDK 版本：11 3. Jenkins 版本： 2.375.2 4. 项目架构：Egg + Vue2 + Typescript 给对 Linux 不熟悉的同学多说一句，命令行修改文件时，按“i”键进行编辑，修改完毕后，ESC 退出编辑，“:wq” 保存内容并退出，“:q” 不保存直接退出 ## 安装 ### JDK 安装之前如果安装过其它低版本需先卸载 #### 卸载查看是否已安装 OpenJDK ```shell rpm -qa | grep java rpm -qa | grep jdk ``` 批量卸载命令 ```shell rpm -qa | grep jdk | xargs rpm -e --nodeps rpm -qa | grep java | xargs rpm -e --nodeps ``` #### 安装安装方式有两种 ##### 通过 yum 安装 ```shell yum install -y java-11-openjdk java-11-openjdk-devel ``` 安装完成后执行下面的命令，查看安装目录 ```shell ls -l $(which java) ``` ![安装路径](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/aacde62544544a579276d60caf0f3f01~tplv-k3u1fbpfcp-watermark.image?) `/usr/lib/jvm/java-11-openjdk-11.0.18.0.10-1.el7_9.x86_64/bin/java` 就是我的 Java 的安装路径 ##### 自行下载后解压安装这种方式需要我们先下载好 OpenJDK，这里使用的版本是 `openjdk-11+28_linux-x64_bin.tar.gz` 下载好后，登录云服务器，创建目录 `/usr/java`，将刚刚下载的压缩包上传到该目录 ```shell mkdir /usr/java ``` 进入该目录，并解压文件 ```shell cd /usr/java/ tar -zxvf openjdk-11+28_linux-x64_bin.tar.gz ``` 这时候的安装路径就变成了 `/usr/java/jdk-11` #### 环境变量配置下面开始配置环境变量 ```shell vim /etc/profile ``` ![环境变量配置](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/fd23327e8d5d488ea28d6e20f5d3406b~tplv-k3u1fbpfcp-watermark.image?) 将 JAVA_HOME 配置成 Java 的安装路径（上一步的安装路径）保存后，执行以下命令，使环境变量生效 ```shell source /etc/profile ``` ### Jenkins 安装同样的，如果之前有安装并运行过 Jenkins 也需要先卸载 #### 卸载 ```shell # 停止已启动的 Jenkins 服务 systemctl stop jenkins.service # 卸载 Jenkins 包 rpm -e jenkins # 查看是否还有jenkins依赖，有就删除 rpm -qa | grep jenkins # 以下目录/文件是我本机之前安装的Jenkins（不同版本、系统可能有差异） rm -rf /etc/sysconfig/jenkins.rpmsave rm -rf /var/cache/jenkins/ rm -rf /var/lib/jenkins/ rm -rf /var/log/jenkins rm -rf /usr/lib/jenkins ``` #### 安装方式有多种，这里提供 rpm 的安装方式 1. 先下载 Jenkins 的 rpm 包到本地，推荐从 [清华的镜像站点](https://mirrors.tuna.tsinghua.edu.cn/jenkins/redhat-stable/) 下载 Jenkins 包（这里我下的版本是 `jenkins-2.375.2-1.1.noarch.rpm`） ![Jenkins rpm包](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/2cb154e420254d4ab013447463acd232~tplv-k3u1fbpfcp-watermark.image?) 2. 在你的云服务器上创建目录 `mkdir /usr/local/jenkins` 并上传刚刚下载的 rpm 包，上传好后切换到 `/usr/local/jenkins` 目录下，执行以下命令开始安装 ```shell rpm -ivh jenkins-2.370-1.1.noarch.rpm ``` 3. 查看 Jenkins 安装路径 ```shell rpm -ql jenkins ``` 路径释义 ```shell /usr/lib/jenkins/ # jenkins安装目录，war包会放在这里。 /etc/sysconfig/jenkins # jenkins配置文件，“端口”，“JENKINS_HOME” 等都可以在这里配置。 /var/lib/jenkins # 默认的JENKINS_HOME。 /var/log/jenkins/jenkins.log：jenkins日志文件。 /var/cache/jenkins # jenkins war解压路径。 ``` ## Jenkins 启动前配置安装完成后，Jenkins 默认账号名是 jenkins（不是登录账号），默认端口为：8080 ### 修改端口、账号名（非必要）如果需要修改，执行以下命令，修改配置文件 ```shell vim /etc/sysconfig/jenkins ``` 如下图，JENKINS_USER 是账号名，JENKINS_PORT 就是端口号 ![sysconfig jenkins配置](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7725052685e7427ea665ae0ce208e270~tplv-k3u1fbpfcp-watermark.image?) 修改完成后，执行 `daemon-reload` 命令重新加载使配置生效 ```shell systemctl daemon-reload ``` 然后，修改一下目录权限，防止意外情况 ```shell chmod -R 777 /var/lib/jenkins chmod -R 777 /var/cache/jenkins chmod -R 777 /var/log/jenkins ``` 记得放开云服务器防火墙对 Jenkins 端口的限制如果，启动服务后发现修改的端口配置没有生效，需要再去 `/usr/lib/systemd/system/jenkins.service` 修改一下端口 ```shell vim /usr/lib/systemd/system/jenkins.service ``` 找到 `Environment="JENKINS_PORT=8080"` 修改 ![jenkins 服务配置](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/3af7c67534f742c5a3ba25349826c273~tplv-k3u1fbpfcp-watermark.image?) 修改完成后，同样执行 `daemon-reload` 命令重新加载使配置生效，再重启一下 Jenkins ```shell service jenkins restart ``` ### 修改 Jenkins 更新配置 1. 联网配置 jenkins 安装更新时，默认会检查网络连接，默认的 `checkulr` 是 `http://www.google.com/` ，国内无法访问，我们把 url 改成国内可访问的地址即可，如 `http://www.baidu.com` 修改 jenkins 配置文件：`.jenkins/updates/default.json` ```shell vim .jenkins/updates/default.json ``` 2. 更新配置默认是国外的源，国内下载可能失败，建议更换 ```shell vim /var/jenkins_home/hudson.model.UpdateCenter.xml ``` ```xml bash-4.4# cat /var/jenkins_home/hudson.model.UpdateCenter.xml default https://updates.jenkins.io/update-center.json ``` 将 url 更换为 `https://mirrors.tuna.tsinghua.edu.cn/jenkins/updates/update-center.json` ## Jenkins 初始化配置访问 Jenkins 地址，就能看到如下画面 ![jenkins welcome（网图）](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8d48d65ca72a4b25900fcf84649c1fcf~tplv-k3u1fbpfcp-watermark.image?) 根据提示，前往 `/var/lib/jenkins/secrets` 目录查看密码 ```shell cat /var/lib/jenkins/secrets/initialAdminPassword ``` 注册你自己的管理员账号（忘记截图了）这里我直接选择安装推荐插件（又忘截图了） ## SSH Keys 配置为方便 Jenkins 从 github 上拉取代码，避免使用密码，这里使用 ssh ### 生成凭证 1. 输入以下命令，双引号内是你登录 github 的邮箱地址 ```shell ssh-keygen -t rsa -C “123456@qq.com” ``` 2. 会出现让输入两次密码的操作，直接按回车跳过。 SSH 凭证生成成功，生成的秘钥存储在 `/root/.ssh` 路径下 - 公钥文件：id_rsa.pub - 私钥文件：id_rsa ### 公钥配置到 Github 复制 `id_rsa.pub` 中的内容，将公钥的内容配置到 GitHub Settings > SSH and GPG keys ![github ssh](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ed6ed7bc409d4584bfaef12e00c87e92~tplv-k3u1fbpfcp-watermark.image?) 右上角点击 `New SSH key`，名称随意，Key 中黏贴 `id_rsa.pub` 中的内容 ![github new ssh](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/78970ed73367456cb4e976f1f194600e~tplv-k3u1fbpfcp-watermark.image?) ### 私钥配置到 Jenkins 1. 配置凭据（Manage Jenkins > Manage credentials） ![凭据配置](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/70ee538d2acd47498fb2e49504d0bd9c~tplv-k3u1fbpfcp-watermark.image?) 2. 点击全局，在全局域下新建一个凭据 ![凭据列表](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/870cfd70846540f7b0f47f4c3840f30a~tplv-k3u1fbpfcp-watermark.image?) 3. 新建凭据 ![新建凭据](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/9101320aea354fae83e2b38745e473c0~tplv-k3u1fbpfcp-watermark.image?) 类型选择 `SSH Username with private key` ![凭据类型](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ed9dbe9b85f44c898305954bba4c561b~tplv-k3u1fbpfcp-watermark.image?) 在私钥那里点击 `Enter directly`，将私钥文件 `id_rsa` 中的内容粘贴上去 ![私钥填写](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/2c82679335c948398607aba9fe4340fb~tplv-k3u1fbpfcp-watermark.image?) 到这里我们就配置好凭据了 ### 绕过新版 Jenkins 的安全校验在配置构建任务时，Jenkins 会对 github 地址进行校验，这里是为了防止校验失败地址与凭据都是正确的，新版加强了安全校验，索性不校验了 1. 在配置页面，找到全局安全配置 ![jenkins 安全配置](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/3b35c26aceb54483a5ddb8313408b824~tplv-k3u1fbpfcp-watermark.image?) 2. 直接拖到最底部，在 `Git Host Key Verification Configuration` 处选择 `No verification`，点击保存或应用 ![GitHub check](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8d362d1cb63943a58872e446051b2cb9~tplv-k3u1fbpfcp-watermark.image?) ## 创建任务配置基本完成，接下来就开始创建任务了 ### Pipeline 这里我使用的是 Pipeline，能直观地看到构建情况 ![新建任务](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/235ee7d9631549abb2b776ccfa834fdd~tplv-k3u1fbpfcp-watermark.image?) 创建后开始配置任务，这里讲一下 Pipeline 的配置，允许直接在配置中编写 pipeline 语句，也可以选择读取文件中语句，我这里选择的是读取 Git 项目中的文件在 Repositories 中填入你 Git 项目的 SSH 路径，凭据选择我们上一步创建的全局凭据；如果没有绕过 Jenkins 的安全校验，这里选择完凭据后会报错 ![Pipeline Setting](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/0fafaf628433424f8facef0384c8724f~tplv-k3u1fbpfcp-watermark.image?) 可以修改读取的分支（默认 master）与 pipeline 脚本文件所在的路径（默认就是放在根目录下的 Jenkinsfile） ![Pipeline Setting](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8aeb05d879b24fc789da06806d9ef4b7~tplv-k3u1fbpfcp-watermark.image?) ### WebHook 这一配置是实现 Github 到 Jenkins 自动化的关键，达到的效果就是 Git 项目完成一次 Push 操作后，Jenkins 中对应的任务就开始构建 #### 插件安装在配置中选择插件管理 ![插件管理](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/46a281575fc04bef9e470547de3c6044~tplv-k3u1fbpfcp-watermark.image?) 在可用插件中直接搜索 `Generic Webhook Trigger`，安装插件 ![webhook plugin](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/420ed81ce8d1429cae4792340748db37~tplv-k3u1fbpfcp-watermark.image?) #### 任务配置回到任务配置中，在构建触发器这里选择 `Generic Webhook Trigger` ![webhook trigger](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/30c9531b00204c31999ed9c5e6900c6e~tplv-k3u1fbpfcp-watermark.image?) `http://JENKINS_URL/generic-webhook-trigger/invoke` 这个就是触发构建的地址，JENKINS_URL 需要替换为你 Jenkins 服务运行的地址这个插件还有 token 等可选配置，感兴趣可以自行探索，这里就不深入了 #### Git 配置进入 GitHub 项目中，在设置里找到 Webhooks ![github webhooks](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/18e88a72d27f44c1b9a9d2a629ab2eee~tplv-k3u1fbpfcp-watermark.image?) 在 Payload URL 中填入触发构建地址，`http://JENKINS_URL/generic-webhook-trigger/invoke` 注意这里的 JENKINS_URL 需要替换为你 Jenkins 服务运行的地址 ![github webhooks](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/c96e830a8d5141a78457416c6c80ef5e~tplv-k3u1fbpfcp-watermark.image?) (如果填写完后 Git 校验不通过，试着去任务配置里加上 token 配置，invoke url 上也加上 token 参数) ### Node 环境你没有看错，就是在 Jenkins 下创建一个 node 环境，因为我的 pipeline 脚本中会直接运行 npm，干脆直接放到 Jenkins 中，省的在云服务器上安装了 #### 插件安装借助插件完成在可用插件中直接搜索 `NodeJS Plugin`，安装插件我这里已经安装了，就不截图了 #### Node 配置在系统管理中找到 `全局工作配置` ![全局工具配置](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/eca8e9d08e5b4a2eacd0c1b425e3e6d2~tplv-k3u1fbpfcp-watermark.image?) 在 NodeJS 那一栏，点击新增，选择你需要的 node 版本并填写别名 ![NodeJS](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/fe92e8417b1d4977be287171a6140cef~tplv-k3u1fbpfcp-watermark.image?) 如果需要多个版本就继续点击新增，后续在 Pipeline 使用中，是直接使用的别名，所以最好起个一眼就能看出版本的名字 ## Pipeline 脚本文件直接在项目根目录下创建 Jenkinsfile 文件 ![项目目录](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/a5d78c747feb4b0984c8cf826423c01d~tplv-k3u1fbpfcp-watermark.image?) ### Jenkinsfile 语法（Declarative）先来简单了解一下这个语法，不感兴趣也可以略过啦，不影响使用 Jenkinsfile 支持两种语法形式： - Declarative pipeline – 在 pipeline v2.5 之后引入，结构化方式，比较简单，容易上手。这种类似于我们在做自动化测试时所接触的关键字驱动模式，只要理解其定义好的关键词，按要求填充数据即可。入门容易，但是灵活性欠缺。 - Scripted pipeline – 基于 grjoovy 的语法，相较于 Declarative，扩展性比较高，好封装，但是有些难度，需要一定的编程工具我这里使用的是 Declarative，所以主要介绍 Declarative 语法 - 必须包含在固定格式 Pipeline{} 块内，每个声明语句必须独立一行，行尾无需使用分号。 - 块 blocks{} 只能包含章节（Sections），指令（Directves），步骤（Steps）或赋值语句 #### agent：节点必须存在，agent 必须在 pipeline 块内的顶层定义 - any ：可以在任意 agent 上执行 pipeline - none ：pipeline 将不分配全局 agent，每个 stage 分配自己的 agent - label ：指定运行节点的 label - node：自定义运行节点配置，指定 label ，指定 customWorkspace(工作空间) - docker：控制目标节点上的 docker 运行相关内容 #### stages：阶段集必须存在，包含顺序执行的一个或者多个 stage 命令在 pipeline 内仅能使用一次需要定义 stage 的名字 #### steps：步骤必须存在 steps 位于 stage 指令块内部，包含一个或者多个 step ```Declarative stages { stage("stage name"){ steps{ echo "this is a step" } } } ``` #### post：构建后的操作非必须 - always：无论 pipeline 运行的完成的状态如何都会运行 - success：仅当当前 pipeline 具有成功状态时才运行 - failure: 仅当当前 pipeline 具有失败状态时才运行当然还有其他选项，这里不再做扩展介绍； #### parameters：参数非必须参数化构建的参数设置，参数类型有 booleanParam、choice(选择)、file、text、string 等 ```Declarative parameters{ string( name :'name',defaultValue:'beauty',description:'姓名是') } ``` #### triggers：触发器非必须定义了 pipeline 自动化触发的方式 - cron：接受一个 cron 风格的字符串来定义 pipeline 触发的常规间隔 - pollSCM：接受一个 cron 风格的字符串来定义 jenkins 检查 SCM 源更改的常规间隔；如果存在新的更改，则 pipeline 将被重新触发 ```Declarative triggers{ cron('_/1 _ \* \* \*') } ``` 每隔一分钟执行一次 ```Declarative triggers{ pollSCM('_/1 _ \* \* \*') } ``` 每隔一分钟监控 SCM 源，更改即触发 ### 编写我将构建部署拆分为了 4 个阶段 #### 拉取代码这里直接使用 git 命令即可 ```Declarative git branch: 'master', credentialsId: 'xxx', url: 'git@github.com:LuciferHuang/xxx.git' ``` credentialsId 就是我们前面设置的全局凭据自动生成的 id，如下图 ![credentialsId](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/c4dfbc418e9244b2bae17f58a796c3fa~tplv-k3u1fbpfcp-watermark.image?) #### 项目构建主要干一件事，就是构建 egg 项目安装依赖，执行 `npm run build`，构建完成后删除依赖 #### docker 构建我的 egg 项目中直接使用了 docker 接管项目运行因此，这一步就是执行 docker 命令生成镜像 #### docker 运行这里分成两步 1. 先停止原先运行的 docker 容器（防止占用端口） 2. 使用 run 命令创建并运行 docker 容器 #### 完整脚本 ```Declarative pipeline{ agent any tools { nodejs 'NodeJS_14.17.6' } stages{ stage("pull"){ steps { sh 'sudo rm -rf public' sh 'sudo rm -rf logs' git branch: 'master', credentialsId: 'xxx', url: 'git@github.com:LuciferHuang/xxx.git' } } stage("project build"){ steps { sh 'npm install' sh 'npm run build' sh 'sudo rm -rf node_modules' } } stage("docker build"){ steps { sh 'docker build -t xxx:v${BUILD_NUMBER} . ' } } stage("docker run"){ steps { sh 'docker stop $(docker ps -a -q)' sh 'docker run -p 80:80 --name xxx_v${BUILD_NUMBER} -d xxx:v${BUILD_NUMBER}' } } } } ``` tools 中使用的 nodejs 就是前面的步骤配置的 NodeJS 别名 BUILD_NUMBER 是当前任务的构建版本号，脚本仅供参考，自行按需修改 ## 结语到这里就成功搭建好了，修改一下代码 push 上去，就能看到效果了 ![完结撒花](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/e89636eca0bf4d54ac2adfd87e2e00a3~tplv-k3u1fbpfcp-watermark.image?) 偶尔会无法触发自动构建，可以进 Github 项目的 WebHooks 查看最近的触发情况 ![webhook触发情况](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ce9972132e2e4c4ba54075eff265997d~tplv-k3u1fbpfcp-watermark.image?) > 文章同时发在个人公众号，欢迎关注 **MelonField** ## 附录 1. 清华大学开源软件镜像站（Jenkins 包）（[https://mirrors.tuna.tsinghua.edu.cn/jenkins/redhat-stable/](https://mirrors.tuna.tsinghua.edu.cn/jenkins/redhat-stable/)） ## 参考链接 1. https://melonfield.cn/column/detail/cv3I7PBRIgh 2. https://blog.csdn.net/qq_15283475/article/details/127284810 3. https://blog.csdn.net/qq_34777982/article/details/119941926 4. https://blog.csdn.net/qq_36613617/article/details/128053526 5. https://www.easck.com/cos/2021/0928/890051.shtml