sameersbn/gitlab-ci

•Updated almost 11 years ago

Image

100K+

sameersbn/gitlab-ci repository overview

⁠END OF LIFE

Since version 8.0 GitLab CI has been merged into GitLab CE and you no longer need to setup a separate GitLab CI instance.

You can only migrate the CI server to GitLab CE 8.0.x from version 7.14.3. As a result you need to first upgrade to the sameersbn/gitlab-ci:7.14.3-1 release. Refer to https://github.com/sameersbn/docker-gitlab/blob/master/CI_MIGRATION.md⁠ for the migration instructions.

PSA: BACKUP YOUR DATA BEFORE MIGRATING

If you are interested in older versions of GitLab CI then please refer to the README of the tagged versions.

⁠Introduction

Dockerfile to build a GitLab CI⁠ container image.

⁠Version

Current Version: 8.0.5

The gitlab-ci version should match the gitlab version to avoid any compatibility issues

⁠Contributing

If you find this image useful here's how you can help:

Send a Pull Request with your awesome new features and bug fixes
Help new users with Issues⁠ they may encounter
Support the development of this image with a donation⁠

⁠Issues

Docker is a relatively new project and is active being developed and tested by a thriving community of developers and testers and every release of docker features many enhancements and bugfixes.

Given the nature of the development and release cycle it is very important that you have the latest version of docker installed because any issue that you encounter might have already been fixed with a newer docker release.

For ubuntu users I suggest installing docker⁠ using docker's own package repository since the version of docker packaged in the ubuntu repositories are a little dated.

Here is the shortform of the installation of an updated version of docker on ubuntu.

sudo apt-get purge docker.io
curl -s https://get.docker.io/ubuntu/ | sudo sh
sudo apt-get update
sudo apt-get install lxc-docker

Fedora and RHEL/CentOS users should try disabling selinux with setenforce 0 and check if resolves the issue. If it does than there is not much that I can help you with. You can either stick with selinux disabled (not recommended by redhat) or switch to using ubuntu.

If using the latest docker version and/or disabling selinux does not fix the issue then please file a issue request on the issues⁠ page.

In your issue report please make sure you provide the following information:

The host ditribution and release version.
Output of the docker version command
Output of the docker info command
The docker run command you used to run the image (mask out the sensitive bits).

⁠Installation

Automated builds of the image are available on Dockerhub⁠ and is the recommended method of installation.

Note: Builds are also available on Quay.io⁠

docker pull sameersbn/gitlab-ci:latest

Starting from GitLab CI version 5.1.0, You can pull a particular version of GitLab CI by specifying the version number. For example,

docker pull sameersbn/gitlab-ci:8.0.5

Alternately you can build the image yourself.

git clone https://github.com/sameersbn/docker-gitlab-ci.git
cd docker-gitlab-ci
docker build --tag $USER/gitlab-ci .

⁠Quick Start

Before you can start the GitLab CI image you need to make sure you have a GitLab⁠ server running. Checkout the docker-gitlab⁠ project for getting a GitLab server up and running.

You need to provide the URL of the GitLab server while running GitLab CI using the GITLAB_URL environment configuration. Since version 5.4.0 you need to provide the GITLAB_APP_ID and GITLAB_APP_SECRET. Since 7.13.0 you also need to provide the GITLAB_CI_SECRETS_SESSION_KEY_BASE and GITLAB_CI_SECRETS_DB_KEY_BASE parameters.

The quickest way to get started is using docker-compose⁠.

wget https://raw.githubusercontent.com/sameersbn/docker-gitlab-ci/master/docker-compose.yml
docker-compose up

Alternately, you can manually launch the gitlab-ci container and the supporting postgresql and redis containers by following this three step guide.

Step 1. Launch a postgresql container

docker run --name gitlab-ci-postgresql -d \
    --env 'DB_NAME=gitlab_ci_production' \
    --env 'DB_USER=gitlab' --env 'DB_PASS=password' \
    --volume /srv/docker/gitlab-ci/postgresql:/var/lib/postgresql \
    sameersbn/postgresql:9.4-7

