gitlab-Runner配置參數詳解

使用主機安裝查看runner配置

　　$ cat /etc/gitlab-runner/config.toml

　　　　[session_server]（區段是一個系統 Runner 級別的配置，因此它應該在根級別指定，而不是在每個執行器上，也就是說，它應該在[[runners]]區段之外。會話服務器允許用戶與運行程序負責的作業進行交互。交互式web終端就是一個很好的例子。）
　　　　| listen_address | 用於會話服務器的內部URL。 |
　　　　| advertise_address | Runner 將公開給GitLab用於訪問會話服務器的URL。返回listen_address(如果沒有定義)。 |
　　　　| session_timeout | 作業完成后會話保持活動的時間(這會阻止作業完成)，默認為1800(30分鍾)。 |　

　　　　[runners]
　　　　| url | GitLab URL |
　　　　| token | Runner的通信令牌（請勿與注冊令牌混淆） |
　　　　| tls-ca-file | 使用HTTPS時用於驗證對等方的證書的文件 |
　　　　| tls-cert-file | 使用HTTPS時要與對等方進行身份驗證的證書的文件 |
　　　　| tls-key-file | 使用HTTPS時要與對等方進行身份驗證的私鑰的文件 |
　　　　| limit | 限制此令牌可以同時處理多少個作業。0（默認）表示不限制 |
　　　　| executor | 構建項目要使用的執行器 |

　　　　　　| shell | 默認情況下，在本地運行build |

　　　　　　　　| bash | 生成Bash (Bourne-shell)腳本。在Bash上下文中執行的所有命令(所有Unix系統的缺省值) |
　　　　　　　　| sh | 生成Sh (Bourne-shell)腳本。在Sh上下文中執行的所有命令(所有Unix系統的bash后備命令) |
　　　　　　　　| cmd | 生成Windows批處理腳本。所有命令都在批處理上下文中執行(默認為Windows) |
　　　　　　　　| powershell | 生成Windows PowerShell腳本。所有命令都在PowerShell上下文中執行 |

　　　　　　| docker | 使用Docker容器運行構建。這需要`[runners.docker]`的存在。和`docker引擎`安裝在一個系統上，運行程序將在該系統上運行作業。 |
　　　　　　| docker-windows | 使用Windows Docker容器運行構建。這需要`[runners.docker]`和`docker引擎`安裝在Windows系統上。 |
　　　　　　| docker-ssh | 使用Docker容器運行構建，但是使用SSH連接到它——這需要`[runners.docker]` , `[runners.ssh]`和`Docker引擎`。注意:這將在`本地機器上運行docker容器`，它只是改變了命令在該容器內的運行方式。如果希望在外部機器上運行docker命令，那么應該更改 `runners.docker` 中的 `host` 參數。 |
　　　　　　| ssh | 使用SSH遠程運行構建—這需要有`[runner.ssh]` |
　　　　　　| parallels | 使用Parallels VM運行構建，但是使用SSH連接到它——這需要[runners.parallels] and [runners.ssh] |
　　　　　　| virtualbox | 使用VirtualBox VM運行構建，但是使用SSH連接到它——這需要[runners.virtualbox] and [runners.ssh] |
　　　　　　| docker+machine | 像docker，但使用自動縮放的docker machines -這需要存在[runners.docker] and [runners.machine] |
　　　　　　| docker-ssh+machine | 與docker-ssh類似，但是使用自動伸縮的Docker機器——這需要[runners.docker] and [runners.machine] |
　　　　　　| kubernetes | 使用Kubernetes pod運行構建——這需要有`[runner.Kubernetes]`的存在。 |

