cirepo/gitlab-runner repository overview

⁠gitlab-runner

Dockerfile ci-and-cd/docker-gitlab-runner on Github⁠

cirepo/gitlab-runner on Docker Hub⁠

⁠Start and register a runner

1. Prepare directories and files on host

docker run --privileged=true --rm -v /var/run/docker.sock:/var/run/docker.sock busybox chmod a+rw /var/run/docker.sock
docker run --privileged=true --rm -v /var/run/docker.sock:/var/run/docker.sock busybox ls -l /var/run/docker.sock

1. Run docker-compose up -d

2. Find token for runner. Shared: Goto admin/runners page (e.g. http(s)://gitlab:10080/admin/runners). Specific: Goto repo's settings/ci_cd page (e.g. http(s)://gitlab:10080///settings/ci_cd).

3. Run docker exec -it gitlab-runner sudo gitlab-runner register and input following info (in <>).

Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/):
<e.g. http://gitlab:10080/>
Please enter the gitlab-ci token for this runner:
<Token found in step 4>
Please enter the gitlab-ci description for this runner:
<gitlab-runner-<ip>>
Please enter the gitlab-ci tags for this runner (comma separated):
<gitlab-runner>
Whether to run untagged builds [true/false]:
<true>
Whether to lock Runner to current project [true/false]:
<false>
Registering runner... succeeded runner=********
Please enter the executor: parallels, virtualbox, shell, ssh, docker+machine, docker-ssh+machine, kubernetes, docker, docker-ssh:
<shell>
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!

⁠Note

• It seems most recent version of gitlab-runner's build process can't see host's environment variables such as JAVA_HOME or CI_INFRA_OPT_GIT_AUTH_TOKEN (e.g. gitlab: http(s)://gitlab/profile/personal_access_tokens). You can add environment variables at Repository->Settings->CI/CD Pipelines->Secret Variables.

• ERROR: 403 If https access of git repository on gitlab is disabled Cloning repository... Cloning into '/var/lib/gitlab-runner/builds/b3ef1983/0/contextPath/group/repository'... remote: Git access over HTTP is not allowed fatal: unable to access 'https://gitlab-ci-token:xxxxxxxxxxxxxxxxxxxx@domain/contextPath/group/repository.git/⁠': The requested URL returned error: 403 ERROR: Job failed: exit status 1

see: https://gitlab.com/gitlab-org/gitlab-ce/issues/22501⁠

⁠see: https://gitlab.com/gitlab-org/gitlab-runner/issues/1884⁠

⁠see: https://stackoverflow.com/questions/39208420/how-do-i-enable-cloning-over-ssh-for-a-gitlab-runner⁠

Copy ssh key into container

docker exec gitlab-runner sh -c "echo HOME \$HOME"
docker exec gitlab-runner sh -c "ls -la ~/.ssh; cat ~/.ssh/config"
docker cp ~/.ssh/id_rsa gitlab-runner:/var/lib/gitlab-runner/.ssh/id_rsa
docker exec gitlab-runner sh -c "sudo chown 1000:1000 ~/.ssh/id_rsa; ls -la ~/.ssh"

Clone manually

in project's .gitlab-ci.yml

before_script:
- export GIT_STRATEGY=none

Do git fetch in scripts of .gitlab-ci.yml

• gitlab-runner's version must compatible with gitlab service.

• Container instance needs to access docker (/var/run/docker.sock) on host. On host

docker run --privileged=true --rm -v /var/run/docker.sock:/var/run/docker.sock busybox chmod a+rw /var/run/docker.sock
docker run --privileged=true --rm -v /var/run/docker.sock:/var/run/docker.sock busybox ls -l /var/run/docker.sock

Or in container

sudo chmod a+rw /var/run/docker.sock

• You can inspect container by:

docker exec -it gitlab-runner cat /etc/gitlab-runner/config.toml
docker exec -it gitlab-runner cat /var/lib/gitlab-runner/.gitlab-runner/config.toml
docker exec -it gitlab-runner cat /var/lib/gitlab-runner/.ssh/config
docker exec -it gitlab-runner ls -la /var/lib/gitlab-runner/.ssh
docker exec -it gitlab-runner ls -la /var/lib/gitlab-runner/.docker

• ERROR: Uploading artifacts to coordinator... too large archive id=116 responseStatus=413

https://gitlab.com/gitlab-org/gitlab-ce/issues/20612⁠

⁠Start and register a runner on k8s

1. Prepare directories and files on host

• This should be done by a cron script on host that fix permission of '/var/run/docker.sock' periodically

1. put CI_INFRA_OPT_GIT_AUTH_TOKEN into gitlab-runner/k8s/gitlab-runner-secret.yaml by

• export CI_INFRA_OPT_GIT_AUTH_TOKEN=<your_CI_INFRA_OPT_GIT_AUTH_TOKEN>
• sed "s#<PUT_BASE64_CI_INFRA_OPT_GIT_AUTH_TOKEN_HERE_MANUALLY>#$(echo -n ${CI_INFRA_OPT_GIT_AUTH_TOKEN} | base64 -w 0)#" gitlab-runner-secret.template > gitlab-runner-secret.yaml

1. Run kubectl cluster-info check that kubectl is properly configured

• kubectl create -f gitlab-runner-secret.yaml and kubectl create -f gitlab-runner-deploy.yaml to deploy
• kubectl get po to see gitlab-runner's pod
• kubectl exec -it gitlab-runner-<suffix> bash to get in gitlab-runner's pod
• chown -R 1000:1000 /var/lib/gitlab-runner to ensure directory's permission

1. Run kubectl exec -it gitlab-runner-<suffix> gitlab-runner register and input same info as previous section (Start and register a runner on raw machine)

⁠Advanced configuration (config.toml)

Use CONFIG_FILE environment variable specify a configuration file. Official doc for config.toml⁠

# e.g. set concurrent to 3
docker exec -it gitlab-runner /bin/sed -Ei 's#^concurrent = [0-9]+$#concurrent = 3#g' /etc/gitlab-runner/config.toml