Jenkins

automation

https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/cli/UpdateCredentialsByXmlCommand.java - update credentials code

{jenkins_server}/cli/ - cli docs

https://github.com/jenkinsci/job-dsl-plugin/wiki - example dsl configuartions

http://unethicalblogger.com/2017/07/24/groovy-automation-for-jenkins.html - groovy jenkins config

http://www.greenreedtech.com/creating-jenkins-credentials-via-the-rest-api/ - example of automating credentials

http://www.tsbakker.nl/jenkins.html - automation with CLI

https://github.com/sheehan/job-dsl-gradle-example/tree/master/src/jobs automating jobs

credentials

http://www.greenreedtech.com/creating-jenkins-credentials-via-the-rest-api/ - create credentials via REST

Github

h ttps://support.cloudbees.com/hc/en-us/articles/224621668-GitHub-User-Scopes-and-Organization-Permission - scopes needed

https://jenkins.io/solutions/github/ - current integration doc

https://support.cloudbees.com/hc/en-us/articles/224543927-GitHub-webhook-configuration - webhooks

builds

wrapping a process in try/catch will not fail the build on exit 1

docker runs

only defined step is 'Test'. declarative auto created steps

shared pipelines

https://jenkins.io/blog/2017/10/02/pipeline-templates-with-shared-libraries/

groovy tricks

https://github.com/cloudbees/jenkins-scripts

https://github.com/tkrzeminski/jenkins-groovy-scripts

https://github.com/edx/jenkins-configuration/tree/master/src/main/groovy

https://github.com/docker/jenkins-pipeline-scripts/tree/master/vars

https://github.com/blacklabelops/jenkins/tree/master/groovy

http://unethicalblogger.com/2017/07/24/groovy-automation-for-jenkins.html

println Jenkins.instance.metaClass.methods*.name.sort().unique()

Jenkins.instance.getItems().each {it -> 
  println it.name
}
Jenkins.instance.getComputers().eachWithIndex{ it, index ->
  println it.name
  println it.description
  println it.getAllExecutors()

  println it.metaClass.methods*.name.sort().unique()
}
println Jenkins.instance.metaClass.methods*.name.sort().unique()

execute script on slave

https://stackoverflow.com/questions/26583979/run-a-remote-command-on-all-jenkins-slaves-via-masterss-script-console

import hudson.util.RemotingDiagnostics;

print_ip = 'println InetAddress.localHost.hostAddress';
print_hostname = 'println InetAddress.localHost.canonicalHostName';

// here it is - the shell command, uname as example 
uname = 'def proc = "uname -a".execute(); proc.waitFor(); println proc.in.text';

for (slave in hudson.model.Hudson.instance.slaves) {
    println slave.name;
    println RemotingDiagnostics.executeGroovy(print_ip, slave.getChannel());
    println RemotingDiagnostics.executeGroovy(print_hostname, slave.getChannel());
    println RemotingDiagnostics.executeGroovy(uname, slave.getChannel());
}

get ips of computers

import hudson.model.Computer.ListPossibleNames

Jenkins.instance.getComputers().eachWithIndex{ it, index ->
  println it.name
  if (it.getChannel()) {
      println it.getChannel().call(new ListPossibleNames())
  }
}

execute bash on slave

https://gist.github.com/hfs/68b2f124d1952233ba49

import hudson.util.RemotingDiagnostics;

script = 'def proc = "ls -1 /home".execute(); proc.waitFor(); println proc.in.text';

for (slave in Jenkins.instance.slaves) {
  println slave.name;
  try {
    println RemotingDiagnostics.executeGroovy(script, slave.getChannel());
  } catch (all) {
    all.printStackTrace();
  }
}

list dirs on particular slave

import hudson.util.RemotingDiagnostics;

def workspace = '/home/jenkins/jenkins_slave/workspace/ration_ds1-ui-tests_develop-LYDYDYVNXVUTNVBKZNYKHEE2HAP2OLNY36LSUVBCCMTSPUWGACXQ'
script = "def proc = \'ls -1 ${workspace}\'.execute(); proc.waitFor(); println proc.in.text";

for (slave in Jenkins.instance.slaves) {
    println slave.name;
  if (slave.name == 'us2s-slave-name-0') {
    try {
          println RemotingDiagnostics.executeGroovy(script, slave.getChannel());
    } catch (all) {
        all.printStackTrace();
    }
  }
}

Declarative pipeline

https://gist.github.com/abayer/925c68132b67254147efd8b86255fd76

https://github.com/jenkinsci/pipeline-examples

Env vars

Debugging

sh 'printenv'

environment block

environment {
            HIPCHAT_NOTIFS = credentials('HIPCHAT_NOTIFS')
            hipchat_room = "${pipelineParams.prNotificationRoom}"
//            https://github.com/jenkinsci/hipchat-plugin/issues/103 single quote hipchat tokens
            hipchat_changes = '${HIPCHAT_CHANGES}'
            JENKINS_TEMPLATES_URL = "[email protected]:MyOrgName/repo-name.git"
        }

kill all jobs and pending

https://gist.github.com/realityforge/c57eb3d1854320d14252ac881fc6cedf

kill jobs

import hudson.model.*

def q = Jenkins.instance.queue

