dockerfile for jenkins
This Dockerfile is based on following:
- Jenkins starting point is
config.xml; if its broken then it will fail to start! - Jenkins version 2 doesn't come with embedded with any plugins; so, it will "barf" if there is no plugins in the plugins directory of Jenkins home folder
- good read: https://wiki.jenkins.io/display/JENKINS/Administering+Jenkins
- First plugins are downloaded to this location: /usr/share/jenkins/ref/plugins and then they are moved to JENKINS_HOME
- OpenShift runs processes with user id 1001 and group 0; but we don't need that on k8s; see keep open eyes when you copy stuff
- the released versions of plugins are downloaded as provided in the list; but custom plugins will be required to be copied into the image
- in case of k8s the all the important "configs" are provided as configmap and they override what is in the docker image
run.shis the starting pointkube-slave-common.shcreates jenkins k8s plugin config I thinkfix-permissions.shis used to change permission in RUN; but I don't think we need on k8s as we already change ownershipassemble.shis used to move stuffinstall-plugins.shto install plugins
- update to latest version of Jenkins
- copy the missing commands needed from https://github.com/openshift/jenkins specifically the RUN part
- fix installation of plugins! that stops Jenkins from starting!
- remove openshift pieces from run.sh
- remove openshift pieces from other shell scripts if any!
- add custom plugins which can be added through a folder look assemble.sh line 25 - which is needed when we modify plugins ourselves
- ensure that Jenkins process is run by base image
- ensure it can't have root access; so, it must be Jenkins user
https://github.com/jenkinsci/docker https://hub.docker.com/r/jenkins/jenkins/
- openshiftsync (This is a direct dependency of
kubernetes-pipeline-pluginwhich we are using for Kubernetes IT)
- printenv
HOME=/var/jenkins_homecd /var/jenkins_home ls -l
-rw-r--r-- 1 jenkins jenkins 1684 Nov 17 21:17 config.xml
lrwxrwxrwx 1 jenkins jenkins 21 Nov 17 21:17 config.xml.tpl -> ..data/config.xml.tpl
-rw-r--r-- 1 jenkins jenkins 1031 Nov 17 21:17 copy_reference_file.log
-rw-r--r-- 1 jenkins jenkins 156 Nov 17 21:17 hudson.model.UpdateCenter.xml
lrwxrwxrwx 1 jenkins jenkins 29 Nov 17 21:17 hudson.tasks.Maven.xml -> ..data/hudson.tasks.Maven.xml
-rw------- 1 jenkins jenkins 1712 Nov 17 21:17 identity.key.enc
-rw-r--r-- 1 jenkins jenkins 94 Nov 17 21:17 jenkins.CLI.xml
-rw-r--r-- 1 jenkins jenkins 4 Nov 17 21:17 jenkins.install.InstallUtil.lastExecVersion
-rw-r--r-- 1 jenkins jenkins 4 Nov 17 21:17 jenkins.install.UpgradeWizard.state
lrwxrwxrwx 1 jenkins jenkins 58 Nov 17 21:17 jenkins.plugins.nodejs.tools.NodeJSInstallation.xml -> ..data/jenkins.plugins.nodejs.tools.NodeJSInstallation.xml
drwxr-xr-x 2 jenkins jenkins 4096 Nov 17 21:17 jobs
lrwxrwxrwx 1 jenkins jenkins 19 Nov 17 21:17 keycloak.url -> ..data/keycloak.url
drwxr-xr-x 3 jenkins jenkins 4096 Nov 17 21:17 logs
-rw-r--r-- 1 jenkins jenkins 907 Nov 17 21:17 nodeMonitors.xml
drwxr-xr-x 2 jenkins jenkins 4096 Nov 17 21:17 nodes
lrwxrwxrwx 1 jenkins jenkins 47 Nov 17 21:17 org.jenkinsci.main.modules.sshd.SSHD.xml -> ..data/org.jenkinsci.main.modules.sshd.SSHD.xml
lrwxrwxrwx 1 jenkins jenkins 68 Nov 17 21:17 org.jenkinsci.plugins.updatebot.GlobalPluginConfiguration.xml -> ..data/org.jenkinsci.plugins.updatebot.GlobalPluginConfiguration.xml
drwxr-xr-x 2 jenkins jenkins 4096 Nov 17 21:17 plugins
lrwxrwxrwx 1 jenkins jenkins 22 Nov 17 21:17 pre-shutdown.sh -> ..data/pre-shutdown.sh
lrwxrwxrwx 1 jenkins jenkins 25 Nov 17 21:17 scriptApproval.xml -> ..data/scriptApproval.xml
-rw-r--r-- 1 jenkins jenkins 64 Nov 17 21:17 secret.key
-rw-r--r-- 1 jenkins jenkins 0 Nov 17 21:17 secret.key.not-so-secret
drwx------ 4 jenkins jenkins 4096 Nov 17 21:17 secrets
drwxr-xr-x 2 jenkins jenkins 4096 Nov 17 21:17 updates
drwxr-xr-x 2 jenkins jenkins 4096 Nov 17 21:17 userContent
drwxr-xr-x 3 jenkins jenkins 4096 Nov 17 21:17 users
drwxr-xr-x 10 jenkins jenkins 4096 Nov 17 21:17 war
- to check uid, gid and groups run a command
id
bash-4.3$ id
uid=1000(jenkins) gid=1000(jenkins) groups=1000(jenkins)
Build an image:
docker build -t stakater/jenkins2 .
docker run -it --rm stakater/jenkins2
docker run -it --init --rm stakater/jenkins2:latest /bin/sh
--init does the cleanup and makes "CTRL + C" to work
- old fabric8 jenkins image:
https://github.com/fabric8io/jenkins-docker - current fabric8 jenkins image:
https://github.com/openshift/jenkins&https://github.com/fabric8io/openshift-jenkins-s2i-config - base jenkins docker image:
https://github.com/jenkinsci/docker/blob/master/Dockerfile-alpine - all the magic is happening here:
https://github.com/openshift/jenkins/blob/master/2/contrib/s2i/run
find / -type d -name "*blueocean-git-pipeline*" -print
- from
https://github.com/agileek/docker-jenkins/blob/master/Dockerfile
FROM openjdk:8u141-jdk
RUN apt-get update && apt-get install -y wget git curl zip && rm -rf /var/lib/apt/lists/*
ENV JENKINS_VERSION 2.91
RUN mkdir /usr/share/jenkins/
RUN useradd -d /home/jenkins -m -s /bin/bash jenkins
COPY init.groovy /tmp/WEB-INF/init.groovy.d/tcp-slave-angent-port.groovy
RUN curl -L http://mirrors.jenkins-ci.org/war/$JENKINS_VERSION/jenkins.war -o /usr/share/jenkins/jenkins.war \
&& cd /tmp && zip -g /usr/share/jenkins/jenkins.war WEB-INF/init.groovy.d/tcp-slave-angent-port.groovy && rm -rf /tmp/WEB-INF
ENV JENKINS_HOME /var/jenkins_home
RUN usermod -m -d "$JENKINS_HOME" jenkins && chown -R jenkins "$JENKINS_HOME"
VOLUME /var/jenkins_home
# for main web interface:
EXPOSE 8080
# will be used by attached slave agents:
EXPOSE 50000
USER jenkins
COPY jenkins.sh /usr/local/bin/jenkins.sh
ENTRYPOINT ["/usr/local/bin/jenkins.sh"]
jenkins.sh
#! /bin/bash
# if `docker run` first argument start with `--` the user is passing jenkins launcher arguments
if [[ $# -lt 1 ]] || [[ "$1" == "--"* ]]; then
exec java $JAVA_OPTS -jar /usr/share/jenkins/jenkins.war $JENKINS_OPTS "$@"
fi
# As argument is not jenkins, assume user want to run his own process, for sample a `bash` shell to explore this image
exec "$@"
The typical workflow to support a matching volume from the default image is:
- On the host machine, create a jenkins group with a GID that matches Jenkins Docker image
- On the host machine, create a jenkins user with a UID that matches the Jenkins Docker image, and assign this user to the jenkins group, created
- On the host machine, run Jenkins Docker container with a volume binding of your host machine jenkins user's home to the container's $JENKINS_HOME.
It's reasonable to expect the creation of a jenkins user and group on the host system for typical usage, I'll suggest that it's better to set the jenkins UID and GID in the Jenkins Docker image to be within the system user UID range and system group GID range, respectively. Setting the UID and GID within the system ranges will avoid having the jenkins user display in GUI login screens (see here and here). Although Jenkins Docker should not be run on a server with a GUI environment in production, you can expect your users to try it out in desktop machines. (You can probably expect some users to run Jenkins Docker in "production" from desktop machines, too.)
The major Linux distributions' user- and group-creation tools increment starting from SYS_UID_MIN and SYS_GID_MIN (100 on major Linux distros). RedHat/CentOS have a lower SYS_UID_MAX and SYS_GID_MAX (499). Assuming it's unlikely a system will have greater than 100 system users and groups, a value between 200 and 500 should be fine.
Maybe check the FreeBSD registered UIDs and FreeBSD registered GIDs to get an idea of what other services might use to make a collision even more unlikely. (I realize this is for a Unix, not Linux, but all the more chance to avoid collision.)
For example uid=386 and gid=386 meet all of the criteria above.
With all this said, it is impossible to avoid a UID/GID collision in every possible scenario. The best Jenkins Docker project can do is pick a value with an unlikely collision, like 386, and provide clear documentation on how to deal with a collision. I described this process in #277 under the heading "More information on custom builds of Jenkins Docker (workaround 2):". (As a side note, kudos to the Jenkins Docker maintainers for exposing uid and gid as ARGs.)
jenkinsci/docker#112 (comment) jenkinsci/docker#277 (comment)
most of the values for the arguments are obvious except for the value for JENKINS_SHA. I have found these values located in the corresponding subdirectory of your desired Jenkins version under https://repo.jenkins-ci.org/releases/org/jenkins-ci/main/jenkins-war/. For example, the SHA1 checksum for Jenkins 2.2 is located at https://repo.jenkins-ci.org/releases/org/jenkins-ci/main/jenkins-war/2.2/jenkins-war-2.2.war.sha1
need to build the url manually and then download the file!
https://github.com/openshift/jenkins/blob/master/2/Dockerfile
FROM openshift/origin
# Jenkins image for OpenShift
#
# This image provides a Jenkins server, primarily intended for integration with
# OpenShift v3.
#
# Volumes:
# * /var/jenkins_home
# Environment:
# * $JENKINS_PASSWORD - Password for the Jenkins 'admin' user.
MAINTAINER Ben Parees <[email protected]>
# Jenkins LTS packages from
# https://pkg.jenkins.io/redhat-stable/
ENV JENKINS_VERSION=2 \
HOME=/var/lib/jenkins \
JENKINS_HOME=/var/lib/jenkins \
JENKINS_UC=https://updates.jenkins-ci.org \
LANG=en_US.UTF-8 \
LC_ALL=en_US.UTF-8
LABEL k8s.io.description="Jenkins is a continuous integration server" \
k8s.io.display-name="Jenkins 2" \
openshift.io.expose-services="8080:http" \
openshift.io.tags="jenkins,jenkins2,ci" \
io.openshift.s2i.scripts-url=image:///usr/libexec/s2i
# 8080 for main web interface, 50000 for slave agents
EXPOSE 8080 50000
RUN curl https://pkg.jenkins.io/redhat-stable/jenkins.repo -o /etc/yum.repos.d/jenkins.repo && \
rpm --import https://pkg.jenkins.io/redhat-stable/jenkins-ci.org.key && \
yum install -y centos-release-scl-rh && \
INSTALL_PKGS="dejavu-sans-fonts rsync gettext git tar zip unzip java-1.8.0-openjdk java-1.8.0-openjdk.i686 java-1.8.0-openjdk-devel java-1.8.0-openjdk-devel.i686 jenkins-2.73.3-1.1" && \
yum -y --setopt=tsflags=nodocs install $INSTALL_PKGS && \
rpm -V $INSTALL_PKGS && \
yum clean all && \
localedef -f UTF-8 -i en_US en_US.UTF-8
# why do they copy stuff into different directories? I couldn't understand it!
COPY ./contrib/openshift /opt/openshift
COPY ./contrib/jenkins /usr/local/bin
ADD ./contrib/s2i /usr/libexec/s2i
RUN /usr/local/bin/install-plugins.sh /opt/openshift/base-plugins.txt && \
# need to create <plugin>.pinned files when upgrading "core" plugins like credentials or subversion that are bundled with the jenkins server
# Currently jenkins v2 does not embed any plugins, but for reference:
# touch /opt/openshift/plugins/credentials.jpi.pinned && \
rmdir /var/log/jenkins && \
chmod 775 /etc/passwd && \
chmod -R 775 /etc/alternatives && \
chmod -R 775 /var/lib/alternatives && \
chmod -R 775 /usr/lib/jvm && \
chmod 775 /usr/bin && \
chmod 775 /usr/lib/jvm-exports && \
chmod 775 /usr/share/man/man1 && \
chmod 775 /var/lib/origin && \
unlink /usr/bin/java && \
unlink /usr/bin/jjs && \
unlink /usr/bin/keytool && \
unlink /usr/bin/orbd && \
unlink /usr/bin/pack200 && \
unlink /usr/bin/policytool && \
unlink /usr/bin/rmid && \
unlink /usr/bin/rmiregistry && \
unlink /usr/bin/servertool && \
unlink /usr/bin/tnameserv && \
unlink /usr/bin/unpack200 && \
unlink /usr/lib/jvm-exports/jre && \
unlink /usr/share/man/man1/java.1.gz && \
unlink /usr/share/man/man1/jjs.1.gz && \
unlink /usr/share/man/man1/keytool.1.gz && \
unlink /usr/share/man/man1/orbd.1.gz && \
unlink /usr/share/man/man1/pack200.1.gz && \
unlink /usr/share/man/man1/policytool.1.gz && \
unlink /usr/share/man/man1/rmid.1.gz && \
unlink /usr/share/man/man1/rmiregistry.1.gz && \
unlink /usr/share/man/man1/servertool.1.gz && \
unlink /usr/share/man/man1/tnameserv.1.gz && \
unlink /usr/share/man/man1/unpack200.1.gz && \
chown -R 1001:0 /opt/openshift && \
/usr/local/bin/fix-permissions /opt/openshift && \
/usr/local/bin/fix-permissions /var/lib/jenkins && \
/usr/local/bin/fix-permissions /var/log
VOLUME ["/var/lib/jenkins"]
USER 1001
ENTRYPOINT []
CMD ["/usr/libexec/s2i/run"]
Jenkins home directory of a working Jenkins has following stuff:
bash-4.2$ cd /var/lib/jenkins/
bash-4.2$ ls -l
total 316
drwxr-xr-x. 3 default root 4096 Nov 23 10:04 caches
-rw-r--r--. 1 default root 365 Nov 17 14:36 com.dabsquared.gitlabjenkins.GitLabPushTrigger.xml
-rw-r--r--. 1 default root 604 Nov 23 11:17 com.dabsquared.gitlabjenkins.connection.GitLabConnectionConfig.xml
-rw-r--r--. 1 default root 4687 Nov 23 11:17 config.xml
-rw-r--r--. 1 default root 4063 Nov 17 14:35 config.xml.tpl
-rw-r--r--. 1 default root 0 Nov 17 14:35 configured
drwxr-xr-x. 3 default root 4096 Nov 23 10:05 fingerprints
-rw-r--r--. 1 default root 159 Nov 23 11:17 hudson.model.UpdateCenter.xml
-rw-r--r--. 1 default root 370 Nov 17 14:36 hudson.plugins.git.GitTool.xml
-rw-r--r--. 1 default root 222 Nov 17 14:36 hudson.plugins.openid.OpenIdLoginService$GlobalConfigurationImpl.xml
-rw-r--r--. 1 default root 569 Nov 17 14:35 hudson.tasks.Maven.xml
-rw-------. 1 default root 1712 Nov 17 14:36 identity.key.enc
-rw-r--r--. 1 default root 309 Nov 25 21:13 io.fabric8.jenkins.openshiftsync.GlobalPluginConfiguration.xml
-rw-r--r--. 1 default root 196 Nov 23 10:04 jenkins.model.JenkinsLocationConfiguration.xml
-rw-r--r--. 1 default root 820 Nov 17 14:35 jenkins.plugins.nodejs.tools.NodeJSInstallation.xml
drwxr-xr-x. 3 default root 4096 Nov 23 10:04 jobs
-rw-r--r--. 1 default root 39 Nov 17 14:35 keycloak.url
drwxr-xr-x. 5 default root 4096 Nov 29 15:32 logs
-rw-r--r--. 1 default root 907 Nov 23 11:17 nodeMonitors.xml
drwxr-xr-x. 2 default root 4096 Nov 26 10:39 nodes
-rw-r--r--. 1 default root 135 Nov 17 14:35 org.jenkinsci.main.modules.sshd.SSHD.xml
-rw-r--r--. 1 default root 1172 Nov 23 11:17 org.jenkinsci.plugins.ghprb.GhprbTrigger.xml
-rw-r--r--. 1 default root 236 Nov 23 11:17 org.jenkinsci.plugins.updatebot.GlobalPluginConfiguration.xml
-rw-r--r--. 1 default root 46 Nov 26 10:39 org.jenkinsci.plugins.workflow.flow.FlowExecutionList.xml
-rw-r--r--. 1 default root 72 Nov 17 14:35 password
drwxr-xr-x. 137 default root 12288 Nov 23 11:16 plugins
-rw-r--r--. 1 default root 1079 Nov 17 14:35 pre-shutdown.sh
-rw-r--r--. 1 default root 130 Nov 23 11:16 queue.xml.bak
-rw-r--r--. 1 default root 18940 Nov 17 14:35 scriptApproval.xml
-rw-r--r--. 1 default root 64 Nov 17 14:35 secret.key
-rw-r--r--. 1 default root 0 Nov 17 14:35 secret.key.not-so-secret
drwx------. 4 default root 4096 Nov 23 10:05 secrets
drwxr-xr-x. 2 default root 4096 Nov 30 11:17 updates
drwxr-xr-x. 2 default root 4096 Nov 17 14:36 userContent
drwxr-xr-x. 3 default root 4096 Nov 23 10:04 users
drwxr-xr-x. 10 default root 4096 Nov 17 14:35 war
drwxr-xr-x. 2 default root 4096 Nov 17 14:36 workflow-libs
when Jenkins started although un-successfully the directory looks like this:
-rw-r--r-- 1 root root 2301 Nov 30 11:33 config.xml
-rw-r--r-- 1 root root 2328 Nov 30 11:33 config.xml.tpl
-rw-r--r-- 1 root root 0 Nov 30 11:33 configured
-rw-r--r-- 1 root root 281 Nov 30 11:33 credentials.xml
-rw-r--r-- 1 root root 311 Nov 30 11:33 credentials.xml.tpl
-rw-r--r-- 1 root root 29 Nov 30 11:33 failed-boot-attempts.txt
-rw-r--r-- 1 root root 156 Nov 30 11:33 hudson.model.UpdateCenter.xml
-rw------- 1 root root 1712 Nov 30 11:33 identity.key.enc
-rw-r--r-- 1 root root 1500 Nov 30 11:33 jenkins.CLI.xml
drwxr-xr-x 2 root root 4096 Nov 30 11:33 jobs
drwxr-xr-x 2 root root 4096 Nov 30 11:33 logs
-rw-r--r-- 1 root root 136 Nov 30 11:33 org.jenkinsci.main.modules.sshd.SSHD.xml
-rw-r--r-- 1 root root 1 Nov 30 11:33 password
drwxr-xr-x 2 root root 4096 Nov 30 11:33 plugins
-rw-r--r-- 1 root root 129 Nov 30 11:33 queue.xml
-rw-r--r-- 1 root root 64 Nov 30 11:33 secret.key
-rw-r--r-- 1 root root 0 Nov 30 11:33 secret.key.not-so-secret
drwx------ 4 root root 4096 Nov 30 11:33 secrets
drwxr-xr-x 3 root root 4096 Nov 30 11:33 users
drwxr-xr-x 10 root root 4096 Nov 30 11:33 war