Step 2. Launch a redis container

docker run --name gitlab-ci-redis -d \
    --volume /srv/docker/gitlab-ci/redis:/var/lib/redis \
    sameersbn/redis:latest

Step 3. Launch the gitlab-ci container

docker run --name gitlab-ci -d \
    --link gitlab-ci-postgresql:postgresql --link gitlab-ci-redis:redisio \
    --publish 10081:80 \
    --env 'GITLAB_CI_PORT=10081' --env 'GITLAB_URL=http://localhost:10080' \
    --env 'GITLAB_APP_ID=xxx' --env 'GITLAB_APP_SECRET=yyy' \
    --volume /srv/docker/gitlab-ci/gitlab-ci:/home/gitlab_ci/data \
    sameersbn/gitlab-ci:8.0.5

Point your browser to http://localhost:10081 and login using your GitLab credentials.

You should now have the GitLab CI ready for testing. If you want to use this image in production the please read on.

The rest of the document will use the docker command line. You can quite simply adapt your configuration into a docker-compose.yml file if you wish to do so.

NOTE: You need to install GitLab CI Runner⁠ if you want to do anything worth while with the GitLab CI server. Please take a look at docker-gitlab-ci-runner⁠ for a base runner image.

⁠Configuration

⁠Persistence

For storage of the application data, you should mount a volume at

/home/gitlab_ci/data

SELinux users are also required to change the security context of the mount point so that it plays nicely with selinux.

mkdir -p /srv/docker/gitlab-ci/gitlab-ci
sudo chcon -Rt svirt_sandbox_file_t /srv/docker/gitlab-ci/gitlab-ci

Volumes can be mounted in docker by specifying the '-v' option in the docker run command.

docker run --name gitlab-ci -it --rm \
    --volume /srv/docker/gitlab-ci/gitlab-ci:/home/gitlab_ci/data \
    sameersbn/gitlab-ci:8.0.5

⁠Database

GitLab CI uses a database backend to store its data.

⁠PostgreSQL

⁠External PostgreSQL Server

The image also supports using an external PostgreSQL Server. This is also controlled via environment variables.

CREATE ROLE gitlab_ci with LOGIN CREATEDB PASSWORD 'password';
CREATE DATABASE gitlab_ci_production;
GRANT ALL PRIVILEGES ON DATABASE gitlab_ci_production to gitlab_ci;

We are now ready to start the container.

Assuming that the PostgreSQL server host is 192.168.1.100

docker run --name gitlab-ci -it --rm \
    --env 'GITLAB_URL=http://172.17.0.2' \
    --env 'GITLAB_APP_ID=xxx' --env 'GITLAB_APP_SECRET=yyy' \
    --env 'DB_TYPE=postgres' --env 'DB_HOST=192.168.1.100' \
    --env 'DB_NAME=gitlab_ci_production' \
    --env 'DB_USER=gitlab_ci' --env 'DB_PASS=password' \
    sameersbn/gitlab-ci:8.0.5

⁠Linking to PostgreSQL Container

You can link this image with a postgresql container for the database requirements. The alias of the postgresql server container should be set to postgresql while linking with the gitlab ci image.

If a postgresql container is linked, only the DB_TYPE, DB_HOST and DB_PORT settings are automatically retrieved using the linkage. You may still need to set other database connection parameters such as the DB_NAME, DB_USER, DB_PASS and so on.

To illustrate linking with a postgresql container, we will use the sameersbn/postgresql⁠ image. When using postgresql image in production you should mount a volume for the postgresql data store. Please refer the README⁠ of docker-postgresql for details.

First, lets pull the postgresql image from the docker index.

docker pull sameersbn/postgresql:9.4-7

For data persistence lets create a store for the postgresql and start the container.

SELinux users are also required to change the security context of the mount point so that it plays nicely with selinux.

mkdir -p /srv/docker/gitlab-ci/postgresql
sudo chcon -Rt svirt_sandbox_file_t /srv/docker/gitlab-ci/postgresql

The run command looks like this.

