John Siu Blog

Docker Jenkins - How To

☰ Table of Content

Setup Jenkins using official docker image.

Image

Docker Hub: jenkins/jenkins:lts¹

Mappings

Host	Inside Container	Usage
$MY_JENKINS_IMG	N/A	Jenkins image name
$MY_JENKINS_NAME	N/A	Docker container name
$MY_JENKINS_HTTP	default:8080, see $JENKINS_OPTS below	Jenkins http port
$MY_JENKINS_HTTPS	see $JENKINS_OPTS below	Jenkins https port
$MY_JENKINS_SLAV	$JENKINS_SLAVE_AGENT_PORT 50000	Jenkins slave agent port
$MY_JENKINS_DATA	/var/jenkins_home	Persistent storage
$MY_JENKINS_OPTS	$JENKINS_OPTS	Environmental variable for jenkins options
$MY_JENKINS_CERT	see $JENKINS_OPTS below, map to –httpsCertificate	Path of certificate file to be mapped into container
$MY_JENKINS_KEY	see $JENKINS_OPTS below, map to –httpsPrivateKey	Path of key file to be mapped into container

JENKINS_OPTS	Usage
–httpPort	default 8080, no http if -1
–httpsPort	https ports if defined. Must also define
–httpsCertificate	Full path of certification file inside container
–httpsPrivateKey	Full path of key file inside container
–prefix	Site URL prefix. eg. `http://mydomain.com/jenkins`, then –prefix=/jenkins

Preparation

In this exercise, we will use following setup:

Variable	Value	Comment
$MY_JENKINS_IMG	jenkins/jenkins:lts	Jenkins image name
$MY_JENKINS_NAME	my_jenkins	Docker container name
$MY_JENKINS_HTTP	-1	We are not using http
$MY_JENKINS_HTTPS	8443	We will use port 8443 for https
$MY_JENKINS_SLAV	50000	Same as default in container
$MY_JENKINS_DATA	/var/my_jenkins_home	Persistent storage
$MY_JENKINS_CERT	/var/my_jenkins_home/cert.pem	Remember to define in JENKINS_OPTS, but no separate volume mapping needed
$MY_JENKINS_KEY	/var/my_jenkins_home/key.pem	Remember to define in JENKINS_OPTS, but no separate volume mapping needed

JENKINS_OPTS	Value	Comment
–httpPort	$MY_JENKINS_HTTP	No http port
–httpsPort	$MY_JENKINS_HTTPS	This will be 8443 as defined above
–httpsCertificate	/var/jenkins_home/cert.pem	Included in $MY_JENKINS_DATA mapping
–httpsPrivateKey	/var/jenkins_home/key.pem	Included in $MY_JENKINS_DATA mapping

So our $JENKINS_OPTS is as follow:

1
--httpPort=$MY_JENKINS_HTTP --httpsPort=$MY_JENKINS_HTTPS --httpsCertificate=/var/jenkins_home/cert.pem --httpsPrivateKey=/var/jenkins_home/key.pem

Test

Following are running commands using variables prepared above:

With HTTP only:

1
2
3
4
5
6
7
docker run \
--rm \
--name ${MY_JENKINS_NAME} \
-p ${MY_JENKINS_HTTP}:${MY_JENKINS_HTTP} \
-p ${MY_JENKINS_SLAV}:50000 \
-v ${MY_JENKINS_DATA}:/var/jenkins_home \
${MY_JENKINS_IMG}

With HTTPS:

1
2
3
4
5
6
7
8
docker run \
--rm \
--name ${MY_JENKINS_NAME} \
-p ${MY_JENKINS_HTTPS}:${MY_JENKINS_HTTPS} \
-p ${MY_JENKINS_SLAV}:50000 \
-v ${MY_JENKINS_DATA}:/var/jenkins_home \
-e JENKINS_OPTS=${JENKINS_OPTS}
${MY_JENKINS_IMG}

docker run option	Usage
-d	Run as daemon
–rm	Automatically remove the container when it exits
-v <source path in host>:<target path in container>	Map a path(file/dir) from host to a path in container
-p <host port>:<container port>	Map a port from host to a port in container
-e VAR_NAME=VALUE	Set environment variables inside the container
–name	Set name of container created

Run

Plug in all values manually, and run it as follow:

With HTTP only:

1
2
3
4
5
6
7
docker run \
--rm \
--name my_jenkins \
-p 8080:8080 \
-p 50000:50000 \
-v /var/my_jenkins_home:/var/jenkins_home \
jenkins/jenkins:lts

With HTTPS:

1
2
3
4
5
6
7
8
docker run \
--rm \
--name my_jenkins \
-p 8443:8443 \
-p 50000:50000 \
-v /var/my_jenkins_home:/var/jenkins_home \
-e JENKINS_OPTS="--httpPort=-1 --httpsPort=8443 --httpsCertificate=/var/jenkins_home/cert.pem --httpsPrivateKey=/var/jenkins_home/key.pem" \
jenkins/jenkins:lts