　　　　| builds_dir | 目錄的絕對路徑，構建將存儲在選定執行程序(本地、Docker、SSH)的上下文中。 |
　　　　| cache_dir | 目錄的絕對路徑，其中構建緩存將存儲在選定的執行程序(本地、Docker、SSH)的上下文中。如果使用docker executor，則需要在其卷參數中包含此目錄。 |
　　　　| environment | 追加或覆蓋環境變量 |
　　　　| request_concurrency | 限制GitLab對新作業的並發請求數量(默認1) |
　　　　| output_limit | 設置最大構建日志大小(以kb為單位)，默認設置為4096 (4MB) |
　　　　| pre_clone_script | 在克隆Git存儲庫之前要在Runner上執行的命令。例如，這可以首先用於調整Git客戶機配置。要插入多個命令，請使用(三引號)多行字符串或“\n”字符。 |
　　　　| pre_build_script | 在克隆Git存儲庫之后，但在執行構建之前，要在Runner上執行的命令。要插入多個命令，請使用(三引號)多行字符串或“\n”字符。 |
　　　　| post_build_script | 要在Runner上執行的命令在執行構建之后，但在執行after_script之前執行。要插入多個命令，請使用(三引號)多行字符串或“\n”字符。 |
　　　　| clone_url | 覆蓋GitLab實例的URL。如果Runner無法在URL GitLab上連接到GitLab，則使用GitLab。 |
　　　　| debug_trace_disabled | 禁用CI_DEBUG_TRACE特性。當設置為true時，即使用戶將CI_DEBUG_TRACE設置為true，調試日志(跟蹤)也將保持禁用狀態。 |
　　　　| referees | 額外的工作(job)監視工作者(workers)，將他們的結果作為工作工件傳遞給GitLab |　　　　　　　

使用docker安裝查看runner配置

　　$ cat /data/etc/gitlab-runner/config.toml (具體路徑依docker run而定)

　　　　[runners.docker]
　　　　| host | 指定自定義Docker端點，默認使用`DOCKER_HOST`環境或 unix:///var/run/docker.sock |
　　　　| hostname | 為Docker容器指定自定義主機名 |
　　　　| runtime | 為Docker容器指定一個運行時 |
　　　　| tls_cert_path | 設置時將使用ca.pem、cert.pem和key。從該文件夾中的pem建立到Docker的安全TLS連接(在boot2docker中非常有用) |
　　　　| tls_verify | 啟用或禁用連接到Docker守護進程的TLS驗證。默認情況下禁用。 |
　　　　| image | 使用此映像運行構建 |
　　　　| memory | 包含內存限制的字符串值 |
　　　　| memory_swap | 包含總內存限制的字符串值 |
　　　　| memory_reservation | 包含內存軟限制的字符串值 |
　　　　| oom_kill_disable | 如果發生內存不足(OOM)錯誤，不要殺死容器中的進程 |
　　　　| oom_score_adjust | OOM分數調整，正意味着殺得早 |
　　　　| cpuset_cpus | 包含要使用的cgroups cpusetcpu的字符串值 |
　　　　| cpu_shares | 用於設置相對CPU使用量的CPU共享數量，默認為1024 |
　　　　| cpus | cpu數量的字符串值(在docker 1.13或更高版本中可用) |
　　　　| dns | 容器要使用的DNS服務器的列表 |
　　　　| dns_search | DNS搜索域的列表 |
　　　　| privileged | 使容器以特權模式運行(不安全) |
　　　　| disable_entrypoint_overwrite | 禁用映像 entrypoint 覆蓋 |
　　　　| userns_mode | 當啟用usernamespace重新映射選項時，為容器設置usernamespace模式。(可在docker1.10或更高版本中獲得) |
　　　　| cap_add | 向容器添加額外的Linux功能 |
　　　　| cap_drop | 從容器中刪除額外的Linux功能 |
　　　　| security_opt | 設置安全選項(-security-opt in docker run)，獲取':'分隔鍵/值的列表 |
　　　　| devices | 與容器共享其他主機設備 |
　　　　| cache_dir | 指定Docker緩存應該存儲在哪里(可以是絕對的，也可以是相對於當前工作目錄的)。有關更多信息，請參見disable_cache。 |
　　　　| disable_cache | Docker執行器有兩層緩存:全局緩存(與任何其他執行器一樣)和基於Docker卷的本地緩存。此配置標志僅作用於禁止使用自動創建(未映射到主機目錄)緩存卷的本地緩存卷。換句話說，它只阻止創建保存構建的臨時文件的容器，如果運行器配置為分布式緩存模式，它不會禁用緩存。 |
　　　　| network_mode | 將容器添加到自定義網絡 |
　　　　| wait_for_services_timeout | 指定等待docker服務的時間，設置為0禁用，默認為30 |
　　　　| volumes | 指定應該掛載的其他卷(與Docker的-v標志相同的語法) |
　　　　| extra_hosts | 指定應該在容器環境中定義的主機 |
　　　　| shm_size | 為映像指定共享內存大小(以字節為單位) |
　　　　| volumes_from | 以`<container name>[:<ro|rw>]`的形式指定要從另一個容器繼承的卷的列表。訪問級別默認為讀寫，但可以手動設置為ro(只讀)或rw(讀寫)。 |
　　　　| volume_driver | 指定容器使用的卷驅動程序 |
　　　　| links | 指定應該與構建容器鏈接的容器 |
　　　　| allowed_images | 指定可以在.gitlab-ci.yml中指定的圖像的通配符列表。如果不提供所有映像，則允許(相當於`["*/*:*"]`) |
　　　　| allowed_services | 指定可以在.gitlab-ci.yml中指定的通配符服務列表。如果不提供所有映像，則允許(相當於`["*/*:*"]`) |
　　　　| pull_policy | 指定映像拉取策略:`never`，`if-not-present`或 `always`(默認);請參閱pull策略文檔 |
　　　　| sysctls | 指定sysctl選項 |
　　　　| helper_image | (高級)覆蓋用於克隆repos和上傳工件的默認 `helper 映像` |