q.items.each {
  if (it =~ /deploy-to/) {
    q.cancel(it.task)
  }
}

kill pending

import hudson.model.*

def q = Jenkins.instance.queue

q.items.each { q.cancel(it.task) }

running docker containers with jenkins

https://jenkins.io/doc/book/pipeline/docker/#using-multiple-containers

Multiple containers can be tricky.

If you have a top level agent an override in one stage you will get a different workspace@2 and run into a strange error:

OCI runtime exec failed: exec failed: container_linux.go:296: starting container process caused "chdir to cwd

other possible issues: https://github.com/docker/cli/issues/297

Before:

pipeline {
    agent {
        docker { image 'maven:3-alpine' }
    }
    stages {
        stage('Back-end') {
            steps {
                sh 'mvn --version'
            }
        }
        stage('pcf') {
            steps {
                sh 'cf --version'
            }
        }

        stage('Front-end') {
            agent {
                docker { image 'node:7-alpine' }
            }
            steps {
                sh 'node --version'
            }
        }
    }
}

Solution:

pipeline {
    agent none
    stages {
        stage('Back-end') {
            agent {
                docker { image 'maven:3-alpine' }
            }
            steps {
                sh 'mvn --version'
            }
        }
        stage('pcf') {
            agent {
                docker { image 'maven:3-alpine' }
            }

            steps {
                sh 'cf --version'
            }
        }
        stage('Front-end') {
            agent {
                docker { image 'node:7-alpine' }
            }
            steps {
                sh 'node --version'
            }
        }
    }
}

Vars in docker agent block

https://issues.jenkins-ci.org/browse/JENKINS-42369

agent block can't access env.WORKSPACE or $HOME for instance. docker volumes must be an absolute path.

issue:

 stage('deploy') {
    agent {
        docker {
            image 'mrllsvc/pcf-tools:3'
            args "-v ${env.WORKSPACE}/:/home/pcf/tools/"
        }
    }
}

workaround 1:

stage('deploy') {
    agent {
        docker {
            image 'mrllsvc/pcf-tools:3'
            args "-v ${WORKSPACE}/:/home/pcf/tools/"
        }
    }
    parameters {
        string(defaultValue: '/home/jenkins/blah', description: '', name: 'WORKSPACE')
    }
}

Downside: paramaterized build is not as nice. default is not dynamic

finding a better solution:

looking at the logs...

00:53:26 $ docker run -t -d -u 1000:1000 bash cf-cli.sh -d jenkins-templates/deploy-params.json -w /home/vagrant/workspace/lar2-seed_jenkins-migration-ICO5IXAUDRSS4U26C74JGCAJHYXPZRHEECFNHNAA5JEOKVASU73A -v /home/vagrant/workspace/lar2-seed_jenkins-migration-ICO5IXAUDRSS4U26C74JGCAJHYXPZRHEECFNHNAA5JEOKVASU73A:/home/vagrant/workspace/lar2-seed_jenkins-migration-ICO5IXAUDRSS4U26C74JGCAJHYXPZRHEECFNHNAA5JEOKVASU73A:rw,z -v /home/vagrant/workspace/lar2-seed_jenkins-migration-ICO5IXAUDRSS4U26C74JGCAJHYXPZRHEECFNHNAA5JEOKVASU73A@tmp:/home/vagrant/workspace/lar2-seed_jenkins-migration-ICO5IXAUDRSS4U26C74JGCAJHYXPZRHEECFNHNAA5JEOKVASU73A@tmp:rw,z -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** mrllsvc/pcf-tools:3 cat
00:53:26 $ docker top 966271e9c4bf7663017dda99fda1ed3d271794f51b693a220790cb02b961a0e7 -eo pid,comm

jenkins will autocreate and mount the workspace. I do not need to modify the volume or workspace in this case

however... if i need to use a sub dir as base workspace i have an option that supports relative pathing from workspace root

customWorkspace

A string. Run the Pipeline or individualstagethisagentis applied to within this custom workspace, rather than the default. It can be either a relative path, in which case the custom workspace will be under the workspace root on the node, or an absolute path

this won't solve the above problem since WORKSPACE is created after agent. but will work in other scenarios with other global vars

stage('deploy') {
    agent {
        docker {
            image 'mrllsvc/pcf-tools:3'
            customWorkspace '$MYENVVAR/blah'
        }
    }
}

for the other example I can change to the sub directory

stage('deploy') {
    agent {
        docker {
            image 'mrllsvc/pcf-tools:3'
            customWorkspace '$MYENVVAR/blah'
        }
    }

    steps {
        script {
            dir('jenkins-templates') {
                sh 'ls -la'
            }
        }
    }
}

permissions issues

mounting a volume from the jenkins home can cause permissions issues:

https://support.cloudbees.com/hc/en-us/articles/218583777-How-to-set-user-in-docker-image-

https://github.com/jenkinsci/docker-workflow-plugin/pull/57

https://github.com/jenkinsci/docker/issues/165

https://github.com/jenkinsci/docker#usage

Avoid using a bind mount from a folder on host into

/var/jenkins_home

, as this might result in file permission issue. If you

really

need to bind mount jenkins_home, ensure that directory on host is accessible by the jenkins user in container (jenkins user - uid 1000) or use

-u some_other_user

parameter with

docker run