Gitlab CI-CD自動化部署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 -y upgrade
yum -y install wget
yum -y install vim

2、Gitlab安裝

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

#（1）安裝並設定必要的依賴

sudo yum install -y curl policycoreutils-python openssh-server
sudo systemctl enable sshd
sudo systemctl start sshd

sudo firewall-cmd --permanent --add-service=http
sudo firewall-cmd --permanent --add-service=https
sudo systemctl reload firewalld

（2）安裝郵件服務

sudo yum install postfix
sudo systemctl enable postfix
sudo systemctl start postfix

（3）新增gitlab 映像

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

（4）安裝gitlab 安裝指令

rpm -i gitlab-ce-13.4.0-ce.0.el7.x86_64.rpm --nodeps --force

安裝成功後圖片：

#（5）修改gitlab設定檔指定伺服器ip與自訂連接埠

vim  /etc/gitlab/gitlab.rb

（6）重置並啟動GitLab

gitlab-ctl reconfigure
gitlab-ctl restart

提示"ok: run:"表示啟動成功

（7）訪問GitLab頁面

如果報502，等待一段時間後再刷新試試，一般約1-2分鐘左右。

本文設定的帳號：root ，新密碼：11112222

3、安裝Runner

（1）下載一個二進位檔案

sudo curl -L --output /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-amd64

（2）修改執行權限

sudo chmod a+x /usr/local/bin/gitlab-runner

（3）建立GitLab CI 使用者

sudo useradd --comment 'GitLab Runner' --create-home gitlab-runner --shell /bin/bash

（4）安裝並作為服務運行

sudo gitlab-runner install --user=gitlab-runner --working-directory=/home/gitlab-runner
sudo gitlab-runner start

如果遇到提示sudo: gitlab-runner: command not found，切換到root 用戶，可以去掉sudo 執行上面指令。

（5）註冊Runner

參考網址：https://docs.gitlab.com/runner/register/index.html
執行gitlab-runner register 指令：

[root@localhost bin]# gitlab-runner register
Runtime platform                                    arch=amd64 os=linux pid=21527 revision=4e1f20da version=13.4.0
Running in system-mode.

Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/):
http://192.168.56.10/

Please enter the gitlab-ci token for this runner:
PwF1sZPX_zsB-xChSKjH

Please enter the gitlab-ci description for this runner:
[localhost.localdomain]: test ci cd desc

Please enter the gitlab-ci tags for this runner (comma separated):
my-tag,other-tag

Registering runner... succeeded                     runner=PwF1sZPX
Please enter the executor: ssh, virtualbox, parallels, shell, docker-ssh, docker+machine, docker-ssh+machine, kubernetes, custom, docker:
docker

Please enter the default Docker image (e.g. ruby:2.6):
maven:3.3.9-jdk-8
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!

註：這裡選擇的docker方式，所以伺服器上還需要額外多安裝docker

#!/bin/bash
# 移除掉旧的版本
sudo yum remove docker \
                  docker-client \
                  docker-client-latest \
                  docker-common \
                  docker-latest \
                  docker-latest-logrotate \
                  docker-logrotate \
                  docker-selinux \
                  docker-engine-selinux \
                  docker-engine

# 删除所有旧的数据
sudo rm -rf /var/lib/docker

#  安装依赖包
sudo yum install -y yum-utils \
  device-mapper-persistent-data \
  lvm2

# 添加源，使用了阿里云镜像
sudo yum-config-manager \
    --add-repo \
    http://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo

# 配置缓存
sudo yum makecache fast

# 安装最新稳定版本的docker
sudo yum install -y docker-ce