Output:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
*************************************************************
*************************************************************
*************************************************************

Jenkins initial setup is required. An admin user has been created and a password generated.
Please use the following password to proceed to installation:

<a 32-characters password here->

This may also be found at: /var/jenkins_home/secrets/initialAdminPassword

*************************************************************
*************************************************************
*************************************************************

2019-09-15 07:46:54.728+0000 [id=46]    INFO    hudson.model.UpdateSite#updateData: Obtained the latest update center data file for UpdateSource default
2019-09-15 07:46:56.381+0000 [id=46]    INFO    h.m.DownloadService$Downloadable#load: Obtained the updated data file for hudson.tasks.Maven.MavenInstaller
2019-09-15 07:46:56.381+0000 [id=46]    INFO    hudson.util.Retrier#start: Performed the action check updates server successfully at the attempt #1
2019-09-15 07:46:56.387+0000 [id=46]    INFO    hudson.model.AsyncPeriodicWork$1#run: Finished Download metadata. 15,168 ms
2019-09-15 07:46:56.518+0000 [id=29]    INFO    hudson.model.UpdateSite#updateData: Obtained the latest update center data file for UpdateSource default
2019-09-15 07:46:56.804+0000 [id=28]    INFO    jenkins.InitReactorRunner$1#onAttained: Completed initialization
2019-09-15 07:46:56.832+0000 [id=20]    INFO    hudson.WebAppMain$3#run: Jenkins is fully up and running

Access the jenkins site in browser with http://<hostname|ip>:8080/ or http://<hostname|ip>:8443/, depending on your setup.

Use the password shown in your terminal to login the site, choose plugins and setup your first administrator account.

Once administrator account is setup, go back your terminal and use ctrl-c to stop the container.

Compose

We will use docker compose to make running private registry more streamline and manageable.

Create a directory compose_jenkins and create the following files inside it:

.env

1
2
3
4
5
6
7
MY_JENKINS_IMG=jenkins/jenkins:lts
MY_JENKINS_NAME=my_jenkins
MY_JENKINS_HTTP=8080
MY_JENKINS_HTTPS=8443
MY_JENKINS_SLAV=50000
MY_JENKINS_DATA=/var/my_jenkins_home
MY_JENKINS_OPTS="--httpPort=-1 --httpsPort=$MY_JENKINS_HTTPS --httpsCertificate=/var/jenkins_home/cert.pem --httpsPrivateKey=/var/jenkins_home/key.pem"

docker-compose

For HTTP only:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
version: '3'
services:
  jenkins:
    image: ${MY_JENKINS_IMG}
    container_name: ${MY_JENKINS_NAME}
    ports:
      - ${MY_JENKINS_HTTP}:8080
      - ${MY_JENKINS_SLAV}:50000
    volumes:
      - ${MY_JENKINS_DATA}:/var/jenkins_home
    restart: always

For HTTPS:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
version: '3'
services:
  jenkins:
    image: ${MY_JENKINS_IMG}
    container_name: ${MY_JENKINS_NAME}
    ports:
      - ${MY_JENKINS_HTTPS}:8443
      - ${MY_JENKINS_SLAV}:50000
    volumes:
      - ${MY_JENKINS_DATA}:/var/jenkins_home
    environment:
      - MY_JENKINS_OPTS=${MY_JENKINS_OPTS}
    restart: always

Start

Inside compose_jenkins directory:

1
2
cd compose_jenkins
docker-compose up -d

When docker-compose² is executed, it automatically look for two default files in current directory: docker-compose-yml³ and .env⁴.

It will use variables in .env as environment variables. The .env file must be present in the current working folder.

Currently there is no command line option to specify an alternative .env file.
Variables already set in shell and command line will override .env.

It will create containers(s) base on docker-compose.yml.

-f can specify one or more compose file, other than the default.

Output:

1
Starting my_jenkins ... done

Verify the jenkins site with your administrator username and password.

Status

Check status with ps

1
2
cd compose_jenkins
docker-compose up -d

Output:

1
2
3
   Name                 Command               State                        Ports
------------------------------------------------------------------------------------------------------
my_jenkins   /sbin/tini -- /usr/local/b ...   Up      0.0.0.0:50000->50000/tcp, 0.0.0.0:8080->8080/tcp

Stop

1
2
cd compose_jenkins
docker-compose stop

Output:

1
Stopping my_jenkins ... done

Now our jenkins is ready!

John Siu

Update: 2020-08-28

Tag

[cicd]

[docker]

[how-to]

[jenkins]

Docker Jenkins - How To

Image

Mappings

Preparation

Test

Run

Compose

.env

docker-compose

Start

Status

Stop

John Siu

<< Id3go - ID3v2 Tag Editor

Screen Command >>