gitlab-runner 安裝使用

時間 2019-11-14

標籤 gitlab runner 安裝使用欄目 Git 简体版

原文原文鏈接

gitlab-runner 安裝使用

gitlab-runner 是一個開源的與 gitlab CI 配合使用的項目，用於運行任務，並將結果返回 gitlab
本文經過docker in docker的方式，即在具備特權模式的 Docker 中使用 Docker，經過 gitlab-runner 使用 docker 的來構建項目，完成打包，測試，發佈等任務。這樣 gitlab-runner 只是須要 Dockerfile 便可，可方便往後使用其餘 CI/CD 工具。同時本地調試也十分方便
文檔地址：https://docs.gitlab.com/runner

安裝

參考文檔 https://docs.gitlab.com/runner/install/docker.html

docker run -d --name gitlab-runner --restart always \
   -v /srv/gitlab-runner/config:/etc/gitlab-runner \
   -v /var/run/docker.sock:/var/run/docker.sock \
   gitlab/gitlab-runner:latest

註冊

安裝好 gitlab-runner 後，須要進行註冊，gitlab 纔會出現 runner 列表。註冊前須要準備好地址和 token，管理員進入管理中心>概覽>Runner可查看 runner 列表、url 和註冊令牌
若是想要爲某羣組或者項目設置 runner，可在對應羣組或者項目的設置>CI/CD>Runner獲取 url 和 token
首先進入容器交互模式

docker exec -it gitlab-runner bash

輸入命令gitlab-runner register進行註冊，按照提示和文檔說明一步步填寫便可
也可一條命令完成註冊

sudo gitlab-runner register \
  --non-interactive \
  --url "https://gitlab.com/" \
  --registration-token "PROJECT_REGISTRATION_TOKEN" \
  --executor "docker" \
  --docker-image alpine:latest \
  --description "docker-runner" \
  --tag-list "docker,aws" \
  --run-untagged="true" \
  --locked="false" \
  --access-level="not_protected"

註冊 runner 參考：https://docs.gitlab.com/runner/register/index.html#docker
docker 執行者：https://docs.gitlab.com/runner/executors/docker.html

配置

在配置文件/etc/gitlab-runner/config.toml中添加 privileged 標記，這樣能夠在容器中使用 docker 的一些功能
參考：https://docs.gitlab.com/runner/executors/docker.html#use-docker-in-docker-with-privileged-mode
其它命令：https://docs.gitlab.com/runner/commands/README.html

[[runners]]
  executor = "docker"
  [runners.docker]
    privileged = true

完整的例子

[[runners]]
  name = "docker-runner"
  url = "http://192.168.99.100:8900/"
  token = "zLBu8yXEFPGKaaasZopn"
  executor = "docker"
  clone_url = "http://192.168.99.100:8900/"
  [runners.custom_build_dir]
  [runners.docker]
    tls_verify = false
    image = "apline:latest"
    privileged = true
    disable_entrypoint_overwrite = false
    oom_kill_disable = false
    disable_cache = false
    volumes = ["/cache"]
    shm_size = 0

高級配置：https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section

環境變量

經過設置環境變量，讓 runner 執行的時候讀取，避免在源碼中記錄敏感信息
在羣組或者項目的設置中依次點擊設置>CI/CD>變量
在.gitlab-ci.yml文件中使用方式html

Shell Usage

bash/sh $variable

windows batch %variable%

PowerShell $env:variable
參考https://docs.gitlab.com/ce/ci/variables/README.html#via-the-ui
Dockerfile 中使用變量參考：https://docs.docker.com/engine/reference/builder/#arggit

Shell	Usage
bash/sh	$variable
windows batch	%variable%
PowerShell	$env:variable

添加 Dockerfile

文檔參考：https://docs.docker.com/engine/reference/builder/
項目中添加 Dockerfile，接收 Source、AppKey 兩個參數，並將其推送至 nuget 服務器

FROM mcr.microsoft.com/dotnet/core/sdk:2.2-stretch
ARG AppKey
ARG Source
WORKDIR /src
COPY ["A1/A1.csproj", "A1/"]
RUN dotnet restore "A1/A1.csproj"
COPY . .
WORKDIR /src/A1
RUN dotnet pack "A1" -c Release -o /app

WORKDIR /app
RUN dotnet nuget push *.nupkg -k ${AppKey} -s ${Source}

添加 .gitlab-ci.yml

項目中添加 CI/CD 配置，在 gitlab 中新建可選擇模板，選擇 docker 模板
文檔參考：https://docs.gitlab.com/ee/ci/yaml/README.html#validate-the-gitlab-ciyml

# This file is a template, and might need editing before it works on your project.
build-master:
  # Official docker image.
  image: docker:latest
  stage: build
  services:
    - docker:dind
  before_script:
    # - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
    - docker --version
    - echo $NugetAppKey
    - echo $NugetSource
  script:
    - docker build --build-arg AppKey=$NugetAppKey --build-arg Source=$NugetSource -t A1:latest .
  only:
    - master

問題

執行 docker build 的時候報錯：time="2019-07-19T01:20:27Z" level=error msg="failed to dial gRPC: cannot connect to the Docker daemon. Is 'docker daemon' running on this host?: dial tcp: lookup docker on 100.100.2.136:53: no such host"，這個須要配置 runner，讓容器跑在privileged模式，參考 https://docs.gitlab.com/runner/executors/docker.html#use-docker-in-docker-with-privileged-mode
runner 執行的時候須要拉取代碼，可是拉取的連接因爲種種緣由在容器內很難訪問，須要另外的設置或者代理才行。可是高級設置有個參數能夠設置拉取代碼的連接：clone_url。文檔：https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section 示例：

[[runners]]
  name = "ruby-2.1-docker"
  url = "https://CI/"
  token = "TOKEN"
  limit = 0
  executor = "docker"
  builds_dir = ""
  shell = ""
  environment = ["ENV=value", "LC_ALL=en_US.UTF-8"]
  clone_url = "http://gitlab.example.local"