示例：

　　[runners.docker]
　　host = ""
　　hostname = ""
　　tls_cert_path = "/Users/ayufan/.boot2docker/certs"
　　image = "ruby:2.6"
　　memory = "128m"
　　memory_swap = "256m"
　　memory_reservation = "64m"
　　oom_kill_disable = false
　　cpuset_cpus = "0,1"
　　cpus = "2"
　　dns = ["8.8.8.8"]
　　dns_search = [""]
　　privileged = false
　　userns_mode = "host"
　　cap_add = ["NET_ADMIN"]
　　cap_drop = ["DAC_OVERRIDE"]
　　devices = ["/dev/net/tun"]
　　disable_cache = false
　　wait_for_services_timeout = 30
　　cache_dir = ""
　　volumes = ["/data", "/home/project/cache"]
　　extra_hosts = ["other-host:127.0.0.1"]
　　shm_size = 300000
　　volumes_from = ["storage_container:ro"]
　　links = ["mysql_container:mysql"]
　　allowed_images = ["ruby:*", "python:*", "php:*"]
　　allowed_services = ["postgres:9", "redis:*", "mysql:*"]
　　[[runners.docker.services]]
　　name = "mysql"
　　alias = "db"
　　[[runners.docker.services]]
　　name = "redis:2.8"
　　alias = "cache"
　　[[runners.docker.services]]
　　name = "postgres:9"
　　alias = "postgres-db"
　　[runners.docker.sysctls]
　　"net.ipv4.ip_forward" = "1"

（以下是其他可用區段定義）

[runners.ssh] 區段

| Parameter | Description |
| ------------ | ------------ |
| host | 連接到哪里(使用docker-ssh時被覆蓋) |
| port | 指定端口，默認值:22 |
| user | 指定用戶 |
| password | 指定密碼 |
| identity_file | 指定SSH私有密鑰的文件路徑(id_rsa、id_dsa或id_edcsa)。文件需要不加密地存儲 |

//示例
```bash
[runners.ssh]
host = "my-production-server"
port = "22"
user = "root"
password = "production-server-password"
identity_file = ""
```

 [runners.cache] 區段

GitLab Runner 1.1.0 中引入。

| Parameter | Type | Description |
| ------------ | ------------ | ------------ |
| Type | string | s3 或 gcs |
| Path | string | 添加到緩存URL前的路徑的名稱。 |
| Shared | boolean | 啟用運行程序之間的緩存共享，默認為false。 |

##### （1）[runners.cache.s3]

允許配置S3存儲用於緩存。本節包含與S3相關的設置，這些設置以前在該[runners.cache]節中全局存在。

//示例
```bash
[runners.cache]
Type = "s3"
Path = "path/to/prefix"
Shared = false
[runners.cache.s3]
ServerAddress = "s3.amazonaws.com"
AccessKey = "AMAZON_S3_ACCESS_KEY"
SecretKey = "AMAZON_S3_SECRET_KEY"
BucketName = "runners-cache"
BucketLocation = "eu-west-1"
Insecure = false
```

參考：https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section

[runners.kubernetes] 區段

GitLab Runner v1.6.0 中添加

