/stateless-jenkins

Primary LanguageGroovy

Stateless Jenkins

Stateless jenkins is a batteries included dockerized configuration of jenkins that is intended to be 100% stateless. i.e. volume persistence is not required.

Bootstrapping

Stateless jenkins is configure by specifying one or more REPO's as an environment variables. Each REPO can either be a local file path or a remote git repo.

For each REPO stateless-jenkins will:

  • Check for a Jenkinsfile and if found create a job with the REPO name.
  • Check for a jobs directory and create a new job per file inside the directory.
  • Search for any subdirectory with a Jenkinsfile and create a job in a folder for that directory.
  • Check for a Jenkinsfile.repos text file containing a full repo path per line and recursively clone and bootstrap each repo.

Example

Folder Structure


├── Jenkinsfile
├── jobs
│   ├── Job 1.jenkinsfile
│   ├── Job 2.jenkinsfile
├── Job 3
│   ├── Jenkinsfile
├── Job 4
│   ├── Jenkinsfile

The above example will create a folder with 5 jobs (1 called Base for the root Jenkinsfile)

Job DSL

You can leverage the job-dsl-plugin by creating 2 files:

Jenkinsfile

pipeline {
    agent any
    triggers {
        pollSCM("H/5 * * * *")
    }
    stages {
        stage('Update Jobs') {
            steps {
              sshagent(['deploy']) {
                    checkout scm
                    jobDsl removedConfigFilesAction: 'DELETE', removedJobAction: 'DELETE', removedViewAction: 'DELETE', targets: 'Jenkinsfile.job'
                }
            }
        }
    }
}

Jenkinsfile.job

job('PROJ-unit-tests') {
    scm {
        git(gitUrl)
    }
    triggers {
        scm('*/15 * * * *')
    }
    steps {
        maven('-e clean test')
    }
}

Image Configuration

Jenkins installed to: /var/jenkins:

  • Blue Ocean
  • AWS, Azure, AD, LDAP, Bitbucket plugins

Additional Tools

Configuration

Environment Var Required Description
REPO Yes Git repo ( e.g. ssh://git@github.com/acme/jenkins-config or /work/repos/jenkins-config, Branches can be specified using ?branch=)
DEPLOY_KEY No Path to a SSH deploy private key, can be referenced in jobs using deploy credential id. defaults to /etc/jenkins/keys/ssh-private
GLOBAL_SHARED_LIBRARY No Git repo to use as global shared library
URL Yes Public URL that the jenkins is accessible at
EMAIL Yes Git / Notifications email
ADMIN_PASS No admin user password, defaults to admin
API_USER No Can be referenced in jobs using api credential id.
API_PASS No
JAVA_OPTS No JVM Arguments
JENKINS_OPTS No Jenkins Arguments
JENKINS_SLAVE_AGENT_PORT No Defaults to 50001
DISABLE_CSRF No Defaults to false,
LDAP_SERVER
LDAP_USER
LDAP_PASS
LDAP_ROOT_DN
AD_SERVER
AD_DOMAIN
AD_SITE
AD_USER
AD_PASS
READ_GROUP authenticated
ADMIN_GROUP Jenkins Admins

Running using docker

Run a docker container mapping the keys into the container using a volume:

docker run  -p 8080:8080 -e REPO=git@github.com/org/jenkins-jobs.git -e DEPLOY_KEY=/etc/jenkins/keys/ssh-private -v $PWD/ssh-private/ssh-keys:/etc/jenkins/keys/ssh-private --privileged --rm jenkins

Running using kubernetes

Create or import a Kubernetes SSH secret:

kubectl create secret generic deploy-key --from-file=ssh-private=~/.ssh/id_rsa

Mount the SSH keys as a volume

apiVersion: apps/v1beta1
kind: Deployment
metadata:
  name: jenkins
spec:
  replicas: 1
  template:
    metadata:
      labels:
        app: jenkins
    spec:
      securityContext:
        privileged: true
      containers:
      - env:
        - name: REPO
          value: git@github.com/org/jenkins-jobs.git
        image: moshloop/stateless-jenkins:3.32
        imagePullPolicy: Always
        name: jenkins
        ports:
        - containerPort: 8080
          protocol: TCP
        volumeMounts:
        - mountPath: /etc/jenkins/keys/
          name: deploy-keys
      volumes:
      - name: deploy-key
        secret:
          secretName: deploy-key

To update to the latest plugins

python update-plugins.py plugins.txt