Gitlab CI-CD自動(dòng)化部署SpringBoot項(xiàng)目的方法

今天小編給大家分享一下Gitlab CI-CD自動(dòng)化部署SpringBoot項(xiàng)目的方法的相關(guān)知識(shí)點(diǎn)，內(nèi)容詳細(xì)，邏輯清晰，相信大部分人都還太了解這方面的知識(shí)，所以分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后有所收獲，下面我們一起來(lái)了解一下吧。

一、概述

本文主要記錄如何通過(guò)Gitlab CI/CD自動(dòng)部署SpringBoot項(xiàng)目jar包。

二、前期準(zhǔn)備

準(zhǔn)備三臺(tái) CentOS7服務(wù)器，分別部署以下服務(wù)：

上述服務(wù)也可以只用一臺(tái)CentOS7，將所有程序都部署在同一機(jī)器上，但是更建議分開部署；

三、總體架構(gòu)圖

說(shuō)明：

• Gitlab Server 用于部署Gitlab遠(yuǎn)程倉(cāng)庫(kù)，對(duì)CPU和內(nèi)存要求比較高，建議4核CPU，4GB以上內(nèi)存；

• Runner Server 用于部署執(zhí)行.gitlab-ci.yml 文件中定義的 stage（階段）；需要具有訪問(wèn) Gitlab 倉(cāng)庫(kù)的權(quán)限，可以下載代碼，通過(guò)注冊(cè)方式（gitlab-runner register）實(shí)現(xiàn)；

• Your Laptop Server 用戶部署你的應(yīng)用程序，這里就是SpringBoot的 jar 包，需要提前安裝 JDK 和 Maven 并配置好環(huán)境變量；
  

四、環(huán)境搭建

1、環(huán)境準(zhǔn)備（可選）

三臺(tái)服務(wù)器執(zhí)行以下命令：

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）安裝郵件服務(wù)

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配置文件指定服務(wù)器ip和自定義端口

vim  /etc/gitlab/gitlab.rb

（6）重置并啟動(dòng)GitLab

gitlab-ctl reconfigure
gitlab-ctl restart

提示 "ok: run:"表示啟動(dòng)成功

（7）訪問(wèn) GitLab頁(yè)面

如果報(bào)502，等待一段時(shí)間后再刷新試試，一般1-2分鐘左右。

本文設(shè)置的賬號(hào)：root ，新密碼：11112222

3、安裝 Runner

（1）下載一個(gè)二進(jìn)制文件

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

（2）修改執(zhí)行權(quán)限

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

（3）創(chuàng)建 GitLab CI 用戶

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

（4）安裝并作為服務(wù)運(yùn)行

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

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

（5）注冊(cè) Runner

參考地址：https://docs.gitlab.com/runner/register/index.html
執(zhí)行 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方式，所以服務(wù)器上還需要額外多安裝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

# 刪除所有舊的數(shù)據(jù)
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

# 安裝最新穩(wěn)定版本的docker
sudo yum install -y docker-ce

# 配置鏡像加速器
sudo mkdir -p /etc/docker
sudo tee /etc/docker/daemon.json <<-'EOF'
{
  "registry-mirrors": ["http://hub-mirror.c.163.com"]
}
EOF

# 啟動(dòng)docker引擎并設(shè)置開機(jī)啟動(dòng)
sudo systemctl start docker
sudo systemctl enable docker

# 配置當(dāng)前用戶對(duì)docker的執(zhí)行權(quán)限
sudo groupadd docker
sudo gpasswd -a ${USER} docker
sudo systemctl restart docker

這里注冊(cè)一個(gè)全局共享的 Runner（管理員權(quán)限，復(fù)制服務(wù)器地址和 Token），所有項(xiàng)目都可以使用，或者也可以注冊(cè)項(xiàng)目級(jí)別單獨(dú)的 Runner （進(jìn)入項(xiàng)目 Runner 設(shè)置頁(yè)面，復(fù)制地址和 Token）。

注冊(cè)成功后，Runner 列表可以查看到注冊(cè)的 Runner

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

4、安裝應(yīng)用服務(wù)器環(huán)境

（1）允許用戶遠(yuǎn)程登錄（可選）

vi /etc/ssh/sshd_config
修改：
PasswordAuthentication yes                      
PermitRootLogin yes

重啟服務(wù)：
service sshd restart

（2）安裝JDK1.8

（2）解壓

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

（3）配置環(huán)境變量

vi /etc/profile

添加以下內(nèi)容：
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）配置環(huán)境變量

vi /etc/profile

添加以下內(nèi)容：
export MAVEN_HOME=/usr/local/maven-3.3.9
export PATH=$MAVEN_HOME/bin:$PATH
保存退出

source /etc/profile
mvn -v

五、創(chuàng)建 SpringBoot 項(xiàng)目

1、使用Gitlab Spring 模板快速創(chuàng)建一個(gè) SpringBoot 項(xiàng)目；

如果報(bào)錯(cuò)，刪除pom.xml中的這行

報(bào)這個(gè)錯(cuò)的話：
[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、添加環(huán)境變量（登錄應(yīng)用服務(wù)器密碼）

注： 其中 ssh_password 這個(gè)添加到環(huán)境變量中，取消勾選 Protect Branch （僅保護(hù)分支）；修改和添加都是默認(rèn)勾選，需要取消，否則，其他分支不能讀取到該變量；

先在應(yīng)用服務(wù)器上創(chuàng)建一個(gè)目錄，用于上傳存放項(xiàng)目 jar 包：

mkdir gitlab-project

添加 .gitlab-ci.yml 文件時(shí)，可以先再 CI/CD Pipeline 中 的 CI Lint 中檢驗(yàn) .gitlab-ci.yml 文件格式

# 定義一些變量, 下面各階段會(huì)使用
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

# 定義執(zhí)行的各個(gè)階段及順序
stages:
  - build
  - upload
  - deploy

# 使用 maven 鏡像打包項(xiàng)目
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 包到你的應(yīng)用服務(wù)器，這里使用 ictu/sshpass 這個(gè)鏡像，是為了使用 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

# 啟動(dòng) 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上面的一個(gè)公共鏡像（ictu/sshpass），主要是想使用啟動(dòng)自帶的sshpass命令執(zhí)行scp和ssh命令。
如果一切順利的話，就會(huì)自動(dòng)觸發(fā) CI/CD ；失敗的話查看報(bào)錯(cuò)信息，可使用 Debug 模式執(zhí)行調(diào)試命令 。

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

可能遇到的問(wèn)題總結(jié)：

1. 權(quán)限問(wèn)題：可以先使用 root 用戶看看是不是權(quán)限問(wèn)題導(dǎo)致，如果是的話，提升執(zhí)行用戶的權(quán)限；并發(fā)問(wèn)題：這里沒(méi)有修改 Runner 的并發(fā)數(shù)，可以修改同時(shí)可以進(jìn)行的任務(wù)并發(fā)數(shù)；其他問(wèn)題：讀取不到配置的環(huán)境變量，取消勾選僅保護(hù)分支的選項(xiàng)；

2. 未執(zhí)行job：沒(méi)有勾選未配置 tags 也執(zhí)行選項(xiàng)；

以上就是“Gitlab CI-CD自動(dòng)化部署SpringBoot項(xiàng)目的方法”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家閱讀完這篇文章都有很大的收獲，小編每天都會(huì)為大家更新不同的知識(shí)，如果還想學(xué)習(xí)更多的知識(shí)，請(qǐng)關(guān)注億速云行業(yè)資訊頻道。