docker run --name gitlab-ci-postgresql -d \
    --env 'DB_NAME=gitlab_ci_production' \
    --env 'DB_USER=gitlab_ci' --env 'DB_PASS=password' \
    --volume /srv/docker/gitlab-ci/postgresql:/var/lib/postgresql \
    sameersbn/postgresql:9.4-7

The above command will create a database named gitlab_ci_production and also create a user named gitlab_ci with the password password with access to the gitlab_ci_production database.

We are now ready to start the GitLab CI application.

docker run --name gitlab-ci -it --rm --link gitlab-ci-postgresql:postgresql \
    --env 'GITLAB_URL=http://172.17.0.2' \
    --env 'GITLAB_APP_ID=xxx' --env 'GITLAB_APP_SECRET=yyy' \
    sameersbn/gitlab-ci:8.0.5

Here the image will also automatically fetch the DB_NAME, DB_USER and DB_PASS variables from the postgresql container as they are specified in the docker run command for the postgresql container. This is made possible using the magic of docker links and works with the following images:

⁠MySQL

⁠Internal MySQL Server

The internal mysql server has been removed from the image. Please use a linked mysql⁠ container or specify a connection to a external mysql⁠ server.

If you have been using the internal mysql server follow these instructions to migrate to a linked mysql container:

Assuming that your mysql data is available at /srv/docker/gitlab-ci/mysql

docker run --name gitlab-ci-mysql -d \
    --volume /srv/docker/gitlab-ci/mysql:/var/lib/mysql \
    sameersbn/mysql:latest

This will start a mysql container with your existing mysql data. Now login to the mysql container and create a user for the existing gitlab_ci_production database.

All you need to do now is link this mysql container to the gitlab ci container using the --link gitlab-ci-mysql:mysql option and provide the DB_NAME, DB_USER and DB_PASS parameters.

Refer to Linking to MySQL Container⁠ for more information.

⁠External MySQL Server

The image can be configured to use an external MySQL database instead of starting a MySQL server internally. The database configuration should be specified using environment variables while starting the GitLab CI image.

Before you start the GitLab CI image create user and database for GitLab CI.

CREATE USER 'gitlab_ci'@'%.%.%.%' IDENTIFIED BY 'password';
CREATE DATABASE IF NOT EXISTS `gitlab_ci_production` DEFAULT CHARACTER SET `utf8` COLLATE `utf8_unicode_ci`;
GRANT ALL PRIVILEGES ON `gitlab_ci_production`.* TO 'gitlab_ci'@'%.%.%.%';

We are now ready to start the container.

Assuming that the mysql server host is 192.168.1.100

docker run --name gitlab-ci -it --rm \
    --env 'GITLAB_URL=http://172.17.0.2' \
    --env 'GITLAB_APP_ID=xxx' --env 'GITLAB_APP_SECRET=yyy' \
    --env 'DB_HOST=192.168.1.100' --env 'DB_NAME=gitlab_ci_production' \
    --env 'DB_USER=gitlab_ci' --env 'DB_PASS=password' \
    sameersbn/gitlab-ci:8.0.5

⁠Linking to MySQL Container

You can link this image with a mysql container for the database requirements. The alias of the mysql server container should be set to mysql while linking with the gitlab ci image.

If a mysql container is linked, only the DB_TYPE, DB_HOST and DB_PORT settings are automatically retrieved using the linkage. You may still need to set other database connection parameters such as the DB_NAME, DB_USER, DB_PASS and so on.

To illustrate linking with a mysql container, we will use the sameersbn/mysql⁠ image. When using docker-mysql in production you should mount a volume for the mysql data store. Please refer the README⁠ of docker-mysql for details.

First, lets pull the mysql image from the docker index.

docker pull sameersbn/mysql:latest

For data persistence lets create a store for the mysql and start the container.

SELinux users are also required to change the security context of the mount point so that it plays nicely with selinux.

mkdir -p /srv/docker/gitlab-ci/mysql
sudo chcon -Rt svirt_sandbox_file_t /srv/docker/gitlab-ci/mysql

The run command looks like this.

