步驟簡(jiǎn)介
1 準(zhǔn)備工作
- 1.1. gitlab環(huán)境
- 1.2. 裝有
docker和gitlab-runner環(huán)境的云服務(wù)器（這里用到CentOS 7 64位） - 1.3. 項(xiàng)目代碼
- 1.4.
Dockerfile - 1.5.
.gitlab-ci.yml
2 環(huán)境配置
- 2.1. 配置權(quán)限
- 2.2. 為項(xiàng)目注冊(cè)執(zhí)行部署任務(wù)的Runner服務(wù)器
3 自動(dòng)部署
- 3.1. 提交代碼到git master分支
- 3.2. 等待Job任務(wù)完成
- 3.3 測(cè)試結(jié)果
背景
在網(wǎng)上查了很多資料，很大一部分資料，只是寫了一部分，或者是個(gè)例的文檔，不具備普適性。
本文做一個(gè)各種雜亂文章的整合和補(bǔ)充。
資料順序：
- 官方文檔
- 各種博客
官方文檔中是說(shuō)有三種方法可以實(shí)現(xiàn)gitlab ci 和 docker 的配置，本文寫的是第一種使用 shell的方式，這種也是最簡(jiǎn)單的一種方式。
簡(jiǎn)介
gitlab-ci全稱是gitlab continuous integration的意思，也就是持續(xù)集成。中心思想是當(dāng)每一次push到gitlab的時(shí)候，都會(huì)觸發(fā)一次腳本執(zhí)行，然后腳本的內(nèi)容包括了測(cè)試，編譯，部署等一系列自定義的內(nèi)容。本文就是利用gitlab-ci的持續(xù)集成來(lái)實(shí)現(xiàn)自動(dòng)部署。相比之前webhook的自動(dòng)部署還是強(qiáng)大以及方便了許多。
原理
自動(dòng)部署涉及了若干個(gè)角色，主要介紹如下
- GitLab-CI
這個(gè)是一套配合GitLab使用的持續(xù)集成系統(tǒng)，是GitLab自帶的，也就是你裝GitLab的那臺(tái)服務(wù)器上就帶有的。無(wú)需多考慮。.gitlab-ci.yml的腳本解析就由它來(lái)負(fù)責(zé)。 - GitLab-Runner
這個(gè)是腳本執(zhí)行的承載者，.gitlab-ci.yml的script部分的運(yùn)行就是由runner來(lái)負(fù)責(zé)的。GitLab-CI瀏覽過(guò)項(xiàng)目里的.gitlab-ci.yml文件之后，根據(jù)里面的規(guī)則，分配到各個(gè)Runner來(lái)運(yùn)行相應(yīng)的腳本script。這些腳本有的是測(cè)試項(xiàng)目用的，有的是部署用的。 - .gitlab-ci.yml
這個(gè)是在git項(xiàng)目的根目錄下的一個(gè)文件，記錄了一系列的階段和執(zhí)行規(guī)則。GitLab-CI在push后會(huì)解析它，根據(jù)里面的內(nèi)容調(diào)用runner來(lái)運(yùn)行。
1 準(zhǔn)備工作
1.1 gitlab環(huán)境
這個(gè)可以搭建私有g(shù)itlab空間，或者為了方便，可以使用官方的托管倉(cāng)庫(kù)。
gitlab 倉(cāng)庫(kù)搭好后，gitlab ci 就自動(dòng)安裝好了。（老版本不適用）
1.2 裝有docker和gitlab-runner環(huán)境的云服務(wù)器
-
安裝GitLab-Runner
官網(wǎng)有詳細(xì)的安裝步驟，鏈接如下：
https://docs.gitlab.com/runner/install/linux-repository.html
需要執(zhí)行如下命令，在centOS上安裝gitlab-ci-multi-runner
$ curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-ci-multi-runner/script.rpm.sh | sudo bash
$ yum install gitlab-ci-multi-runner
這樣就裝好了gitlab-ci-multi-runner
1.3 項(xiàng)目代碼
寫個(gè)helloworld就可。
1.4Dockerfile文件
首先是項(xiàng)目要添加docker支持，然后添加好Dockerfile文件，這個(gè)文件根據(jù)項(xiàng)目的不同可能略有不同，這個(gè)是springboot項(xiàng)目（hello-docker）的Dockerfile：
FROM openjdk:8-jdk-alpine
VOLUME /tmp
ADD hello-docker-0.0.1-SNAPSHOT.jar app.jar
ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app.jar"]
1.5. .gitlab-ci.yml文件
gitlab提供了一個(gè)很方便的配置工具，就是.gitlab-ci.yml， 將該文件放入到project的根目錄下即可。
以 Java springboot 項(xiàng)目為例，要配置一個(gè)生成 docke r鏡像的 job， 每次對(duì) project 打 tag 的時(shí)候就會(huì)觸發(fā) job 執(zhí)行，生成一個(gè)鏡像，鏡像的 version 是 tag的name.
.gitlab-ci.yml的內(nèi)容如下：
# 腳本執(zhí)行之后刪除該鏡像（為了不與下次鏡像打包沖突）
after_script:
- docker rmi $( docker images -q -f dangling=true)
# 定義幾個(gè)流程（job），這里是定義了三個(gè)自動(dòng)化流程
stages:
- build
- test
- deploy
job_build:
stage: build
script:
- mvn clean install
job_test:
stage: test
script:
- mvn test
job_deploy:
stage: deploy
script:
# 通過(guò)Dockerfile生成鏡像
- mvn package docker:build
# 刪除已經(jīng)在運(yùn)行的容器
- if [ $(docker ps -aq --filter name=hello-docker) ]; then docker rm -f hello-docker;fi
# 通過(guò)鏡像啟動(dòng)容器，并把本機(jī)端口映射到容器端口
- docker run -d -p 8070:8070 --name hello-docker gyq/hello-docker
only:
- master
only 規(guī)定了只有g(shù)it tags操作和triggers才能觸發(fā)任務(wù)
triggers可以在gitlab的project->settings->CI/DI Pipelines下添加，添加之后會(huì)生成一個(gè)token，使用這個(gè)token就可以隨時(shí)觸發(fā)一次job了，在測(cè)試的時(shí)候非常有用
tags 用來(lái)篩選符合條件的runners
默認(rèn)的script運(yùn)行的位置是project的根目錄，runner會(huì)先將整個(gè)project取下來(lái)，然后在project根目錄下運(yùn)行job.
更多.gitlab-ci.yml文件的用法可以參考官方的配置文檔
2 環(huán)境配置
2.1 配置權(quán)限
在runner上運(yùn)行任務(wù)的時(shí)候使用的是gitlab-runner賬戶，該賬戶沒(méi)有root權(quán)限，如果想使用更高的權(quán)限可以對(duì)gitlab-runner賬戶進(jìn)行提權(quán)。
這里因?yàn)橹挥衐ocker命令需要更高的權(quán)限，可以使用創(chuàng)建docker用戶組的方式解決。在runner上使用root賬戶執(zhí)行如下命令：
usermod -aG docker gitlab-runner
驗(yàn)證是否gitlab-runner有權(quán)訪問(wèn)Docker：
sudo -u gitlab-runner -H docker info
當(dāng)然也可以直接切換到 gitlab-runner 用戶中，查看 docker命令有沒(méi)有權(quán)限
權(quán)限這個(gè)問(wèn)題很重要，請(qǐng)務(wù)必設(shè)置
2.2 為項(xiàng)目注冊(cè)執(zhí)行部署任務(wù)的Runner服務(wù)器
向gitlab-CI注冊(cè)這個(gè)runner，不然gitlab-CI在push事件到來(lái)的時(shí)候怎么知道要調(diào)用誰(shuí)呢？這里也可以發(fā)現(xiàn)和webhook方式的區(qū)別，webhook方式是我們主動(dòng)配置了一個(gè)連接給gitlab；gitlab-runner只要注冊(cè)一下就好了。
那么我們就注冊(cè)一下
$ gitlab-ci-multi-runner register
#引導(dǎo)會(huì)讓你輸入gitlab的url，輸入自己的url，例如http://gitlab.example.com/
#引導(dǎo)會(huì)讓你輸入token，去相應(yīng)的項(xiàng)目下找到token，例如ase12c235qazd32
#引導(dǎo)會(huì)讓你輸入tag，一個(gè)項(xiàng)目可能有多個(gè)runner，是根據(jù)tag來(lái)區(qū)別runner的，輸入若干個(gè)就好了，比如web,hook,deploy
#引導(dǎo)會(huì)問(wèn)你是否無(wú)tag也觸發(fā)自動(dòng)部署，我這里為了方便測(cè)試，選擇的true
#引導(dǎo)會(huì)問(wèn)你是否鎖定此runner僅為此項(xiàng)目鎖定，我這里選的默認(rèn)否
#引導(dǎo)會(huì)讓你輸入executor，這個(gè)是要用什么方式來(lái)執(zhí)行腳本，輸入shell就好了。
然后就注冊(cè)好了，在gitlab中相應(yīng)的位置就可以看到你注冊(cè)好的runner信息。
3 提交更新，自動(dòng)部署
3.1. 提交代碼到git master分支
runner注冊(cè)成功后，通過(guò)git命令提交更新到master分支，只要master分支有修改，都會(huì)執(zhí)行Job的任務(wù)。
3.2. 等待Job任務(wù)完成
在gitlab頁(yè)面可以看到j(luò)ob的狀態(tài)，以及日志
3.3 測(cè)試結(jié)果
查看端口，檢查代碼的更新情況
參考文檔
[后端]gitlab之gitlab-ci自動(dòng)部署
使用Gitlab CI/DI 自動(dòng)生成docker鏡像
GitLab+Docker快速搭建CI/CD自動(dòng)化部署
