Gitlab CI-CD自动化部署SpringBoot项目的方法(CI-CD,gitlab,springboot,编程语言)

一、概述

本文主要记录如何通过Gitlab CI/CD自动部署SpringBoot项目jar包。

二、前期准备

准备三台 CentOS7服务器，分别部署以下服务：

序号系统IP服务1CentOS7192.168.56.10Gitlab2CentOS7192.168.56.11Runner （安装Docker）3CentOS7192.168.56.12SpringBoot 项目 jar 包（安装jdk、maven等）

上述服务也可以只用一台CentOS7，将所有程序都部署在同一机器上，但是更建议分开部署；

三、总体架构图

说明：

• Gitlab Server 用于部署Gitlab远程仓库，对CPU和内存要求比较高，建议4核CPU，4GB以上内存；

• Runner Server 用于部署执行.gitlab-ci.yml 文件中定义的 stage（阶段）；需要具有访问 Gitlab 仓库的权限，可以下载代码，通过注册方式（gitlab-runner register）实现；

• Your Laptop Server 用户部署你的应用程序，这里就是SpringBoot的 jar 包，需要提前安装 JDK 和 Maven 并配置好环境变量；
  

四、环境搭建

1、环境准备（可选）

三台服务器执行以下命令：

yum-yupgradeyum-yinstallwgetyum-yinstallvim

2、Gitlab安装

参考地址：
https://about.gitlab.com/install/#centos-7
https://www.xieniao.com/article/188877.htm

（1）安装并配置必要的依赖

sudoyuminstall-ycurlpolicycoreutils-pythonopenssh-serversudosystemctlenablesshdsudosystemctlstartsshdsudofirewall-cmd--permanent--add-service=httpsudofirewall-cmd--permanent--add-service=httpssudosystemctlreloadfirewalld

（2）安装邮件服务

sudoyuminstallpostfixsudosystemctlenablepostfixsudosystemctlstartpostfix

（3）添加 gitlab 镜像

wgethttps://mirrors.tuna.tsinghua.edu.cn/gitlab-ce/yum/el7/gitlab-ce-13.4.0-ce.0.el7.x86_64.rpm

（4）安装 gitlab 安装命令

rpm-igitlab-ce-13.4.0-ce.0.el7.x86_64.rpm--nodeps--force

安装成功后图片：

（5）修改gitlab配置文件指定服务器ip和自定义端口

vim/etc/gitlab/gitlab.rb

（6）重置并启动GitLab

gitlab-ctlreconfiguregitlab-ctlrestart

提示 "ok: run:"表示启动成功

（7）访问 GitLab页面

如果报502，等待一段时间后再刷新试试，一般1-2分钟左右。

本文设置的账号：root ，新密码：11112222

3、安装 Runner

（1）下载一个二进制文件

sudocurl-L--output/usr/local/bin/gitlab-runnerhttps://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-amd64

（2）修改执行权限

sudochmoda+x/usr/local/bin/gitlab-runner

（3）创建 GitLab CI 用户

sudouseradd--comment'GitLabRunner'--create-homegitlab-runner--shell/bin/bash

（4）安装并作为服务运行

sudogitlab-runnerinstall--user=gitlab-runner--working-directory=/home/gitlab-runnersudogitlab-runnerstart

如果遇到提示 sudo: gitlab-runner: command not found，切换到 root 用户，可以去掉 sudo 执行上面命令。

（5）注册 Runner

参考地址：https://docs.gitlab.com/runner/register/index.html
执行 gitlab-runner register 命令：

[root@localhostbin]#gitlab-runnerregisterRuntimeplatformarch=amd64os=linuxpid=21527revision=4e1f20daversion=13.4.0Runninginsystem-mode.Pleaseenterthegitlab-cicoordinatorURL(e.g.https://gitlab.com/):http://192.168.56.10/Pleaseenterthegitlab-citokenforthisrunner:PwF1sZPX_zsB-xChSKjHPleaseenterthegitlab-cidescriptionforthisrunner:[localhost.localdomain]:testcicddescPleaseenterthegitlab-citagsforthisrunner(commaseparated):my-tag,other-tagRegisteringrunner...succeededrunner=PwF1sZPXPleaseentertheexecutor:ssh,virtualbox,parallels,shell,docker-ssh,docker+machine,docker-ssh+machine,kubernetes,custom,docker:dockerPleaseenterthedefaultDockerimage(e.g.ruby:2.6):maven:3.3.9-jdk-8Runnerregisteredsuccessfully.Feelfreetostartit,butifit'srunningalreadytheconfigshouldbeautomaticallyreloaded!

注：这里选择的docker方式，所以服务器上还需要额外多安装docker

#!/bin/bash#移除掉旧的版本sudoyumremovedocker\docker-client\docker-client-latest\docker-common\docker-latest\docker-latest-logrotate\docker-logrotate\docker-selinux\docker-engine-selinux\docker-engine#删除所有旧的数据sudorm-rf/var/lib/docker#安装依赖包sudoyuminstall-yyum-utils\device-mapper-persistent-data\lvm2#添加源，使用了阿里云镜像sudoyum-config-manager\--add-repo\http://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo#配置缓存sudoyummakecachefast#安装最新稳定版本的dockersudoyuminstall-ydocker-ce#配置镜像加速器sudomkdir-p/etc/dockersudotee/etc/docker/daemon.json<<-'EOF'{"registry-mirrors":["http://hub-mirror.c.163.com"]}EOF#启动docker引擎并设置开机启动sudosystemctlstartdockersudosystemctlenabledocker#配置当前用户对docker的执行权限sudogroupadddockersudogpasswd-a${USER}dockersudosystemctlrestartdocker

