The following text shows the default workflow to run and update a Docker image based on the example of GitLab. But this should also work for other containers.
Docker Installation
First make sure that your local machine has Docker installed. I use Debian and for this, a detailed description is available in Dockers documentation. There are also instructions for CentOS, Ubuntu, Fedora and others.
You can check the installed Docker version:
docker version
Client: Docker Engine - Community
Version: 20.10.11
API version: 1.41
...
Run a Docker Container
Let’s start with an environment variable that defines the path where all the Gitlab data is stored. This is outside of the Docker container which allows an easy update without loosing data. To define the variable $GITLAB_HOME, you can use:
export GITLAB_HOME="/srv/gitlab"
To run a Docker container, simply use the run command with your parameters. For GitLab, this might look like:
More details about the configuration of the GitLab runner is descriped in this post.
Update a Docker Container to the Latest Version
Let’s check, which container are running by using:
docker ps
The output shows all your containers and their ids:
CONTAINER ID IMAGE COMMAND CREATED STATUS NAMES
02fe426970f1 gitlab/gitlab-ce:latest "/assets/wrapper" 4 hours ago Up 4 hours (healthy) gitlab
5742e07f809b gitlab/gitlab-runner:latest "/usr/bin/dumb-init …" 4 days ago Up 5 hours gitlab_runner
We have to stop the container and remove the image. When you used a run command (for GitLab) as shown above, this should not affect the data as this is stored outside of the container.
docker stop 02fe426970f1
docker rm 02fe426970f1
To remove the associated image, you can use the docker rmi. For this, we need to find the id of this image by listing all images:
docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
gitlab/gitlab-ce latest 46cd6954564a 17 hours ago 2.36GB
mysql 5.7 c20987f18b13 2 weeks ago 448MB
cirrusci/flutter 2.8.1 98a87781f179 2 weeks ago 3.49GB
Now we can remove the image (in my case the gitlab-ce image):
docker rmi 46cd6954564a
The update of the image can be done by using pull. This will download the images (in this case the latest version) and stores it on your system:
docker pull gitlab/gitlab-ce:latest
After this, you can use the same run command as before to run a container with the updated image:
A final check, shows the container is up and running:
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS NAMES
f3dab1163c07 gitlab/gitlab-ce:latest "/assets/wrapper" 2 minutes ago Up 4 hours (healthy) gitlab
5742e07f809b gitlab/gitlab-runner:latest "/usr/bin/dumb-init …" 4 days ago Up 5 hours gitlab_runner
Instead of automatically using the latest version of each image (e.g. gitlab/gitlab-ce:latest) you can also specify a version number like gitlab/gitlab-ce:14.5.2. This is helpful when you need to update a system in steps. Or if you need to follow a specific upgrade path, which is the case for GitLab.
As always: before you do such an update, make sure to create a backup of all your files. If something goes wrong, this may lead to data loss!
Manual update
To update an existing Docker container manually, the following steps are necessary;
Go to Registry and download new image (mostly the “latest” version)
Go to Container, select the container you need to update and stop it
From Actions menu select “Clear” Edit: Under DSM7, the “Clear” command has been renamed “Reset”.
Start the container again
This will clear the complete container and start with the newly downloaded Docker image. Since the data folders are mounted into the container, this will not erase the apllications data. Configurations are also not affected by this.
Side note: when updating a major version of gitlab/gitlab-ce, make sure to follow the update paths! This requires updates in smaller steps (minor versions).
Automatically update Docker images
Updating a Docker image manually might be fine for a small number of images. But there is a more elegant way by using another Docker container called Watchtower. This one can update Docker containers automatically. The image is called containrrr/watchtower. A simple setup can be performed with the following steps:
Load image containrrr/watchtower in the Docker registry
This will start the Watchtower image and update all container once. The container created for this runs once and can then be found switched off in the list of containers. Now you can start it manually again and again as needed or let it run at certain times via Synology Task Scheduler. The command for the task scheduler is then as follows:
docker start watchtower-once -a
Let Watchtower run permanently
Alternatively you can use the scheduler in Watchtower itself. If you want to start it every Monday at 4 a.m., then enter the following command on the shell:
It is important to set the time zone to your because otherwise you will have an offset to UTC. In addition, the container is not terminated but always restarted. Even if it crashed or the NAS was restarted. The last parameter uses the cron syntax for scheduling the task.
The setup described in this post has been tested on the following system:
DS216+II with 8GB RAM
DSM 6.2.3-25426 Update 2
In addition, the following software packages have already been installed on the system using the Synology package manager:
Docker 18.09.0-0513
GitLab is installed via the Docker Registry:
gitlab/gitlab-ce:latest (in my case GitLab 13.5.1-ce.0)
Install GitLab
You can skip this part, if GitLab is already running on your Synology and continue with the step Install GitLab Runner.
To install GitLab, open the Docker Registry and search for “gitlab”. Double click the entry gitlab/gitlab-ce:latest and select the latest version:
After the image is loaded, it will be listed under image. Launch this image and set the folders to be mounted as shown in the following image. This will simplify the access to the docker files within your Synology.
Mounted folder / volumes
Port settings
The port settings depend on your system. Normally, HTTP is accessible at port 80 or HTTPS on port 443. If your system already uses other apps that are running on those port, you can adjust them in Port Settings.
After completing the setup, it might take some time until the GitLab web surface is available. When accessing GitLab for the first time, you can specify a password for the root environment. The default username for the admin area is root. Now you can create user accounts, projects and perform any adjustments that fit your needs.
Install GitLab Runner
As the Synology DSM uses Docker to run GitLab, we can use Docker as well to install GitLab Runner. For this, connect to the Synology using SSH:
ssh <admin-user>@<synology> -p <port>
Now we can install the Gitlab Runner Docker container that can run other Docker containers to perform the runner tasks:
This will install a Docker container with the name gitlab_runner_docker which uses the same network as Docker (‘–network host‘).
As this container is the basis for our Docker-in-Docker setup, we connect the Docker socket of our main container to the new one by using -v /run/docker.sock:/var/run/docker.sock.
You might also use the Docker GUI of DSM to create the container. But the step above can only be done with the help of the console command!
To test the container, you can use the following command to connect to the console:
Runtime platform arch=amd64 os=linux pid=16 revision=e95f89a0 version=13.4.1
Running in system-mode.
Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/):
http://10.0.6.102:30000/
Please enter the gitlab-ci token for this runner:
ab1234abcd1234abcd12
Please enter the gitlab-ci description for this runner:
[synology]: docker_alpine
Please enter the gitlab-ci tags for this runner (comma separated):
Registering runner... succeeded runner=sA4DKorC
Please enter the executor: docker-ssh, parallels, docker+machine, kubernetes, docker, shell, ssh, virtualbox, docker-ssh+machine, custom:
docker
Please enter the default Docker image (e.g. ruby:2.6):
alpine:latest
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!
In this case, the executor docker and the base image alpine:latest is used for this container.
If you use a self-signed certificate for GItLab, then you have to specify the certificate with the option --tls-ca-file during registration:
Let’s connect to the bash terminal of this container to change some settings:
docker exec -it gitlab_runner_docker /bin/bash
The created Docker container is an alpine base system without any packages installed. To perform the changes, we need a simple terminal text editor like nano or vim. The following commands will install nano for this task:
apt-get update
apt-get install nano
Now you can use nano to edit the GitLab Runner config file:
nano /etc/gitlab-runner/config.toml
And add the following lines as highlighted in the config file below:
That’s it. Now you can use this GitLab Runner for your repositories and run jobs by using other Docker containers.
Example usage in .gitlab-ci.yml
The following example uses a php container to run tests for a simple PHP application and deploy the code to a server. Some of the settings depend on the setup of your PHP application, so the example will not work out of the box. But it can give you a good idea of what is possible.
# https://hub.docker.com/_/php
image: php:7.4-fpm
services:
- mysql:5.7
variables:
# Configure mysql environment variables (https://hub.docker.com/_/mysql/)
MYSQL_USER: $MYSQL_USER
MYSQL_PASSWORD: $MYSQL_PASSWORD
before_script:
# Initialize database, etc
stages:
- test
- deploy
test:
stage: test
script:
- composer install
- composer phpunit
deploy_production:
stage: deploy
environment:
name: production
url: https://www.example.com
script:
# run on server 'git checkout master && git pull origin master && exit'
only:
- master