Docker Gitlab CI 部署 Spring Boot 專案
安裝 Gitlab CE 和 Gitlab Runner
若有現成環境,這一步可以忽略
用 Docker-Compose 進行安裝
version: '3' #1 services: gitlab: image: gitlab/gitlab-ce:latest #2 container_name: "gitlab" restart: unless-stopped privileged: true hostname: "172.17.193.109:7780" #3 environment: #4 GITLAB_OMNIBUS_CONFIG: | # external_url 'http://172.17.193.109:7780' gitlab_rails["time_zone"] = "Asia/Shanghai" gitlab_rails["gitlab_shell_ssh_port"] = 7722 nginx["listen_port"] = 80 #5 ports: - "7780:80" - "7722:22" #6 volumes: - /home/cache/gitlab/config:/etc/gitlab - /home/cache/gitlab/data:/var/opt/gitlab - /home/cache/gitlab/logs:/var/log/gitlab gitlab-runner: container_name: gitlab-runner image: gitlab/gitlab-runner:latest #7 restart: always volumes: - "/var/run/docker.sock:/var/run/docker.sock" - "/home/cache/gitlab/runner-config:/etc/gitlab-runner"
具體說明如下(docker-compose.yml 的檔案骨架這裡不做解釋):
#1:為 docker-compose 檔案的版本號,它和 docker 版本有一個對應,具體在 docker 官方文件中有明確說明。一般寫 3 就可以了。 #2:當前部署使用 Gitlab 官方最新版的映象。 #3:hostname 填寫的是部署成功後,Gitlab 的入口地址。由於我使用的 docker 不在本地,所以配置了一個 ip 地址,本地寫 localhost 就可以了。當前配置的意思為,通過 172.17.193.109 的 7780 埠訪問 Gitlab 頁面。 #4:GITLAB_OMNIBUS_CONFIG 為 Gitlab 的配置引數,對應 /etc/gitlab/gitlab.rb。該檔案下的所有鍵值對都可以在這裡進行配置,容器啟動時會自動配置進去。當然也可以在 Gitlab 容器啟動後,手動修改 gitlab.rb 檔案。 #5:配置了需要用到的兩個埠。預設 Gitlab 容器內部 80 埠用於 Gitlab 頁面的訪問,22 用於 ssh 連線遠端倉庫。分別對其進行外網對映。 #6:volume 對映,三個 volume 和官方文件一致就可以了。 #7:這裡用的是 gitlab-runner 映象,部分部落格使用的 gitlab-ci-multi-runner 是舊版本,最新的映象統一修改為 gitlab-runner。
接下來直接在 docker-compose.yml 的根目錄執行就 ok 了。
docker-compose up -d
建立一個 Spring Boot 專案
使用 Gitlab CI 構建的專案時一個基於 Spring Boot 的 hello world 專案,我們先把他創建出來。為了簡化這個過程,我們直接在新建專案的時候選擇 Spring Boot 模板,它會為我們生成一個 hello world 專案,並且包含了一個 Dockerfile。
專案結構上和我們手動建立的是一樣的。那麼這個時候準備工作基本上就做完了。在進入 Gitlab CI 的流程前,我們可以想象一下,在 Spring Boot 專案部署的過程中,有哪些步驟是可以讓 Gitlab CI 來完成的。我們最終的目的是,希望通過 Gitlab CI,直接可以將我們 push 到遠端倉庫的程式碼自動構建,並在一個新的容器中執行。那麼具體的步驟應該有 2 步:
拉取最新的程式碼,打包成 jar。
將 jar 容器化,進一步構建成為 Docker 映象並執行起來。
那麼接下來的操作就是圍繞著這兩步展開的。
配置 Runner
安裝完 Gitlab-Runner 並且建立好專案後,就需要為我們的專案註冊具體的 runner 來執行 CI 任務。
首先我們開啟,Gitlab 專案的設定 --->CI/CD--->Auto DevOps。看到 URL 和註冊令牌。
進入 gitlab-runner 容器內部(exec /bin/bash),執行 gitlab-runner register 開始註冊。
root@bb6040f1cd04:/# gitlab-runner register
Runtime platform arch=amd64 os=linux pid=43 revision=a987417a version=12.2.0
Running in system-mode.
Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/):
http://172.17.193.109:7780/
Please enter the gitlab-ci token for this runner:
zpzZ-shsCVxsJDZtAPNZ
Please enter the gitlab-ci description for this runner:
[bb6040f1cd04]: hello,spring boot!
Please enter the gitlab-ci tags for this runner (comma separated):
maven,docker
Registering runner... succeeded runner=zpzZ-shs
Please enter the executor: docker-ssh, shell, ssh, virtualbox, docker+machine, custom, parallels, docker-ssh+machine, kubernetes, docker:
docker
Please enter the default Docker image (e.g. ruby:2.6):
docker:latest
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!
根據步驟,依次輸入對應的值,顯示註冊成功則完成註冊。這個時候重新整理 Gitlab 頁面,可以看到剛剛註冊成功的 runner。
由於剛剛我們只是根據流程配置了一些基本的資訊,還有額外的引數要配置就需要修改對應的配置檔案了。可以直接修改對映到本地的 /home/cache/gitlab/runner-config 目錄下的 config.toml。每配置一個 runner 就會在配置檔案中生成一個 [[runners]]。
[[runners]]
name = "hello,spring boot!"
url = "http://172.17.193.109:7780/"
token = "u8_Y5rLQazUmBZar9eys"
executor = "docker"
[runners.custom_build_dir]
[runners.docker]
tls_verify = false
image = "docker:latest"
privileged = true #1
disable_entrypoint_overwrite = false
oom_kill_disable = false
disable_cache = false
volumes = ["/cache", "/home/cg/.m2:/root/.m2"] #2
shm_size = 0
[runners.cache]
[runners.cache.s3]
[runners.cache.gcs]
需要修改的地方:
#1:預設為 false,需改為 true。false 時,在 CI 構建的時候 會進行 health check,很耗時而且還是失敗,設為 true 就自動跳過了,其中原因暫未深究。
#2:如果本地有 maven 環境的話,可以掛在到本地,這樣在處理依賴時可以直接使用本地的環境,並且可以用阿里雲映象源。
那麼 runner 是需要觸發才能工作的,接下來就需要配置 Gitlab-CI 了 。
容器化與 Gitlab CI Auto DevOps 配置
容器化就是 jar 轉化為 Docker 映象的過程。我們講之前自動生成的 Dockerfile 修改一下:
FROM openjdk:8-jdk-alpine
VOLUME /tmp
COPY /target/demo-0.0.1-SNAPSHOT.jar app.jar
ENV PORT 5000
EXPOSE $PORT
ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-Dserver.port=${PORT}","-jar","/app.jar"]
然後新增 Gitlab CI 核心的配置檔案——.gitlab-ci.yml,並把它放在專案的根目錄下。Gitlab 專案在建立的時候,預設會開啟 Auto DevOps流水線,當有程式碼 push 到倉庫中去的時候會自動掃描根目錄下是否包含 .gitlab-ci.yml,如果有,會根據預定義的持續整合和持續交付配置自動化地構建、測試和部署應用程式。那麼下面來看具體的配置檔案:
image: docker:latest #1
variables: #2
DOCKER_DRIVER: overlay2
DOCKER_HOST: tcp://172.17.193.109:2375 # docker host,本地可不寫
TAG: root/hello-spring:v0.1 # 映象名稱
cache: #3
paths:
- .m2/repository
services: #4
- docker:dind
stages: #5
- package
- deploy
maven-package: #6
image: maven:3.5-jdk-8-alpine
tags:
- maven
stage: package
script:
- mvn clean package -Dmaven.test.skip=true
artifacts:
paths:
- target/*.jar
build-master: #7
tags:
- docker
stage: deploy
script:
- docker build -t $TAG .
- docker rm -f test || true
- docker run -d --name test -p 5000:5000 $TAG
only:
- master
具體說明:
#1:需要用到的映象
#2:必須配置的一些環境變數。如果本地可不配置 DOCKER_HOST。
#3:配置快取,配置後,maven 下載的依賴可以被快取起來,下次不需要重複去下載了。
#4:配置需要用到的額外的服務。docker:dind,這個貌似是用於在 docker 中執行 docker 的一種東西,在專案的構建中需要。
#5:stages,這是 Gitlab CI 中的概念,Stages 表示構建階段,就是一些按序執行的流程,具體執行是依賴於 Jobs 的。
#6 :定義的 Jobs 之一,用於構建 jar 包。內部又引入 maven 映象來處理,負責執行 package 這一流程。script 為具體執行的指令碼。
#7:定義的 Jobs 之一,用於構建 Docker 映象。負責執行 deploy 這一流程。具體執行 build 和 run。only 節點表示只監控 master 分支。
好了,所有的配置工作都已經完成了,接下來 Git 執行 commit&push,自動構建就開始了。回到 Gitlab 頁面就可以看到構建的過程。
可以看到,目前的 Auto DevOps 中的流水線已經觸發了,總共會一次執行兩個階段(package、deploy)。分階段可以檢視日誌。
兩個階段都完成後,可以直接在瀏覽器中訪問之前配置的 5000 埠,就能看見 hello,spring 的頁面了。