# 配置镜像加速器
sudo mkdir -p /etc/docker
sudo tee /etc/docker/daemon.json <p>這裡註冊一個全域共享的Runner（管理員權限，複製伺服器位址和Token），所有專案都可以使用，或者也可以註冊專案層級單獨的Runner （進入專案Runner 設定頁面，複製位址和Token）。 <br></p><p><img src="/static/imghwm/default1.png" data-src="https://img.php.cn/upload/article/000/000/164/168379748034185.png?x-oss-process=image/resize,p_40" class="lazy" alt="Gitlab CI-CD自动化部署SpringBoot项目的方法"></p><p>註冊成功後，Runner 清單可以查看到註冊的Runner<br></p><p><img src="/static/imghwm/default1.png" data-src="https://img.php.cn/upload/article/000/000/164/168379748013802.png?x-oss-process=image/resize,p_40" class="lazy" alt="Gitlab CI-CD自动化部署SpringBoot项目的方法"></p><p>勾選：Run untagged jobs Indicates whether this runner can pick jobs without tags<br></p><p><img src="/static/imghwm/default1.png" data-src="https://img.php.cn/upload/article/000/000/164/168379748195337.png?x-oss-process=image/resize,p_40" class="lazy" alt="Gitlab CI-CD自动化部署SpringBoot项目的方法"></p>##4、安裝應用程式伺服器環境<h3 id="yisu3h-to218"></h3>（1）允許使用者遠端登入（可選）<p></p><pre class="brush:php;toolbar:false">vi /etc/ssh/sshd_config
修改：
PasswordAuthentication yes                      
PermitRootLogin yes

重启服务：
service sshd restart

（2）安裝JDK1.8

（2）解壓縮

tar -zxvf jdk-8u161-linux-x64.tar.gz
重命名：
mv jdk1.8.0_161 java1.8

（3）設定環境變數

vi /etc/profile

添加以下内容：
export JAVA_HOME=/usr/local/java1.8
export PATH=$JAVA_HOME/bin:$PATH
export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar
保存退出

source /etc/profile
java -version

（3 ) 安裝Maven3.3.9

（2）解壓縮

tar -zxvf apache-maven-3.3.9-bin.tar.gz 

重命名：
mv apache-maven-3.3.9 maven-3.3.9

（3）設定環境變數

vi /etc/profile

添加以下内容：
export MAVEN_HOME=/usr/local/maven-3.3.9
export PATH=$MAVEN_HOME/bin:$PATH
保存退出

source /etc/profile
mvn -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 包：

mkdir gitlab-project

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

# 定义一些变量, 下面各阶段会使用
variables:
  server_ip: 192.168.56.12
  jar_name: demo-0.0.1-SNAPSHOT.jar
  java_path: /usr/local/java1.8/bin
  upload_path: /usr/local/gitlab-project

# 定义执行的各个阶段及顺序
stages:
  - build
  - upload
  - deploy

# 使用 maven 镜像打包项目
maven-build:
  stage: build
  image: maven:3.5.0-jdk-8
  script:
    - mvn package -B -Dmaven.test.skip=true
  cache:
    key: m2-repo
    paths:
      - .m2/repository
  artifacts:
    paths: 
      - target/$jar_name

# 上传生成的 jar 包到你的应用服务器，这里使用 ictu/sshpass 这个镜像，是为了使用 sshpass 命令
upload-jar:
  stage: upload
  image: ictu/sshpass
  script: 
    - ls -l target/
    - sshpass -p $ssh_password scp -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no target/$jar_name root@$server_ip:$upload_path/$jar_name

# 启动 SpringBoot jar包
deploy-test:
  stage: deploy
  image: ictu/sshpass
  script:
    - sshpass -p $ssh_password ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no root@$server_ip "nohup $java_path/java -jar $upload_path/$jar_name >/dev/null 2>&1 &"

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

[root@localhost gitlab-project]# jps
22119 Jps
22073 demo-0.0.1-SNAPSHOT.jar
[root@localhost gitlab-project]# curl localhost:8080
Spring is here!

可能遇到的问题总结：

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

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

以上是Gitlab CI-CD自動化部署SpringBoot專案的方法的詳細內容。更多資訊請關注PHP中文網其他相關文章！