docker run --name gitlab-ci-mysql -d \
    --env 'DB_NAME=gitlab_ci_production' \
    --env 'DB_USER=gitlab_ci' --env 'DB_PASS=password' \
    --volume /srv/docker/gitlab-ci/mysql:/var/lib/mysql \
    sameersbn/mysql:latest

The above command will create a database named gitlab_ci_production and also create a user named gitlab_ci with the password password with full/remote access to the gitlab_ci_production database.

We are now ready to start the GitLab CI application.

docker run --name gitlab-ci -it --rm --link gitlab-ci-mysql:mysql \
    --env 'GITLAB_URL=http://172.17.0.2' \
    --env 'GITLAB_APP_ID=xxx' --env 'GITLAB_APP_SECRET=yyy' \
    sameersbn/gitlab-ci:8.0.5

Here the image will also automatically fetch the DB_NAME, DB_USER and DB_PASS variables from the mysql container as they are specified in the docker run command for the mysql container. This is made possible using the magic of docker links and works with the following images:

⁠Redis

GitLab CI uses the redis server for its key-value data store. The redis server connection details can be specified using environment variables.

⁠Internal Redis Server

The internal redis server has been removed from the image. Please use a linked redis⁠ container or specify a external redis⁠ connection.

⁠External Redis Server

The image can be configured to use an external redis server instead of starting a redis server internally. The configuration should be specified using environment variables while starting the GitLab CI image.

Assuming that the redis server host is 192.168.1.100

docker run --name gitlab-ci -it --rm \
    --env 'REDIS_HOST=192.168.1.100' --env 'REDIS_PORT=6379' \
    sameersbn/gitlab-ci:8.0.5

⁠Linking to Redis Container

You can link this image with a redis container to satisfy GitLab CI's redis requirement. The alias of the redis server container should be set to redisio while linking with the GitLab image.

To illustrate linking with a redis container, we will use the sameersbn/redis⁠ image. Please refer the README⁠ of docker-redis for details.

First, lets pull the redis image from the docker index.

docker pull sameersbn/redis:latest

Lets start the redis container

docker run --name gitlab-ci-redis -d sameersbn/redis:latest

We are now ready to start the GitLab CI application.

docker run --name gitlab-ci -it --rm --link gitlab-ci-redis:redisio \
    sameersbn/gitlab-ci:latest

⁠Mail

The mail configuration should be specified using environment variables while starting the GitLab CI image. The configuration defaults to using gmail to send emails and requires the specification of a valid username and password to login to the gmail servers.

Please refer the Available Configuration Parameters⁠ section for the list of SMTP parameters that can be specified.

docker run --name gitlab-ci -it --rm \
    --env '[email protected]' --env 'SMTP_PASS=PASSWORD' \
    sameersbn/gitlab-ci:8.0.5

Please look up the Available Configuration Parameters⁠ section for all available SMTP configuration options.

⁠SSL

Access to the gitlab ci application can be secured using SSL so as to prevent unauthorized access to the data in your repositories. While a CA certified SSL certificate allows for verification of trust via the CA, a self signed certificates can also provide an equal level of trust verification as long as each client takes some additional steps to verify the identity of your website. I will provide instructions on achieving this towards the end of this section.

To secure your application via SSL you basically need two things:

Private key (.key)
SSL certificate (.crt)

When using CA certified certificates, these files are provided to you by the CA. When using self-signed certificates you need to generate these files yourself. Skip the following section if you are armed with CA certified SSL certificates.

Jump to the Using HTTPS with a load balancer⁠ section if you are using a load balancer such as hipache, haproxy or nginx.

⁠Generation of Self Signed Certificates

Generation of self-signed SSL certificates involves a simple 3 step procedure.

STEP 1: Create the server private key

openssl genrsa -out gitlab_ci.key 2048

STEP 2: Create the certificate signing request (CSR)

openssl req -new -key gitlab_ci.key -out gitlab_ci.csr

STEP 3: Sign the certificate using the private key and CSR

openssl x509 -req -days 3650 \
    -in gitlab_ci.csr -signkey gitlab_ci.key \
    -out gitlab_ci.crt