这里注册一个全局共享的 Runner（管理员权限，复制服务器地址和 Token），所有项目都可以使用，或者也可以注册项目级别单独的 Runner （进入项目 Runner 设置页面，复制地址和 Token）。

注册成功后，Runner 列表可以查看到注册的 Runner

勾选：Run untagged jobs Indicates whether this runner can pick jobs without tags

4、安装应用服务器环境

（1）允许用户远程登录（可选）

vi/etc/ssh/sshd_config修改：PasswordAuthenticationyesPermitRootLoginyes重启服务：servicesshdrestart

（2）安装JDK1.8

（2）解压

tar-zxvfjdk-8u161-linux-x64.tar.gz重命名：mvjdk1.8.0_161java1.8

（3）配置环境变量

vi/etc/profile添加以下内容：exportJAVA_HOME=/usr/local/java1.8exportPATH=$JAVA_HOME/bin:$PATHexportCLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar保存退出source/etc/profilejava-version

（3） 安装 Maven3.3.9

（2）解压

tar-zxvfapache-maven-3.3.9-bin.tar.gz重命名：mvapache-maven-3.3.9maven-3.3.9

（3）配置环境变量

vi/etc/profile添加以下内容：exportMAVEN_HOME=/usr/local/maven-3.3.9exportPATH=$MAVEN_HOME/bin:$PATH保存退出source/etc/profilemvn-v

五、创建 SpringBoot 项目

1、使用Gitlab Spring 模板快速创建一个 SpringBoot 项目；

如果报错，删除pom.xml中的这行

报这个错的话：
[FATAL] Non-resolvable parent POM for com.example:demo:0.0.1-SNAPSHOT: Could not transfer artifact org.springframework.boot:spring-boot-starter-parent:pom:2.0.1.RELEASE from/to central (https://repo.maven.apache.org/maven2): Connect to repo.maven.apache.org:443 [repo.maven.apache.org/151.101.40.215] failed: Connection timed out (Connection timed out) and ‘parent.relativePath' points at wrong local POM @ line 14, column 10

修改版本
1.5.9.RELEASE

2、添加环境变量（登录应用服务器密码）

注： 其中 ssh_password 这个添加到环境变量中，取消勾选 Protect Branch （仅保护分支）；修改和添加都是默认勾选，需要取消，否则，其他分支不能读取到该变量；

先在应用服务器上创建一个目录，用于上传存放项目 jar 包：

mkdirgitlab-project

添加 .gitlab-ci.yml 文件时，可以先再 CI/CD Pipeline 中 的 CI Lint 中检验 .gitlab-ci.yml 文件格式

#定义一些变量,下面各阶段会使用variables:server_ip:192.168.56.12jar_name:demo-0.0.1-SNAPSHOT.jarjava_path:/usr/local/java1.8/binupload_path:/usr/local/gitlab-project#定义执行的各个阶段及顺序stages:-build-upload-deploy#使用maven镜像打包项目maven-build:stage:buildimage:maven:3.5.0-jdk-8script:-mvnpackage-B-Dmaven.test.skip=truecache:key:m2-repopaths:-.m2/repositoryartifacts:paths:-target/$jar_name#上传生成的jar包到你的应用服务器，这里使用ictu/sshpass这个镜像，是为了使用sshpass命令upload-jar:stage:uploadimage:ictu/sshpassscript:-ls-ltarget/-sshpass-p$ssh_passwordscp-oUserKnownHostsFile=/dev/null-oStrictHostKeyChecking=notarget/$jar_nameroot@$server_ip:$upload_path/$jar_name#启动SpringBootjar包deploy-test:stage:deployimage:ictu/sshpassscript:-sshpass-p$ssh_passwordssh-oUserKnownHostsFile=/dev/null-oStrictHostKeyChecking=noroot@$server_ip"nohup$java_path/java-jar$upload_path/$jar_name>/dev/null2>&1&"

这里使用了DockerHub上面的一个公共镜像（ictu/sshpass），主要是想使用启动自带的sshpass命令执行scp和ssh命令。
如果一切顺利的话，就会自动触发 CI/CD ；失败的话查看报错信息，可使用 Debug 模式执行调试命令 。

[root@localhostgitlab-project]#jps22119Jps22073demo-0.0.1-SNAPSHOT.jar[root@localhostgitlab-project]#curllocalhost:8080Springishere!

可能遇到的问题总结：

1. 权限问题：可以先使用 root 用户看看是不是权限问题导致，如果是的话，提升执行用户的权限；并发问题：这里没有修改 Runner 的并发数，可以修改同时可以进行的任务并发数；其他问题：读取不到配置的环境变量，取消勾选仅保护分支的选项；

2. 未执行job：没有勾选未配置 tags 也执行选项；

 </div> <div class="zixun-tj-product adv-bottom"></div> </div> </div> <div class="prve-next-news">