LoginSignup
1
1

More than 1 year has passed since last update.

@fkshom

gitlab-runner を Proxy 環境で使う

Last updated at Posted at 2021-12-11

エンジニアとProxyは切っても切れない関係にあります（そういう会社や環境があります）。

gitlab-runner を proxy環境下で使おうとしたのですが、GitLab公式の解説では十分ではありませんでした。
ここでは、特定の状況を想定した場合のみですが、proxy環境下で使う方法を紹介します。

gitlab-runner のインストールと実行

gitlab-runnner として、パッケージ版やバイナリ版、Docker版などが提供されています。Install GitLab Runner

ここでは、Debian/Ubuntuパッケージ版 を使う場合と、Docker版を使う場合について、Proxy設定からregisterまでの方法を説明します。

Debian/Ubuntu パッケージ版 を使う場合

Installing GitLab Runner に解説があるので参考にしながら進めます。

Proxy設定

gitlab-runner プログラムは http_proxy環境変数を読み取ってくれるようです。
起動時に毎回ターミナルでexport http_proxy=とするのも面倒ですし、sudo gitlab-runner とsudoする場合は、デフォルトでは環境変数は引き継がれません。（-Eで環境変数を引き継ぐことが可能）
ここでは、/etc/profile でhttp_proxy環境変数を設定することで、Proxy設定をグローバルに設定することとします。

さらに、apt-get install gitlab-runnnerがProxy経由で可能となるよう、apt の設定ファイルにProxy設定を行います。

$ cat <<EOF | sudo tee /etc/profile
export http_proxy=http://proxy:8080/
export https_proxy=http://proxy:8080/
export no_proxy=localhost,127.0.0.1
EOF

$ cat <<EOF | sudo tee /etc/apt/apt.conf.d/98proxy
Acquire::http::Proxy "http://proxy:8080";
Acquire::https::Proxy "http://proxy:8080";
EOF

インストール

gitlab-runnnerをインストールします。

# sudo -i として、/etc/profileの反映した状態でスクリプトを実行する
$ curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh" | sudo -i bash

$ sudo apt-get install gitlab-runner

register

gitlab-runner を Gitlabにregistします。

# sudo -i として、/etc/profileの反映した状態でスクリプトを実行する
$ sudo -i gitlab-runner register
Runtime platform arch=amd64 os=linux pid=16 revision=de104fcd version=14.5.1
Running in system-mode.