Congratulations! you have now generated an SSL certificate thats valid for 365 days.

⁠Strengthening the server security

This section provides you with instructions to strengthen your server security⁠. To achieve this we need to generate stronger DHE parameters.

openssl dhparam -out dhparam.pem 2048

⁠Installation of the SSL Certificates

Out of the four files generated above, we need to install the gitlab_ci.key, gitlab_ci.crt and dhparam.pem files at the gitlab ci server. The CSR file is not needed, but do make sure you safely backup the file (in case you ever need it again).

The default path that the gitlab ci application is configured to look for the SSL certificates is at /home/gitlab_ci/data/certs, this can however be changed using the SSL_KEY_PATH, SSL_CERTIFICATE_PATH and SSL_DHPARAM_PATH configuration options.

If you remember from above, the /home/gitlab_ci/data path is the path of the persistent volume, which means that we have to create a folder named certs inside /srv/docker/gitlab-ci/gitlab-ci and copy the files into it and as a measure of security we will update the permission on the gitlab_ci.key file to only be readable by the owner.

mkdir -p /srv/docker/gitlab-ci/gitlab-ci/certs
cp gitlab_ci.key /srv/docker/gitlab-ci/gitlab-ci/certs/
cp gitlab_ci.crt /srv/docker/gitlab-ci/gitlab-ci/certs/
cp dhparam.pem /srv/docker/gitlab-ci/gitlab-ci/certs/
chmod 400 /srv/docker/gitlab-ci/gitlab-ci/certs/gitlab_ci.key

Great! we are now just one step away from having our application secured.

⁠Enabling HTTPS support

HTTPS support can be enabled by setting the GITLAB_CI_HTTPS option to true.

docker run --name gitlab-ci -it --rm \
    --publish 10081:80 --publish 10444:443 \
    --env 'GITLAB_CI_PORT=10444' -env 'GITLAB_CI_HTTPS=true' \
    --volume /srv/docker/gitlab-ci/gitlab-ci:/home/gitlab_ci/data \
    sameersbn/gitlab-ci:8.0.5

In this configuration, any requests made over the plain http protocol will automatically be redirected to use the https protocol. However, this is not optimal when using a load balancer.

⁠Configuring HSTS

HSTS if supported by the browsers makes sure that your users will only reach your sever via HTTPS. When the user comes for the first time it sees a header from the server which states for how long from now this site should only be reachable via HTTPS - that's the HSTS max-age value.

With GITLAB_CI_HTTPS_HSTS_MAXAGE you can configure that value. The default value is 31536000 seconds. If you want to disable a already sent HSTS MAXAGE value, set it to 0.

docker run --name gitlab-ci -it --rm \
    --env 'GITLAB_CI_HTTPS=true' \
    --env 'GITLAB_CI_HTTPS_HSTS_MAXAGE=2592000' \
    --volume /srv/docker/gitlab-ci/gitlab-ci:/home/gitlab_ci/data \
    sameersbn/gitlab-ci:8.0.5

If you want to completely disable HSTS set GITLAB_CI_HTTPS_HSTS_ENABLED to false.

⁠Using HTTPS with a load balancer

Load balancers like nginx/haproxy/hipache talk to backend applications over plain http and as such the installation of ssl keys and certificates are not required and should NOT be installed in the container. The SSL configuration has to instead be done at the load balancer. Hoewever, when using a load balancer you MUST set GITLAB_CI_HTTPS to true.

With this in place, you should configure the load balancer to support handling of https requests. But that is out of the scope of this document. Please refer to Using SSL/HTTPS with HAProxy⁠ for information on the subject.

When using a load balancer, you probably want to make sure the load balancer performs the automatic http to https redirection. Information on this can also be found in the link above.

In summation, when using a load balancer, the docker command would look for the most part something like this:

docker run --name gitlab-ci -it --rm \
    --env 'GITLAB_CI

Tag summary

Recent tags

Content type

Image

Digest

sha256:bd1742db3…

Size

193 MB

Last updated

almost 11 years ago

docker pull sameersbn/gitlab-ci