| Parameter | Type | Description |
| ------------ | ------------ | ------------ |
| host | string | 可選的Kubernetes主機URL(如果未指定，將嘗試自動發現) |
| cert_file | string | 可選的Kubernetes認證證書 |
| key_file | string | 可選的Kubernetes主認證私鑰 |
| ca_file | string | 可選的Kubernetes主認證證書 |
| image | string | 默認的docker鏡像，當沒有指定時用於構建 |
| namespace | string | 命名空間來運行Kubernetes作業 |
| privileged | boolean | 運行所有啟用了特權標志的容器 |
| node_selector | table | 一個table的key=value對string=string。設置此限制將Pod的創建限制為與所有key=value對匹配的Kubernetes節點 |
| image_pull_secrets | array | 用於驗證docker映像提取的秘密列表 |

//示例
```bash
[runners.kubernetes]
host = "https://45.67.34.123:4892"
cert_file = "/etc/ssl/kubernetes/api.crt"
key_file = "/etc/ssl/kubernetes/api.key"
ca_file = "/etc/ssl/kubernetes/ca.crt"
image = "golang:1.8"
privileged = true
image_pull_secrets = ["docker-registry-credentials"]
[runners.kubernetes.node_selector]
gitlab = "true"
```

更多參考：https://docs.gitlab.com/runner/executors/kubernetes.html

Helper image

當使用docker、docker+machine或kubernetes執行器之一時，GitLab Runner使用特定的容器來處理Git、工件和緩存操作。這個容器是由一個名為helper映像的特殊映像創建的。

helper 映像基於Alpine Linux，它提供amd64和arm架構。它包含一個`gitLab-run-helper`二進制文件，這是GitLab Runner二進制文件的特殊編譯，只包含可用命令的一個子集，以及Git、Git LFS、SSL證書存儲和Alpine的基本配置。

當從DEB/RPM包中安裝GitLab Runner時，兩個映像(amd64和基於arm的)都安裝在主機上。當運行器為作業執行准備好環境時，如果在Docker引擎上沒有找到指定版本(基於Runner的Git修訂版)中的映像，則會自動加載它。它對docker和docker+machine執行器都是這樣工作的。

對於kubernetes executor或手動安裝GitLab Runner時，情況略有不同。對於手動安裝，gitlab-runner-helper二進制文件不包括在其中，對於kubernetes executor, kubernetes的API不允許從本地存檔加載gitlab-runner-helper映像。在這兩種情況下，GitLab Runner都將從Docker Hub (GitLab的官方存儲庫GitLab / GitLab -run -helper)下載幫助器映像，方法是使用Runner的修訂和架構來定義應該下載哪個標記

覆蓋 helper image

在某些情況下，您可能需要覆蓋幫助器映像。這樣做的原因有很多:

（1）加快作業執行: 在internet連接速度較慢的環境中，從Docker Hub一次又一次地下載相同的映像可能會顯著增加作業的時間。從本地注冊表(其中存儲 gitlab/gitlab-runner-helper:XYZ 的精確副本)下載幫助程序映像可能會加快速度。

（2）安全考慮：許多人不喜歡下載以前沒有檢查過的外部依賴項。可能有一個業務規則只使用被審查並存儲在本地存儲庫中的依賴項。

（3）構建沒有internet訪問的環境：在某些情況下，作業是在一個具有專用的、封閉的網絡的環境中執行的(這不適用於kubernetes執行程序，因為映像仍然需要從外部注冊中心下載，至少kubernetes集群可以從外部注冊中心下載映像)。

（4）額外的軟件：有些用戶可能希望在幫助映像中安裝一些額外的軟件，比如openssh，以支持通過git+ssh而不是git+http訪問的子模塊。

在上面描述的任何情況下，都可以使用helper_image配置字段來配置自定義映像，該字段可用於docker、docker+machine和kubernetes執行器:

```bash
[[runners]]
(...)
executor = "docker"
[runners.docker]
(...)
helper_image = "my.registry.local/gitlab/gitlab-runner-helper:tag"
```

請注意，助手映像的版本應該與GitLab Runner的版本嚴格耦合。就像上面所描述的那樣,提供這樣的的一個主要原因是 Runner 使用gitlab-runner-helper二進制圖像,這編譯二進制GitLab runner的一部分來源是使用一個內部API,預計在二進制文件都是相同的。

Runner 默認引用 gitlab/gitlab-run-helper:XYZ 映像，其中XYZ基於運行器的體系結構和Git修訂。從GitLab Runner 11.3開始，通過使用版本變量之一，可以自動定義使用過的圖像的版本:

```bash
[[runners]]
(...)
executor = "docker"
[runners.docker]
(...)
helper_image = "my.registry.local/gitlab/gitlab-runner-helper:x86_64-${CI_RUNNER_REVISION}"