Enter the GitLab instance URL (for example, https://gitlab.com/):
https://gitlab.com/
Enter the registration token:
abcdefgabcdefg
Enter a description for the runner:
[b9676290e5c5]: 
Enter tags for the runner (comma-separated):

Registering runner... succeeded runner=sHf2dtHx
Enter an executor: custom, docker, parallels, shell, ssh, docker+machine, docker-ssh+machine, docker-ssh, virtualbox, kubernetes:
docker
Enter the default Docker image (for example, ruby:2.6):
ruby:2.6
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!

これで、GitLabからCIを実行できるようになりました。

gitlab-runner （Docker版）を使う場合

Install the Docker image and start the container に解説があるので参考にしながら進めます。

Proxy設定

docker サービス自体がProxy経由でインターネットに接続できるように設定します。

# コンテナイメージをインターネットからダウンロードする（docker pull時）に使うproxyの設定

$ sudo mkdir -p /etc/systemd/system/docker.service.d/

$ cat <<EOF| sudo tee /etc/systemd/system/docker.service.d/10-proxy.conf
[Service]
Environment="HTTP_PROXY=http://proxy:8080"
Environment="HTTPS_PROXY=http://proxy:8080"
Environment="NO_PROXY=localhost,127.0.0.1"
EOF

$ sudo systemctl daemon-reload

# （必要であれば）コマンドラインで docker build する際に使うproxyの設定
$ mkdir ~/.docker
$ cat <<EOF > ~/.docker/config.json
{
 "proxies":
 {
   "default":
   {
     "httpProxy": "http://proxy:8080/",
     "httpsProxy": "http://proxy:8080/",
     "noProxy": "localhost,127.0.0.0/8"
   }
 }
}
EOF

インストール（コンテナ実行）

gitlab-runner コンテナイメージをgit pullし、同時に実行させます。
このとき、-e http_proxyを指定することで、コンテナ内にhttp_proxy環境変数を設定します。
gitlab-runner プロセスは、この環境変数を読み取って実行されます。

# gitlab-runnner が gitlab に接続する際に使うproxyを環境変数で指定して起動する
$ 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 \
     -e http_proxy=http://proxy:8080/ \
     -e https_proxy=http://proxy:8080/ \
     gitlab/gitlab-runner:latest

register

gitlab-runner を Gitlabにregistします。
docker execコマンドを使い、先ほど起動したコンテナ内でgitlab-runner registerコマンドを実行します。
（docker runコマンドにhttp_proxy環境変数を追加指定してgitlab-runner registerコマンドを実行しても同様の結果になります）

$ docker exec -it gitlab-runner gitlab-runner register
Runtime platform arch=amd64 os=linux pid=16 revision=de104fcd version=14.5.1
Running in system-mode.

Enter the GitLab instance URL (for example, https://gitlab.com/):
https://gitlab.com/
Enter the registration token:
abcdefgabcdefg
Enter a description for the runner:
[b9676290e5c5]: 
Enter tags for the runner (comma-separated):

Registering runner... succeeded runner=sHf2dtHx
Enter an executor: custom, docker, parallels, shell, ssh, docker+machine, docker-ssh+machine, docker-ssh, virtualbox, kubernetes:
docker
Enter the default Docker image (for example, ruby:2.6):
ruby:2.6
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!

これで、GitLabからCIを実行できるようになりました。

tips

gitlab-runner docker executer を使う場合で、.gitlab-ci.yml にproxy設定を書きたくない場合

docker executorを使う場合、ここまでの設定を行っても、CIで使われるdockerコンテナ自身にはProxy設定は反映されません。
このままでは、コンテナ内でgit clone したり、インターネットに接続したりするために、.gitlab-ci.yml にProxy設定を書く必要があります。

Adding the Proxy to the Docker containersには、pre_clone_scriptをconfig.tomlに書くことで、自動的にProxy設定をコンテナに対して行おう方法が紹介されています。

# gitlab-runnerコンテナ内の/etc/gitlab-runner/config.toml に対応するファイル（今回の例では/srv/gitlab-runner/config/config.toml）を直接編集します
# gitlab-runner コンテナにvimなどのエディタが含まれていないため

$ sudo vim /srv/gitlab-runner/config/config.toml

[[runners]]
  name = "b9676290e5c5"
  url = "https://gitlab.com/"
  token = "abcdefgabcdefg"
  executor = "docker"
  pre_clone_script = "git config --global http.proxy $HTTP_PROXY; git config --global https.proxy $HTTPS_PROXY"
  environment = ["https_proxy=http://proxy:8080", "http_proxy=http://proxy:8080", "HTTPS_PROXY=proxy:8080", "HTTP_PROXY=proxy:8080"]

gitlab-runner がファイルの変更を監視して自動的に再読み込みしてくれるため、コンテナの再起動は不要です。

gitlab-runner （Docker版）をdocker-composeで実行したい場合

docker-compose.yml
version: '2'
services:
  gitlab-runner:
    image: gitlab/gitlab-runner:latest
    restart: always
    volumes:
      - /srv/gitlab-runner/config:/etc/gitlab-runner
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - http_proxy=http://proxy:8080/
      - https_proxy=http://proxy:8080/

docker-compose up -d
docker-compose exec gitlab-runner gitlab-runner register

オンプレGitlabへの接続で証明書エラーが発生する場合

オレオレ証明書、もしくは独自CA環境なオンプレGitLabへregister する際、証明書エラーが発生してregisterができません。

# gitlab-runner register   
Runtime platform  arch=amd64 os=linux pid=4618 revision=0e5417a3 version=12.0.1
Running in system-mode.                            
                                                   
Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/):
https://mygitlab.example.com/ 
Please enter the gitlab-ci token for this runner:
abcdefgabcdefg
Please enter the gitlab-ci description for this runner:
[b9676290e5c5]: 
Please enter the gitlab-ci tags for this runner (comma separated):

ERROR: Registering runner... failed  runner=b9676290e5c5 status=couldn't execute POST against https://mygitlab.example.com/api/v4/runners: Post https://mygitlab.example.com/api/v4/runners: x509: certificate signed by unknown authority
PANIC: Failed to register this runner. Perhaps you are having network problems

Proxy環境の有無は関係ありませんが、解決方法をメモとして書いておきます。

Debian/Ubuntu パッケージ版 の場合

後で書く

gitlab-runner （Docker版）の場合

後で書く

参考

1
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
1
1