jocker (jenkins in docker)

Prerequisites

Makefile

• pwgen

apt-get install pwgen

Introduction

Mini jenkins docker container that run jenkins as code. The jenkins is configured with a init.groovy script that does things like.

• disable CSRF protection (remote calls)
• (Jenkins/Setup): create and run the seed jobs
  • (Jenkins/Configure): run configure as code and custom groovy scripts
  • (Jenkins/Jobs): create all the build jobs
• setup the user base (admin/random password user with api token)
  • both is written to the stdout

The seed jobs are defined in 'dsl/bootstrap.groovy' and creates the following 3 jobs.

• Jenkins/Setup

This seed job orchestrate all the other seed jobs see below.

• Jenkins/Configure

This seed job that run the configure as code (casc) plugin and custom groovy script that disable the csrf protection, add script approvals, set timezone, ...

• Jenkins/Jobs

This seed job load all the jobDSL files to create the build/pipeline jobs based on the provided jobDSL files.

Usage

Build

To build the jenkins in docker image run the listed command below.

make build

Local Runtime

make jocker logs

Jenkins

Local Test

make jocker
sleep 60 #wait until jenkins finish bootsrap and Configure job ran
make test

Local Git Repository

The jenkins docker container can be configured to use local git repositories. The argument LOCAL_GIT=true set the following configuration for the .gitconfig inside the jenkins container.

This configuration is part of the init.groovy script.

[url "ssh://git@local.github.com/"]
       insteadOf = https://github.com/

[url "ssh://git@local.github.com/"]
       insteadOf = git@github.com:

This local.github.com domain can then be used to point the jenkins to a local git server like git-server-docker by just add the following entry to your /etc/hosts file.

192.168.65.2 local.github.com

For a full tutorial check out the git-server-docker README documentation.

The following command start the jenkins container and instead of using the github.com every github repository in jenkins is resolved to local.github.com.

echo LOCAL_GIT=true > jocker.env
make jocker logs

Jenkins

There are ready to use docker jenkins agents for different programming languages or tools.

At the moment there are only one docker jenkins agent for golang

Jenkins Golang Docker Agents

This docker image provide an ready to use jnlp jenkins agents with golang support.

• installed golang 1.12
• installed pulumi latest version at build time

The jocker-agents-golang docker image is based on this github repo jocker-agents.

Jenkins

Structure

├── deployKeys
├── dsl
├── init.groovy.d
└── shared-library

├── Dockerfile
├── Makefile
├── README.md
├── deployKey
│   └── jocker-shared-library-private-key
├── dsl
│   └── bootstrap.groovy
├── init.groovy.d
│   ├── init.groovy
│   └── scriptApproval.xml
├── plugins.txt
└── shared-library
    ├── config
    │   ├── casc-plugin
    │   │   ├── credentials.yaml                # define jenkins credential secrets like deploy key's for example.
    │   │   └── jenkins.yaml
    │   └── groovy
    │       ├── cascPlugin.groovy
    │       ├── csrf.groovy
    │       ├── scriptApproval.groovy
    │       ├── timezone.groovy
    │       └── userPublicKeys.groovy
    ├── jobDSL
    │   └── folders.groovy
    └── pipeline.groovy

Configuration as Code Plugin

The casc (Configuration as Code) plugin overwrites any previous defined configuration. There is no merge strategy.

Be care full the deploy keys defined in the init.groovy file are overwritten by the credentials.yaml casc configuration file. That's why the deploy key is defined twice once in the deploy-key-shared-library file and in the credentials.yaml casc file.

Configure Shared Library

The Shared Library contains

Jenkins CLI

Need open jenkins cli port default is 50000

curl -sI  http://host.docker.internal:8080

Contribution

Big thank goes to fishi0x01.

Who convince and inspired my for the whole jenkins in docker approach and also builded the first jenkins-as-code poc of it. Most of this repository is build on top of jenkins-as-code repository.

TODO

• pass shared library deploy key at runtime
• support changes on the plugins.txt file at starttime

History

13.02.2020

• configure shared libary git repository as docker environment variable

22.02.2020

• add random password creation for user admin
• add approveScript method signature to the scriptApproval.xml file

28.02.2020

• add ADMIN_PASSWORD environment variable to set the admin user password

01.03.2020

• fix broken admin password generation in init.groovy script.

15.03.2020

• setup shared library and move pipeline code to it fr123k/jenkins-shared-library