CI/CD

GitLab Runner Primer

2018-12-29  本文已影响65人  JerryShieh

Installing GitLab Runner

To install the Runner:

  1. Add GitLab's official repository:

    # For Debian/Ubuntu/Mint
curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh | sudo bash

# For RHEL/CentOS/Fedora
curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.rpm.sh | sudo bash

  2. Install the latest version of GitLab Runner, or skip to the next step to install a specific version:

    • Install latest version

      # For Debian/Ubuntu/Mint
sudo apt-get install gitlab-runner

# For RHEL/CentOS/Fedora
sudo yum install gitlab-runner

    • Install specifice version

      # for DEB based systems
apt-cache madison gitlab-runner
sudo apt-get install gitlab-runner=10.0.0

# for RPM based systems
yum list gitlab-runner --showduplicates | sort -r
sudo yum install gitlab-runner-10.0.0-1

Registering Runners

Requirements

Before registering a Runner, you need to first:

Registering a Runner under GNU/Linux

  1. Run the following command:

    sudo gitlab-runner register

  2. Enter your GitLab instance URL:

    Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com )
https://code.siemens.com/

    Notes: You can obtain the URL by GitLab page -> Settings -> CI/CD -> Runners if you have access to it.

RegisterRunners

  1. Enter the token you obtained to register the Runner:

    Please enter the gitlab-ci token for this runner  
xxx

    notes: You can obtain the token at the same time at step 2.

  2. Enter a description (i.e. runner name) for the Runner, you can change this later in GitLab’s UI:

    Please enter the gitlab-ci description for this runner  
[hostame] my-runner

  3. Enter the tags associated with the Runner, you can change this later in GitLab’s UI:

    Please enter the gitlab-ci tags for this runner (comma separated):
my-tag,another-tag

  4. Enter the Runner executor:

    Please enter the executor: ssh, docker+machine, docker-ssh+machine, kubernetes, docker, parallels, virtualbox, docker-ssh, shell:
docker

    If you chose Docker as your executor, you’ll be asked for the default image to be used for projects that do not define one in .gitlab-ci.yml:

    Please enter the Docker image (eg. ruby:2.1):
alpine:latest

Using GitLab Runner

For more GitLab Runner commands, you can visit here.

Important topics — Executor

Shell Executor

The source project is checked out to: <working-directory>/builds/<short-token>/<concurrent-id>/<namespace>/<project-name>.

The caches for project are stored in <working-directory>/cache/<namespace>/<project-name>.

For more shell executor information, please visit here.

Docker Executor

For more docker executor information, please visit here.

FAQ

When using docker executor runner in ubuntu 18.04, the runner can't access to the Internet

There is a DNS issue when using ubuntu 18.04 with Docker, you can refer to here for more detail information.

The following error may occur in the pipeline:

fatal: unable to access 'https://gitlab-ci-token:xxxxxxxxxxxxxxxxxxxx@code.siemens.com/zhen.xie/iavgitlabrunnertest.git/': Could not resolve host: code.siemens.com

You can resolve this problem by adding dns = ["***.***.***.***"] in the runner's config file (it usually can be found in /etc/gitlab-runner/config.toml) to change the docker container dns.

Tips: You can obtain the detail network information by command nmcli dev show, and then add the effective dns address to the relevant runner config section in config.toml

"JAVA_HOME is not set and no java command could be found in your PATH" when running the pipeline

This error usually occur when runner uses shell executor, you can set the JAVA_HOME in the GitLab page -> Settings -> CI/CD -> Variables.

How should I configure my GitLab Runner

Refer to https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-global-section

How often does the Runner check the new jobs from GitLab instance

The check_interval attribute in config.toml will determine the interval, its default value is 3 seconds, but it just for one worker (there are many runners defined in config.toml, we call them workers). If there are many workers, each worker (worker A ---> worker B) interval is check_interval / worker_nums, but it still takes the check_interval time for one worker to request next job (worker A ---> worker A). You can see here for more information, or use the clear_volumes.sh script to handle it.

What is the concurrent in config.toml

concurrent limits how many jobs globally can be run concurrently. There are some examples (trigger 2 jobs concurrently) for understanding it easily.

Where the caches are stored

Refer to https://docs.gitlab.com/ee/ci/caching/#where-the-caches-are-stored

How to clear the cache

Refer to https://docs.gitlab.com/ee/ci/caching/#clearing-the-cache

Note that on the next push, your CI/CD job will use a new cache.

What is the priority of variables in GitLab Runner

Refer to https://docs.gitlab.com/ee/ci/variables/#priority-of-variables

What are the predefined variables in GitLab Runner

Refer to https://docs.gitlab.com/ee/ci/variables/#predefined-variables-environment-variables

I can't build docker when my runner is docker executor

This is "dind (Docker in Docker)" problem, The following error may occur in the pipeline:

Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
time="2018-12-17T11:12:33Z" level=error msg="failed to dial gRPC: cannot connect to the Docker daemon. Is 'docker daemon' running on this host?: dial unix

You can resolve this problem by using docker socket binding, for example, you can add volumes = ["/var/run/docker.sock:/var/run/docker.sock", "/cache"] in config.toml, more detail information, please refer to https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#use-docker-in-docker-executor.

上一篇下一篇

猜你喜欢

热点阅读