A collection of groovy scripts that can be used to simplify the configuration of Jenkins.
Though it is possible to run them without it, these scripts have been wrtten to work in conjunction with the Jenkins Startup Scripts Runner project. Please see that project for details on how to confgure and invoke these scripts.
To add another script, simply place the file inside the scripts directory and add the details to the "config/scripts.config" file. The following snippet, for example, would configure a script called "newscript.groovy" in the scripts directory, that would only be evaluated if the configuration file contains a non null value for config.tools.newtool.
newscript {
script = "scripts/newscript.groovy"
configPath = "config?.tools?.newtool"
}
The scripts themselves are pretty easy to write, take a look at the existing scripts - you should find something that is similar to the problem you are trying to solve.
There are plenty of examples of how to write tests in this codebase already. Most of the existing tests start up an instance of Jenkins and test the state after a certain script has been executed. Much of the hard work has been done already so try not to reinvent the wheel.
Note. As an added bonus, when you add a test config file to the src/test/resources/scripts directory it will be automatically added to these docs when they are auto-generated. See below for instructions.
ActiveDirectory
activeDirectory {
domain = 'host.local'
server = 'server.example.com:3268'
site = 'ABC'
bindName = 'dn'
bindPassword = 'pwd'
}Tested Plugin Versions: active-directory-2.0.hpi, mailer-1.20.hpi, display-url-api-2.2.0.hpi
Anchore
anchore {
debug = false
enabled = true
useSudo = false
engineMode = 'anchoreengine'
// Engine mode parameters
engineUrl = 'https://example.com/anchore'
engineUser = 'admin'
enginePass = 'foobar'
engineVerifySSL = false
// Local mode parameters
containerImageId = 'anchore/jenkins:latest'
containerId = 'jenkins_anchore'
}Tested Plugin Versions: anchore-container-scanner-1.0.12.hpi, structs-1.14.hpi
Commands
commands {
spiderman=[
// remember to add '> dev null' to prevent logging sensitive information
command: "echo 'Peter Parker' > ${jenkinsHome}/spiderman",
description:'Write to the Spiderman file',
]
}Tested Plugin Versions: NA
ConfigFiles
configfiles {
loansGlobal = [
id: 'id1',
name: 'name1',
comment: 'comment1',
content: '<settings>1</settings>',
replaceAll: 'true',
servers: [
[serverId: 'server1', credentialsId: 'credentialsId1'],
[serverId: 'server2', credentialsId: 'credentialsId2']
]
]
}Tested Plugin Versions: config-file-provider-2.15.7.hpi, credentials-2.1.16.hpi, ssh-credentials-1.13.hpi, structs-1.14.hpi, token-macro-2.3.hpi, workflow-job-2.21.hpi, workflow-step-api-2.14.hpi, workflow-api-2.27.hpi, workflow-support-2.17.hpi, scm-api-2.2.6.hpi, script-security-1.44.hpi
Confluence
tools {
confluence = [
[
url: 'http://confluence.sandbox.extranet.group/',
username: 'arvind.kumar',
password: 'ENC(AAAADMlEpxykoqaB2T3ilF48y9tU0RuTh08QXuYdA9fy359sMJc506xz)'
]
]
}Tested Plugin Versions: confluence-publisher-1.8.hpi
Credentials
credentials {
repository=['username':'repository', 'password':'ENC(AAAADKGPigC2vDGp7Btx8Z+KyEmJUp8DobiaJ9QoaoxS0nWk7feTvo0O)', 'description':'repository credentials']
cloud=['username':'cloud', 'password':'ENC(AAAADBG5Hw+6UzWIbJQogBA7PjSUDZAF4TGqfwzkuL/CbbTn8w==)', 'description':'cloud credentials']
ssh=['username':'ssh', 'password':'ENC(AAAADDp9istmVU5kLc8CDFArqEAWel5iQmveVw/ro3bgwY1QLQ==)', 'description':'node credentials', 'type': 'SSH', 'privateKeyFile':'.ssh/id_rsa']
vault=['description': 'vault credentials', 'key':'super/secret', 'usernameKey': "username", 'passwordKey': "password", 'type': 'HashicorpVault']
saucelabs=['description': 'SauceLabs credentials', 'username': 'slUser', 'apiKey': 'slApiKey', 'type': 'SauceLabs']
gitlab=['description': 'Gitlab credentials', 'token': 'ENC(AAAADKDFECe0WbaVge4XD0Nia2fnfWhZ5Ee9CLfhixui/3ak128pV4fw)', 'type': 'GitLabApiToken']
string=['description': 'auth token', 'token': 'ENC(AAAADMoiy5CDV7xwFgER+pLGnPNRsYKtWstLzDgJYOiBn72y7KLu6/Di)', 'type': 'StringCredential']
azureServicePrincipal=['id': 'azure-sp-id', 'description': 'azure SP', 'subscriptionId':'ENC(AAAADKJo6t6KaVbHUf97+bW1VLTlzOdsWS+HRuAd/gCxOmWX/V7pffZx+dAO+6E41g==)', 'clientId': 'ENC(AAAADJEPBS43p1UhJ7tlU4uOXcBKlGTMOKfGuSmprEiK/wxt0t7xzbfPLJBKWkU/hA==)', 'clientSecret': 'ENC(AAAADLBZMqQnYTb7wQmW4ghcuB5KF0ZYzte/T0atslRqNHcsMYtFbv52Lv4OQQ==)', 'tenantId': 'ENC(AAAADCdXyebPUb7kYsKy4lvPy6QSQf3OnkzPnPlUZVSZkdU8c0WPBs5kO1AhpawrSg==)', 'azureEnvironment': "Azure", 'type': 'AzureServicePrincipal']
azureSecretString=['id': 'secret-id', 'description': 'secret-description', 'servicePrincipalId': 'azure-sp-id', 'secretIdentifier': 'ENC(AAAADDKoWcVCrE1bCld3s48MECqA8nQITPw6Go3kP+nVWqx5gb07iy4LwD4X+jhW)', 'type': 'SecretStringCredentials']
azureStorageAccount=['id':'az-storage-creds-id', 'description':'az storage credentials', 'storageAccountName': 'testsa', 'storageKey':'ENC(AAAADMcRT6s4SNoNvUDCmfpiO9CI7TMpUrBIAoxs/u9cxh18xO61CECSIwfc5g==)', 'endpointUrl':'https://testsa.blob.core.windows.net', 'type':'AzureStorageAccount']
}Tested Plugin Versions: azure-credentials-1.6.0.hpi, hashicorp-vault-plugin-2.1.0.hpi, hashicorp-vault-credentials-plugin-0.0.9.hpi, credentials-binding-1.16.hpi, credentials-2.1.16.hpi, workflow-api-2.27.hpi, workflow-step-api-2.14.hpi, structs-1.14.hpi, plain-credentials-1.4.hpi, ssh-credentials-1.13.hpi, sauce-ondemand-1.164.hpi, maven-plugin-3.1.2.hpi, matrix-project-1.12.hpi, workflow-basic-steps-2.5.hpi, run-condition-1.0.hpi, workflow-cps-2.53.hpi, junit-1.23.hpi, workflow-job-2.21.hpi, script-security-1.44.hpi, javadoc-1.1.hpi, token-macro-2.3.hpi, workflow-scm-step-2.6.hpi, workflow-support-2.17.hpi, ace-editor-1.0.1.hpi, jquery-detached-1.2.1.hpi, scm-api-2.2.6.hpi, gitlab-plugin-1.4.8.hpi, git-3.7.0.hpi, git-client-2.7.0.hpi, cloudbees-folder-6.4.hpi, apache-httpcomponents-client-4-api-4.5.3-2.1.hpi, jsch-0.1.54.1.hpi, display-url-api-2.2.0.hpi, mailer-1.20.hpi, windows-azure-storage-0.3.9.hpi, azure-commons-0.2.6.hpi, copyartifact-1.40.hpi, blueocean-rest-1.5.0.hpi, blueocean-commons-1.5.0.hpi
CustomTool
tools {
custom = [[name: "cf", url: "http://someserver.com/binaries/cf-cli/cf-cli_6.23.1_linux_x86-64.tgz", subdir: ""]]
}Tested Plugin Versions: custom-tools-plugin-0.4.4.hpi, extended-choice-parameter-0.28.hpi
Env
env {
variables{
url='http://www.bbc.co.uk'
}
}Tested Plugin Versions: NA
Executors
executors {
active = 3
}Tested Plugin Versions: NA
Files
files {
vaultUrl='http://localhost:51234' // default vaultUrl for any values with source 'HashicorpVault'
vaultToken='f119a093-c4b1-4422-1c8c-47688d14fe9e' // default vaultToken for any values with source 'HashicorpVault'
privateKey=[
path: '${jenkinsHome}/.ssh/id_rsa',
mode:'600',
// This private key is not in the project. If you need to re-encrypt, you need to generate a new key
contents:'''ENC(AAAADA97iygXfher9FBaFsAhlyl2SczDJi6DH5B9P4aMF8M77u/7tk0MKw3jdNm6ud9WbmjQhxdLfGDGRYCHA4YS+VXLTICMDB+3gPcMiCun1svE1VAlq5bVpVu1Tn8YIL6tUV0lX7VAB9WzarwCPJdErEPirERWl9x9tQKJ+kBRSY2MZtRk+EU3eMUdKSRpCJ/6ldcD3nt1XOgjDAPbWStA5Gq+7fvfTAoYobss/pXdTU8GdGf0DLGBfuGXzzyrciSjkGrBpTyK9Suv77in6Bc4Vzgfa9NG2UM855p+X5FxjouK7Hpkl35oG6mwOFiB1BsgFtF6DRYyP5+IorFMC4aZtCZJDeX2Li/bJsxb52jvSWKsYVSEPO4SRGl/xvlTIw7pApmE5Mtcm2Xs0AwpgSE2JUoBf9+GUYjdT6kqHtYA9nURD8JSOFN/vCLLLg5rdcgoRQwfPtpUEbz8IQZH0F3YhgsmtYfPjtZ+/IcSZEXV5cxbyzRGgWwj3aSFbnSAXNnD1DMl2YJGQrJRkN5AckhqeusX/QxZd8PdYZx1YV86ymDC+Vtdy7kV3ktjs/MqnwGu1CaGOLupCukA0hurQrf11IEG5tYH2MgwgUij1bTocIXfwu4tHR/u0howxiilXuxtXh7ajbDurFhi5jjLpAM9X0iNfX06mXkqF5nCHT5uYo+yg2EhCuhIUkHDpg6i2Wh/bP7ebaU2v9LEmAML7iIlB9NAVRRXDQZGezd3W8U9S5pPf5p9O3uU39hTcC9QDOyE0nxFxg+EZT3ya3MS3rpSZ6KHW6LxJTRbNXEVgI2EHBJqPL1GPgqEklT2XsYE+n63N/t+UvPLEIcapGHBH1LG2ZDHz9dI9QO/GtGamGh+6dj4QIfz4ecrIvxkQagE9FxHxaQwpIFofGsdVQ5FJrzv2AnCxnGg9RaVOYFn0ovXyxZLNKy11Y6WEmHn95fB+Nb7jNeIdndHOAxo7ymlNvktPK5wBwpXNxsoZLPuL89QqtMa/cJMdkJPUcLJxmiRMykNN3CMHH6yi1cVzcoGj1tw2Yn7q3H25KvkNS9M79x5H9qf9aRWHMnsE5P9NwUIFr+rZsGN1xBrkBtpwkf1bD5fDM5R8HmmnOFsc+qgc7Rj/HFHIMMF3MoVhM1mJYa1F+eP7ZiU1QNSDcWFjO/AEHsefQm0sazkhBbm/yyCdnBsMobbOLoJEOIAxvhbCP8zPFYFPHplFqOBb684dUC42CykEJyX4ozkyS2+Z77a61pxxn/rUR3rxQpx0tyA2Pdqdj41dlVfnKVthUF9x4pZ+us/jZjw7LPi6hDozEHGela9gRsuooQO3rfgxNSFkf7dYSzVrpY7RMZ/StwwXMxpVe7Vu1tdTa1dcWRC60UzPXgcib83OV8AFDrRmk/7EFXzsXUrCvhtldGWzFlTnocgI/kW0QdxZ+T2YkzJ3VizWPTNJmdBGBiezCZBvC7LfUpBcMz+w+8hlgvk1/gceSHJnPbr5jZHxkpGdzC3UHPNEhFSgOSGhu/hwOxUYDe5orJtMS5ggXr1Ai0QKZcQoYvaXXVm/wtJxWLXTDHymPfXmMaoJJz1gGEnCsMinfMKxe+ntqMRC2R4jmXk56M5rtKtqzsSAUF48RtOiW/2gWOyVyoqeQxjyGS5mt4dxM4Cwt8dRg94Lp4rqxVIHBRWuszxVIyIslBFmBP+1sdKzB2eXNMmjiVLPOHgBBm13ZjUHFw9+h8TJH95FafnOK5A4g4/Sa9bHNwJO+vDDSks6V5G61ocAtswKITUtoFvK+HlRGgtbNky/ab4ofpFnpllVd+lvFEq60gUc5FWt0qWNBpqA0XC2qLxQw+GVKRO9J3GpUh0QD+zJRG6+f5+duggXMdAQwV3RhNzej91sYRDDiybwFsrye257ilxH+Ie+6MB43itOrZ5r/uc8epQmMYjAaUH9l92CJNzRmM2+TYV/Gom5zNB0Hso10jrcCiGMaAun5VmM4SaJlTaxsyDLJaJ25u6zNKiP0PSBv9z6aiSyWCWTV4KMP0kMSSsxs0dneX4Q3GHEGu5prLrY8cbm/KBmvt9Rkmk72L30hK/cmmJXOeoTNZF9BZO3Fyw7xwJCbzgtFdM05B3fg9vVYlTwUXnagagQUiyQozWqBKbhRiVzG451pcQMELWghIx/kM4aKYPmaLeVJuWaUATP/KyXC0Ab0Mr3GgjOGTYlRRITQhoH0MrYOtjB1PGmC9kmJ5Ijyx6rDqOeUO1vrOuGVGd0P2yoP5LCQNwHoS4U9ekYbhI)'''
]
settingsXml=[
path: 'settings.xml',
mode:'600',
contents:'''
<?xml version="1.0" encoding="UTF-8"?>
<settings>
<profiles>
<profile>
<id>myprofile</id>
<properties>
<sonar.host.url>
http://localhost:9000
</sonar.host.url>
</properties>
<repositories>
<repository>
<name>Jenkins</name>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</repository>
<repository>
<name>Spring Snapshots</name>
<id>spring-snapshots</id>
<url>http://repo.spring.io/snapshot</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<name>Spring Milestones</name>
<id>spring-milestones</id>
<url>http://repo.spring.io/milestone</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>spring-snapshots</id>
<url>http://repo.spring.io/snapshot</url>
</pluginRepository>
<pluginRepository>
<id>spring-milestones</id>
<url>http://repo.spring.io/milestone</url>
</pluginRepository>
<pluginRepository>
<name>Jenkins</name>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<activeProfiles>
<activeProfile>myprofile</activeProfile>
</activeProfiles>
</settings>
'''
]
empty=[
path: 'empty.txt',
mode:'777',
contents:''
]
id_rsa_vault=[
path:'${jenkinsHome}/.ssh/id_rsa_vault',
mode:'600',
source: 'HashicorpVault',
key: 'secret/id_rsa',
url:'http://localhost:51235',
token: 'f119a093-c4b1-4422-1c8c-47688d14fe9e',
contentKey: "contents", // defaults to 'contents'
base64Encoded: true // defaults to false
]
passcode_from_default_vault_config=[
path:'${jenkinsHome}/.ssh/passcode',
mode:'600',
source: 'HashicorpVault',
key: 'secret/passcode',
]
password_not_encoded=[
path:'${jenkinsHome}/.ssh/password',
mode:'600',
source: 'HashicorpVault',
key: 'secret/password',
url:'http://localhost:51235',
token: 'f119a093-c4b1-4422-1c8c-47688d14fe9e',
contentKey: "password",
base64Encoded: false
]
}Tested Plugin Versions: NA
Gerrit
tools {
gerrit =
[
[
name: 'Fake Gerrit',
gerritHostName: 'gerrit.sandbox.local',
gerritFrontEndUrl: 'http://gerrit.sandbox/',
gerritSshPort: 29418,
gerritUserName: 'jenkins',
gerritEMail: '[email protected]',
gerritAuthKeyFile: '${jenkinsHome}/gerrit_rsa',
gerritAuthKeyFilePassword: 'password',
gerritBuildStartedVerifiedValue: 0,
gerritBuildStartedCodeReviewValue: 0,
gerritBuildSuccessfulVerifiedValue: 1,
gerritBuildSuccessfulCodeReviewValue: 0,
gerritBuildFailedVerifiedValue: -1,
gerritBuildFailedCodeReviewValue: 0,
gerritBuildUnstableVerifiedValue: -1,
gerritBuildUnstableCodeReviewValue: 0,
gerritBuildNotBuiltVerifiedValue: 0,
gerritBuildNotBuiltCodeReviewValue: 0,
enableManualTrigger: true,
enablePluginMessages: true,
buildScheduleDelay: 3,
dynamicConfigRefreshInterval: 30,
enableProjectAutoCompletion: true,
projectListFetchDelay: 0,
projectListRefreshInterval: 3600,
watchdogTimeoutMinutes: 1,
verdictCategories: [
[ 'verdictValue':'CRVW', 'verdictDescription':'Code Review'],
[ 'verdictValue':'VRIF', 'verdictDescription':'Verified']
] as LinkedList,
buildCurrentPatchesOnly: [
enabled: true,
abortNewPatchsets: false,
abortManualPatchsets: false
]
]
]
}Tested Plugin Versions: gerrit-trigger-2.27.5.hpi, structs-1.14.hpi
GitHub
credentials {
github=['username': 'jenkins', 'password': 'ENC(AAAADBCsrisG4HKN89K4oEKwHbHlA2wKZqR1n275eeadIXrVUTctvseX/jb9V6qv2w==)', 'description': 'GitHub Credentials']
mycompany=['username': 'jenkins', 'password': 'ENC(AAAADBCsrisG4HKN89K4oEKwHbHlA2wKZqR1n275eeadIXrVUTctvseX/jb9V6qv2w==)', 'description': 'MyCompany GitHub Credentials']
acme=['username': 'jenkins', 'password': 'ENC(AAAADBCsrisG4HKN89K4oEKwHbHlA2wKZqR1n275eeadIXrVUTctvseX/jb9V6qv2w==)', 'description': 'Acme GitHub Credentials']
}
github {
githubEnterpriseEndpoints=[
['name': 'MyCompany','url': 'https://api.github.mycompany.com'],
['name': 'Acme','url': 'https://api.github.acme.com']
]
organisations=[
[
name:"mycompany",
displayName:"MyCompany",
description:"MyCompany Github Enterprise Organisation",
project:[
apiEndpoint:"MyCompany",
owner:"mycompany",
credentialsId:"mycompany",
repositoryNamePattern:"*"
],
// explicit script path. If left out, 'Jenkinsfile' will be the default
jenkinsfiles: ['Jenkinsfile.prod', 'Jenkinsfile.test']
],
[
name:"acme",
displayName:"Acme",
description:"Acme Github Enterprise Organisation",
project:[
apiEndpoint:"Acme",
owner:"acme",
credentialsId:"acme",
repositoryNamePattern:"*"
],
// explicit script path. If left out, 'Jenkinsfile' will be the default
jenkinsfiles: ['Jenkinsfile.acme']
],
[
// Github.com
name:"buildit-name",
displayName:"Buildit Display Name",
description:"Buildit Github Organisation Description",
project:[
apiEndpoint:"GitHub", // default endpoint present in Jenkins for github.com
owner:"buildit-owner",
credentialsId:"github",
repositoryNamePattern:"*"
]
]
]
}Tested Plugin Versions: github-branch-source-2.3.4.hpi, github-1.28.1.hpi, credentials-2.1.16.hpi, display-url-api-2.2.0.hpi, git-3.7.0.hpi, github-api-1.90.hpi, scm-api-2.2.6.hpi, structs-1.14.hpi, git-client-2.7.0.hpi, mailer-1.20.hpi, matrix-project-1.12.hpi, ssh-credentials-1.13.hpi, apache-httpcomponents-client-4-api-4.5.3-2.1.hpi, jsch-0.1.54.1.hpi, junit-1.23.hpi, script-security-1.44.hpi, workflow-api-2.27.hpi, workflow-step-api-2.14.hpi, workflow-scm-step-2.6.hpi, jackson2-api-2.8.10.1.hpi, plain-credentials-1.4.hpi, token-macro-2.3.hpi, workflow-job-2.21.hpi, workflow-support-2.17.hpi, branch-api-2.0.19.hpi, cloudbees-folder-6.4.hpi, workflow-multibranch-2.19.hpi, workflow-multibranch-2.19.hpi, workflow-cps-2.53.hpi, ace-editor-1.0.1.hpi, jquery-detached-1.2.1.hpi
Gitlab
gitlab=[
gitlab: [
url:"http://gitlab.platform.com/",
apiTokenId:"gitlabCredentials",
ignoreCertificateErrors:false,
connectionTimeout:15,
readTimeout:15
],
gitlabUsingDefaults: [
url:"http://gitlab.platform.com/",
apiTokenId:"gitlabCredentials"
]
]
credentials {
gitlabCredentials = ['description': 'Gitlab credentials', 'token': 'ENC(AAAADBCsrisG4HKN89K4oEKwHbHlA2wKZqR1n275eeadIXrVUTctvseX/jb9V6qv2w==)', 'type': 'GitLabApiToken']
}Tested Plugin Versions: gitlab-plugin-1.4.8.hpi, credentials-2.1.16.hpi, plain-credentials-1.4.hpi, git-3.7.0.hpi, git-client-2.7.0.hpi, matrix-project-1.12.hpi, workflow-step-api-2.14.hpi, ssh-credentials-1.13.hpi, junit-1.23.hpi, script-security-1.44.hpi, mailer-1.20.hpi, scm-api-2.2.6.hpi, workflow-scm-step-2.6.hpi, structs-1.14.hpi, apache-httpcomponents-client-4-api-4.5.3-2.1.hpi, jsch-0.1.54.1.hpi, display-url-api-2.2.0.hpi, workflow-api-2.27.hpi
Gradle
tools {
gradle =
[
[name: "gradle-2", url: "https://services.gradle.org/distributions/gradle-2.14-bin.zip"],
[name: "gradle-3", url: "https://services.gradle.org/distributions/gradle-3.0-bin.zip"],
[name: "gradle-2-1", version: "2.1"]
]
}Tested Plugin Versions: gradle-1.25.hpi
HashicorpVault
hashicorpvault{
url= 'http://vault.server.url'
credentialsId= 'vault'
}
credentials {
vault=['token':'somesortoftoken', 'description':'vault credentials', type:"HashicorpVaultTokenCredential"]
}Tested Plugin Versions: hashicorp-vault-plugin-2.1.0.hpi, workflow-scm-step-2.6.hpi, cloudbees-folder-6.4.hpi, credentials-2.1.16.hpi, workflow-step-api-2.14.hpi, structs-1.14.hpi, ssh-credentials-1.13.hpi
HipChat
hipchat {
server = "hipchat.com"
v2Enabled = true
room = "Default Room"
sendAs = "Jenkins"
credentialsId = "hipchatToken"
}
credentials {
hipchatToken=['description': 'HipChat Token', 'token': 'helloworld', 'type': 'StringCredential']
}Tested Plugin Versions: hipchat-2.1.1.hpi, workflow-step-api-2.14.hpi, credentials-2.1.16.hpi, display-url-api-2.2.0.hpi, junit-1.23.hpi, matrix-project-1.12.hpi, plain-credentials-1.4.hpi, token-macro-2.3.hpi, structs-1.14.hpi, script-security-1.44.hpi, ssh-credentials-1.13.hpi, workflow-job-2.21.hpi, workflow-api-2.27.hpi, scm-api-2.2.6.hpi, workflow-support-2.17.hpi
Java
tools {
java =
[
[name: "jdk8", url: "http://localhost/jdk-8u102-oth-JPR"],
[name: "jdk7", url: "http://localhost/jdk-7u80-oth-JPR"]
]
}Tested Plugin Versions: NA
JenkinsHost
jenkins {
host {
url = 'http://example.com/jenkins'
adminEmail = '[email protected]'
}
}Tested Plugin Versions: NA
Jira
jira {
sites {
foo {
url = "https://jira.foo.com/"
alternativeUrl = "https://jira.foo.com/"
userName = "admin"
password = "secret"
supportsWikiStyleComment = false
recordScmChanges = false
updateJiraIssueForAllStatus = false
userPattern = null
useHTTPAuth = false
groupVisibility = null
roleVisibility = null
}
bar {
url = "http://jira.bar.com"
alternativeUrl = "http://jira.bar.com"
userName = "user"
password = "p@ss"
supportsWikiStyleComment = true
recordScmChanges = true
updateJiraIssueForAllStatus = true
userPattern = "5"
useHTTPAuth = true
groupVisibility = "6"
roleVisibility = "7"
}
}
}Tested Plugin Versions: jira-2.2.1.hpi, matrix-project-1.12.hpi, mailer-1.20.hpi, junit-1.23.hpi, script-security-1.44.hpi, structs-1.14.hpi, workflow-step-api-2.14.hpi, workflow-api-2.27.hpi, junit-1.23.hpi, scm-api-2.2.6.hpi, display-url-api-2.2.0.hpi, mailer-1.20.hpi
JobDSL
jobdsl {
scriptSecurityEnabled = false // scriptSecurityEnabled defaults to false
jobdsl=[url:"https://github.com/buildit/sample-pipelines", targets:"jobs/**/*.groovy", branch:"*/master", additionalClasspath:"src/main/groovy"]
//jobdslWithLabel=[url:"https://github.com/buildit/sample-pipelines", targets:"jobs/**/*.groovy", branch:"*/master", label:"foo"]
jobdslWithCredentials=[url:"https://github.com/buildit/sample-pipelines", targets:"jobs/**/*.groovy", branch:"*/master", credentialsId:"git"]
}
credentials {
git=['username':'test', 'password':'p@ssword', 'description':'git credentials']
}Tested Plugin Versions: ace-editor-1.0.1.hpi, jquery-detached-1.2.1.hpi, workflow-cps-global-lib-2.5.hpi, workflow-cps-2.53.hpi, workflow-scm-step-2.6.hpi, cloudbees-folder-6.4.hpi, git-client-2.7.0.hpi, git-server-1.7.hpi, scm-api-2.2.6.hpi, structs-1.14.hpi, ssh-credentials-1.13.hpi, credentials-2.1.16.hpi, workflow-step-api-2.14.hpi, workflow-api-2.27.hpi, workflow-support-2.17.hpi, ace-editor-1.0.1.hpi, script-security-1.44.hpi, git-3.7.0.hpi, matrix-project-1.12.hpi, mailer-1.20.hpi, junit-1.23.hpi, job-dsl-1.64.hpi, credentials-binding-1.16.hpi, credentials-2.1.16.hpi, plain-credentials-1.4.hpi, apache-httpcomponents-client-4-api-4.5.3-2.1.hpi, jsch-0.1.54.1.hpi, display-url-api-2.2.0.hpi, git-client-2.7.0.hpi
Kubernetes
clouds {
kubernetes {
sandbox {
[
cloudName = "My Cloud",
serverUrl = 'https://rancher.com/r/projects/1a120948/kubernetes:6443',
namespace = 'default',
jenkinsUrl = 'http://jenkins-k8s.platform.com/',
serverCertificate = 'QmFzaWMgT0VFMk1UWkZSRVZHTlVKQk9UUkROVGM0TjBNNldtZFRjRlZ5TkVRM19HOXFRMVkzWkVWQldHbzVOMU5YZEdoRk5GcEJaVTVSWWpGS1lsVkJUQT08',
skipTlsVerify = true,
credentialsId = 'credentialsId',
jenkinsTunnel = 'jenkinsTunnel',
containerCapStr = '100',
connectTimeout = 300,
readTimeout = 300,
retentionTimeout = 300,
podTemplates = [
[
inheritFrom: 'base',
name: 'myPod',
namespace: 'default',
image : 'ci-base',
command : 'cat',
args : '',
remoteFs : '',
label : '',
serviceAccount : '',
nodeSelector : '',
resourceRequestCpu : '',
resourceRequestMemory : '',
resourceLimitCpu : '',
resourceLimitMemory : '',
privileged : true,
alwaysPullImage : false,
instanceCap : Integer.MAX_VALUE,
slaveConnectTimeout : 100,
idleMinutes : 1,
customWorkspaceVolumeEnabled : false,
envVars : [
[type: "SecretEnvVar", key:'', secretName:'', secretKey:''],
[type: "KeyValueEnvVar", key:'', value:'']
],
workspaceVolume : [type: "PersistentVolumeClaimWorkspaceVolume", claimName:'', readOnly: true],
podVolumes : [
[type: "ConfigMapVolume", mountPath:'', configMapName:''],
[type: "EmptyDirVolume", mountPath:'', memory: true],
[type: "HostPathVolume", hostPath:'', mountPath:''],
[type: "NfsVolume", serverAddress:'', serverPath:'', readOnly: true, mountPath:''],
[type: "PersistentVolumeClaim", mountPath:'', claimName:'', readOnly: true],
[type: "SecretVolume", mountPath:'', configMapName:'']
],
nodeUsageMode : [type: "NORMAL" /* type: "EXCLUSIVE" */],
annotations : [
[key:'', value:''],
],
imagePullSecrets : [
[name:''],
],
containerTemplates :
[
[
inheritFrom: '',
name: '',
namespace: '',
image : 'imageName',
command : '',
args : '',
remoteFs : '',
label : '',
serviceAccount : '',
nodeSelector : '',
resourceRequestCpu : '',
resourceRequestMemory : '',
resourceLimitCpu : '',
resourceLimitMemory : '',
privileged : false,
alwaysPullImage : false,
instanceCap : Integer.MAX_VALUE,
slaveConnectTimeout : 100,
idleMinutes : 1,
customWorkspaceVolumeEnabled : false,
envVars : [
[type: "SecretEnvVar", key:'', secretName:'', secretKey:''],
[type: "SecretEnvVar", key:'', secretName:'', secretKey:'']
],
ports : [
[name:'', containerPort:8000, hostPort:8000],
],
livenessProbe : [execArgs: "", timeoutSeconds: 1, initialDelaySeconds: 1, failureThreshold: 1, periodSeconds: 1, successThreshold: 1],
]
]
]
]
]
}
}
}
/*
Minimum config as follows
clouds {
kubernetes {
sandbox {
[
cloudName = "My Cloud",
serverUrl = 'https://rancher.com/r/projects/1a120948/kubernetes:6443',
namespace = 'default',
jenkinsUrl = 'http://jenkins-k8s.platform.com/',
serverCertificate = 'QmFzaWMgT0VFMk1UWkZSRVZHTlVKQk9UUkROVGM0TjBNNldtZFRjRlZ5TkVRM19HOXFRMVkzWkVWQldHbzVOMU5YZEdoRk5GcEJaVTVSWWpGS1lsVkJUQT08',
skipTlsVerify = true,
credentialsId = 'credentialsId',
jenkinsTunnel = 'jenkinsTunnel',
containerCapStr = '100',
connectTimeout = 300,
readTimeout = 300,
retentionTimeout = 300
]
}
}
}
*/Tested Plugin Versions: kubernetes-1.5.2.hpi, workflow-step-api-2.14.hpi, credentials-2.1.16.hpi, durable-task-1.16.hpi, variant-1.1.hpi, structs-1.14.hpi, kubernetes-credentials-0.3.0.hpi, plain-credentials-1.4.hpi
LdapAuthN
auth {
ldap {
server = "someserver.com" // no default value
rootDN = 'dc=com' // no default value
bindDN = "uid=binduser,cn=sysaccounts,cn=etc,dc=mavel,dc=com" // no default value
bindPass = "12345678910" // no default value
userSearchBase = 'cn=users,cn=accounts' // defaults to this value if missing
userSearch = 'uid={0}' // defaults to this value if missing
groupSearchBase = 'cn=groups,cn=accounts' // defaults to this value if missing
groupSearchFilter = '' // defaults to this value if missing
groupMembershipFilter = 'memberOf' // defaults to this value if missing
inhibitInferRootDN = false // defaults to this value if missing
disableMailAddressResolver = false // defaults to this value if missing
displayNameAttributeName = 'displayname' // defaults to this value if missing
mailAddressAttributeName = 'mail' // defaults to this value if missing
}
}Tested Plugin Versions: ldap-1.15.hpi, mailer-1.20.hpi, display-url-api-2.2.0.hpi, matrix-auth-1.4.hpi, icon-shim-2.0.3.hpi
LdapAuthZ
auth {
ldap {
adminGroup = "my-jenkins-administrators"
adminRoles = ["hudson.model.Hudson.Administer"] // remove if you want defaults below
developerGroup = "my-jenkins-developers"
developerRoles = ["hudson.model.Computer.Disconnect"] // remove if you want defaults below
viewersGroup = "my-jenkins-viewers"
viewerRoles = ["hudson.model.Computer.Build"] // remove if you want defaults below
webhookGroup = "my-jenkins-webhook"
webhookRoles = ["hudson.model.Item.Build"] // remove if you want defaults below
anonymousRoles = ["hudson.model.View.Read"]
}
}
/**
Defaults are as follows
def administrators = [
name: "jenkins-administrators",
roles: [
"hudson.model.Computer.Build",
"hudson.model.Computer.Configure",
"hudson.model.Computer.Connect",
"hudson.model.Computer.Create",
"hudson.model.Computer.Delete",
"hudson.model.Computer.Disconnect",
"hudson.model.Computer.Provision",
"com.cloudbees.plugins.credentials.CredentialsProvider.Create",
"com.cloudbees.plugins.credentials.CredentialsProvider.Delete",
"com.cloudbees.plugins.credentials.CredentialsProvider.ManageDomains",
"com.cloudbees.plugins.credentials.CredentialsProvider.Update",
"com.cloudbees.plugins.credentials.CredentialsProvider.View",
"hudson.model.Hudson.Administer",
"hudson.model.Hudson.ConfigureUpdateCenter",
"hudson.model.Hudson.Read",
"hudson.model.Hudson.RunScripts",
"hudson.model.Hudson.UploadPlugins",
"hudson.model.Item.Build",
"hudson.model.Item.Cancel",
"hudson.model.Item.Configure",
"hudson.model.Item.Create",
"hudson.model.Item.Delete",
"hudson.model.Item.Discover",
"hudson.model.Item.Move",
"hudson.model.Item.Read",
"hudson.model.Item.Workspace",
"hudson.model.Run.Delete",
"hudson.model.Run.Replay",
"hudson.model.Run.Update",
"hudson.model.View.Configure",
"hudson.model.View.Create",
"hudson.model.View.Delete",
"hudson.model.View.Read",
"hudson.scm.SCM.Tag",
"hudson.security.HealthCheck",
"hudson.security.ThreadDump",
"hudson.security.View"
]
]
def developers = [
name: "jenkins-developers",
roles: [
"hudson.model.Computer.Build",
"hudson.model.Computer.Configure",
"hudson.model.Computer.Connect",
"hudson.model.Computer.Create",
"hudson.model.Computer.Delete",
"hudson.model.Computer.Disconnect",
"hudson.model.Computer.Provision",
"com.cloudbees.plugins.credentials.CredentialsProvider.Create",
"com.cloudbees.plugins.credentials.CredentialsProvider.Delete",
"com.cloudbees.plugins.credentials.CredentialsProvider.ManageDomains",
"com.cloudbees.plugins.credentials.CredentialsProvider.Update",
"com.cloudbees.plugins.credentials.CredentialsProvider.View",
"hudson.model.Hudson.Read",
"hudson.model.Item.Build",
"hudson.model.Item.Cancel",
"hudson.model.Item.Configure",
"hudson.model.Item.Create",
"hudson.model.Item.Delete",
"hudson.model.Item.Discover",
"hudson.model.Item.Move",
"hudson.model.Item.Read",
"hudson.model.Item.Workspace",
"hudson.model.Run.Delete",
"hudson.model.Run.Replay",
"hudson.model.Run.Update",
"hudson.model.View.Configure",
"hudson.model.View.Create",
"hudson.model.View.Delete",
"hudson.model.View.Read",
"hudson.scm.SCM.Tag",
"hudson.security.HealthCheck",
"hudson.security.ThreadDump",
"hudson.security.View"
]
]
def viewers = [
name: "jenkins-viewer",
roles: [
"hudson.model.Hudson.Read",
"hudson.model.Item.Read",
"hudson.model.View.Configure",
"hudson.model.View.Create",
"hudson.model.View.Delete",
"hudson.model.View.Read",
"hudson.security.HealthCheck",
"hudson.security.View"
]
]
def anonymous = [
name: "anonymous",
roles: []
]
def webhook = [
name: "jenkins-webhook",
roles: [
"hudson.model.Item.Build"
]
]
**/Tested Plugin Versions: ldap-1.15.hpi, mailer-1.20.hpi, display-url-api-2.2.0.hpi, icon-shim-2.0.3.hpi, matrix-auth-1.4.hpi
Libraries
libraries = [
foo : [
defaultVersion : 'master',
implicit : true,
allowVersionOverride : false,
scm : [
url : 'https://git.example.com/foo.git',
credentialsId : "git"
]
],
bar : [
defaultVersion : 'master',
implicit : false,
allowVersionOverride : true,
scm : [
url : 'https://git.example.com/bar.git'
]
],
baz : [
defaultVersion : 'master',
implicit : false,
allowVersionOverride : true,
scm : [
url : 'https://git.example.com/baz.git',
branch : 'baz_test'
]
]
]
credentials {
git=['username':'test', 'password':'p@ssword', 'description':'git credentials']
}Tested Plugin Versions: ace-editor-1.0.1.hpi, jquery-detached-1.2.1.hpi, workflow-cps-global-lib-2.5.hpi, workflow-cps-2.53.hpi, workflow-scm-step-2.6.hpi, cloudbees-folder-6.4.hpi, git-client-2.7.0.hpi, git-server-1.7.hpi, scm-api-2.2.6.hpi, structs-1.14.hpi, ssh-credentials-1.13.hpi, credentials-2.1.16.hpi, workflow-step-api-2.14.hpi, workflow-api-2.27.hpi, workflow-support-2.17.hpi, ace-editor-1.0.1.hpi, script-security-1.44.hpi, git-3.7.0.hpi, matrix-project-1.12.hpi, mailer-1.20.hpi, junit-1.23.hpi, apache-httpcomponents-client-4-api-4.5.3-2.1.hpi, jsch-0.1.54.1.hpi, display-url-api-2.2.0.hpi, mailer-1.20.hpi
Logstash
#!/usr/bin/env groovy
logstash {
type = 'SYSLOG'
host = '10.113.140.169'
port = 5122
key = 'logstash'
}Tested Plugin Versions: logstash-1.3.0.hpi, mask-passwords-2.10.1.hpi, structs-1.14.hpi, junit-1.23.hpi, script-security-1.44.hpi, workflow-step-api-2.14.hpi, workflow-api-2.27.hpi, scm-api-2.2.6.hpi
MailExt
mail {
host = "159.34.192.34"
defaultSuffix = "@somewhere.com"
}Tested Plugin Versions: email-ext-2.58.hpi, mailer-1.20.hpi, matrix-project-1.12.hpi, script-security-1.44.hpi, token-macro-2.3.hpi, junit-1.23.hpi, script-security-1.44.hpi, workflow-step-api-2.14.hpi, workflow-api-2.27.hpi, scm-api-2.2.6.hpi, structs-1.14.hpi, display-url-api-2.2.0.hpi, workflow-job-2.21.hpi, workflow-support-2.17.hpi
mail {
host = "159.34.192.34"
defaultSuffix = "@somewhere.com"
}Tested Plugin Versions: mailer-1.20.hpi, display-url-api-2.2.0.hpi
Master
nodes {
master {
labels = ['label1', 'label2']
}
}Tested Plugin Versions: NA
Maven
tools {
maven =
[
[name: "maven-3.3.3", version: "3.3.3", url: "http://test_url"], [name: "maven-3.3.9", version: "3.3.9"]
]
}Tested Plugin Versions: NA
Mesos
clouds {
mesos {
sandbox {
[
cloudName = "My Cloud",
nativeLibraryPath = "/usr/lib/libmesos.so",
master = "10.113.140.187:5050",
description = "",
frameworkName = "jenkins",
role = "*",
slavesUser = "jenkins",
credentialsId = "",
principal = "jenkins",
secret = "",
checkpoint = false,
onDemandRegistration = true,
jenkinsURL = "http://mesos3.platform.com/",
declineOfferDuration = "600000",
cloudID = "",
slaves = [
[
labelString : "label",
slaveCpus : "0.2",
slaveMem : "1024",
minExecutors : "3",
maxExecutors : "5",
executorCpus : "0.1",
executorMem : "128",
remoteFSRoot : "jenkins",
idleTerminationMinutes: "3",
slaveAttributes : "",
containerInfo : [
dockerImage : "",
dockerPrivilegedMode : false,
dockerForcePullImage : false,
dockerImageCustomizable : false,
useCustomDockerCommandShell: false,
customDockerCommandShell : "",
networking : "BRIDGE"
],
uris : [
[uri: "", executable: true, extract: true]
],
volumes : [
[containerPath: "", hostPath: "", readOnly: true]
],
ports : [
[containerPort: 8080, hostPort: 8080, protocol: ""]
],
networks : [
[name: "test"]
],
params : [key: "value", another: "value"]
]
]
]
}
}
}Tested Plugin Versions: mesos-0.14.1.hpi, credentials-2.1.16.hpi, metrics-3.1.2.10.hpi, jackson2-api-2.8.10.1.hpi, structs-1.14.hpi
MultiCloud
clouds {
kubernetes {
sandbox {
[
cloudName = "My Cloud",
serverUrl = 'https://rancher.com/r/projects/1a120948/kubernetes:6443',
namespace = 'default',
jenkinsUrl = 'http://jenkins-k8s.platform.com/',
serverCertificate = 'QmFzaWMgT0VFMk1UWkZSRVZHTlVKQk9UUkROVGM0TjBNNldtZFRjRlZ5TkVRM19HOXFRMVkzWkVWQldHbzVOMU5YZEdoRk5GcEJaVTVSWWpGS1lsVkJUQT08',
skipTlsVerify = true,
credentialsId = 'credentialsId',
jenkinsTunnel = 'jenkinsTunnel',
containerCapStr = '100',
connectTimeout = 300,
readTimeout = 300,
retentionTimeout = 300
]
}
}
mesos {
sandbox {
[
cloudName = "My Cloud",
nativeLibraryPath = "/usr/lib/libmesos.so",
master = "10.113.140.187:5050",
description = "",
frameworkName = "jenkins",
role = "*",
slavesUser = "jenkins",
credentialsId = "",
principal = "jenkins",
secret = "",
checkpoint = false,
onDemandRegistration = true,
jenkinsURL = "http://mesos3.platform.com/",
declineOfferDuration = "600000",
cloudID = "",
slaves = [
[
labelString : "label",
slaveCpus : "0.2",
slaveMem : "1024",
minExecutors : "3",
maxExecutors : "5",
executorCpus : "0.1",
executorMem : "128",
remoteFSRoot : "jenkins",
idleTerminationMinutes: "3",
slaveAttributes : "",
containerInfo : [
dockerImage : "",
dockerPrivilegedMode : false,
dockerForcePullImage : false,
dockerImageCustomizable : false,
useCustomDockerCommandShell: false,
customDockerCommandShell : "",
networking : "BRIDGE"
],
uris : [
[uri: "", executable: true, extract: true]
],
volumes : [
[containerPath: "", hostPath: "", readOnly: true]
],
ports : [
[containerPort: 8080, hostPort: 8080, protocol: ""]
],
networks : [
[name: "test"]
],
params : [key: "value", another: "value"]
]
]
]
}
}
}Tested Plugin Versions: mesos-0.14.1.hpi, credentials-2.1.16.hpi, metrics-3.1.2.10.hpi, jackson2-api-2.8.10.1.hpi, structs-1.14.hpi, kubernetes-1.5.2.hpi, workflow-step-api-2.14.hpi, credentials-2.1.16.hpi, durable-task-1.16.hpi, variant-1.1.hpi, kubernetes-credentials-0.3.0.hpi, plain-credentials-1.4.hpi
NodeJs
tools {
node =
[
[
name: "nodejs-4.2.3",
version: "4.2.3"
]
]
}Tested Plugin Versions: nodejs-0.2.1.hpi
Nodes
nodes {
slaves {
node01 = ['name': 'node 01', 'description': 'First node', remoteFS: '/tmp', numExecutors: '1', launchType: 'JNLP', jnlpTunnel: ':443', jnlpVmArgs: '-', env: ['android_home': '/android', 'java_home': '/java']]
node02 = ['name': 'node 02', 'description': 'Second node', remoteFS: '/var', mode: 'EXCLUSIVE']
node03 = ['name': 'node 03', 'description': 'Third node', remoteFS: '/var', mode: 'EXCLUSIVE', launchType: 'SSH', host: 'sshHost', port: 1234, credentialsId: 'sshCredentials', javaPath: 'sshJavaPath']
node04 = ['name': 'node 04', 'description': 'Fourth node', remoteFS: '/var', numExecutors: '15', launchType: 'SSH', host: 'sshHost', credentialsId: 'sshCredentials']
}
}Tested Plugin Versions: ssh-slaves-1.26.hpi, credentials-2.1.16.hpi, structs-1.14.hpi, ssh-credentials-1.13.hpi, jdk-tool-1.1.hpi
Passwords
env {
passwords {
repository='ENC(AAAADF6IulRzxGoLgc3QerNDHPRdARvB3eJ3y1nLPk2PhxNt4VdE6ibH)'
}
}Tested Plugin Versions: envinject-1.91.3.hpi, maven-plugin-3.1.2.hpi, mailer-1.20.hpi, javadoc-1.1.hpi, junit-1.23.hpi, display-url-api-2.2.0.hpi, workflow-step-api-2.14.hpi, script-security-1.44.hpi, structs-1.14.hpi, workflow-api-2.27.hpi, scm-api-2.2.6.hpi, apache-httpcomponents-client-4-api-4.5.3-2.1.hpi, jsch-0.1.54.1.hpi, ssh-credentials-1.13.hpi, credentials-2.1.16.hpi
Plugins
plugins=[
// default artifactPlugin = "http://updates.jenkins-ci.org/download/plugins/[module]/[revision]/[module].[ext]"
first: [
artifactPattern: 'http://localhost:4567/[module]-[revision].[ext]',
pluginArtifacts: ['ace-editor:1.0.1', 'maven-plugin:3.1.2']
],
second: [
artifactPattern: 'http://localhost:4567/[module]-[revision].[ext]',
pluginArtifacts: ['active-directory:2.0']
]
]Tested Plugin Versions: NA
Proxy
proxy {
host="proxy.sandbox.local"
port="3128"
userName="spiderman"
password="p3t3rPark3r"
noProxyHost="localhost,127.0.0.1"
}Tested Plugin Versions: NA
RoleStrategy
roleStrategy {
roles = [
[
'name': 'anonymous',
'permissions': [
'hudson.model.Item.Read',
'hudson.model.Item.Build'
]
],
[
'name': 'admin',
'permissions': [
'hudson.model.Item.Workspace',
'hudson.model.Run.Delete'
],
'members': [
'john.doe'
]
],
[
'name': 'developer',
'permissions': [
'hudson.model.Item.Configure'
],
'members': [
'david.doe'
]
]
] as LinkedList
}Tested Plugin Versions: matrix-auth-1.4.hpi, icon-shim-2.0.3.hpi, role-strategy-2.3.2.hpi
ScriptSecurity
scriptsecurity {
approvedSignatures=[
"field hudson.ProxyConfiguration name",
"field hudson.ProxyConfiguration port"
]
approvedScriptHashes=[
"35f0f8ad5c16ff2873f66efe9bf556aba0512bef"
]
}Tested Plugin Versions: script-security-1.44.hpi
Shell
tools {
shell = [path: '/bin/bash']
}Tested Plugin Versions: NA
SonarQube
tools {
sonar {
qube =
[
[
name : "SONAR",
serverUrl : "http://10.113.140.170:9000/sonar",
sonarLogin : "admin", //only required for v5.1-
sonarPassword : "ENC(AAAADF6IulRzxGoLgc3QerNDHPRdARvB3eJ3y1nLPk2PhxNt4VdE6ibH)", //only required for v5.1-
databaseUrl : "jdbc:mysql://10.113.140.170:3306/sonarqube?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance", //only required for v5.1-
databaseLogin : "sonarqube", //only required for v5.1-
databasePassword: "Y/a5t0YI5fmWqx1NEEYoKQ==" //only required for v5.1-
],
[
name : "SONAR6",
version : "5.3 or higher", //defaults to "5.1 or lower" so not necessary with above example
serverUrl : "http://10.113.140.170:9000/sonar",
serverAuthenticationToken: "someToken" //only required for v5.3+
]
]
}
}Tested Plugin Versions: sonar-2.6.1.hpi, maven-plugin-3.1.2.hpi, mailer-1.20.hpi, javadoc-1.1.hpi, junit-1.23.hpi, jquery-1.11.2-0.hpi, display-url-api-2.2.0.hpi, workflow-step-api-2.14.hpi, workflow-api-2.27.hpi, script-security-1.44.hpi, structs-1.14.hpi, scm-api-2.2.6.hpi, apache-httpcomponents-client-4-api-4.5.3-2.1.hpi, jsch-0.1.54.1.hpi, ssh-credentials-1.13.hpi, credentials-2.1.16.hpi
SonarRunner
tools {
sonar {
runner =
[
[name: "sonar", label: "master", url: "http://example.com/sonar.zip", subdir: "bin"],
[name: "sonar14", label: "slave", url: "http://example.com/sonar14.zip", subdir: "bin"]
]
}
}Tested Plugin Versions: sonar-2.6.1.hpi, maven-plugin-3.1.2.hpi, mailer-1.20.hpi, javadoc-1.1.hpi, junit-1.23.hpi, jquery-1.11.2-0.hpi, display-url-api-2.2.0.hpi, workflow-step-api-2.14.hpi, workflow-api-2.27.hpi, script-security-1.44.hpi, structs-1.14.hpi, scm-api-2.2.6.hpi, apache-httpcomponents-client-4-api-4.5.3-2.1.hpi, jsch-0.1.54.1.hpi, ssh-credentials-1.13.hpi, credentials-2.1.16.hpi
Splunk
splunk{
splunkHostUrl = 'http://splunk.server.url'
splunkHostPort = 8088
token = '666'
useSSL = true
jenkinsMasterHostname = 'jenkins.savings.com'
rawEventsEnabled = true
eventSource = 'jenkins'
splunkJenkinsAppUrl = 'http://splunk.savings.com/en-GB/app/splunk_app_jenkins/overview/'
maxEventsBatchSize = 666666
retriesOnError = 6
ignoredJobNamesPattern = 'ignore'
// scriptPath = ''
scriptContent = 'splunkins.sendTestReport(50)\\nsplunkins.sendCoverageReport(50)'
customMetaData = [
[dataSource: "BUILD_EVENT", configItem: "index", value: "poc123"]
// dataSource: BUILD_EVENT | BUILD_REPORT | CONSOLE_LOG | JENKINS_CONFIG | FILE | QUEUE_INFO | SLAVE_INFO | default
// configItem: index | sourcetype | disabled
]
}Tested Plugin Versions: splunk-devops-1.6.0.hpi, script-security-1.44.hpi
Ssh
tools {
ssh =
[name : 'dev-p1-app-01',
hostname : 'dev-p1-app-01',
username : 'user.name',
encryptedPassword: 'ENC(AAAADDi67hVsOnOklqPJMGDW/kYaYGtvwEBGYx6POU72V8IjL3durqHPZ8s=)',
remoteRootDir : '/home/user.name',
port : 22,
timeout : 300000,
overrideKey : false,
disableExec : false,
keyPath : '',
key : """-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEA3XHBgsU3+Ngkb0EupoR9UKoyZHlHW585rSyt/f0uw/8QA2I1
HChRnDms1ws3IkRpK4r4E9ID+0vptKWv/Tj0XS2J/Ikb0NV7VKEKd7+yS4BgngTV
Sa1PbZACYOXyJvfb0lpfNhuJYqOfA5Nl8FDn5VsNsJhLLm6MxRzG96z+UY0oVTTP
+QVZqF8VxDkM36S9CuWa+hSdN9xolDiUEFx7GLX8KiRlHNByjVBPwbH8UQYWvlDW
8N1mpOJ41Ps02y5LPO2qmdjmxMjE6GqswPcDit8z+7wZcMGq9ls9ZR7qK9ZYt4Kv
d+jeAxvNVru+Yv/DkoGeFVVd7xu+kF48XpwGYQIBIwKCAQEAynaiS6z/+XUooDuY
Xbr2Ox9EBBccq4pDXICfFBquag3Ff2+7h3VR7euWtfugH1R9aaOg/C26f1tZVLS+
KVik53oXwlF4hGtpcfJStqCjAzOLiSj9hTC9pgACLLT6p0kDfn6C76Ql1ob3yMFH
Qh4V2QLKsBY2G9LJ2MnafAvhNJycg0zHcep2GriMmksFp0TI5kw54LtcN4+yLqPB
gw1ESIBhLXft+dw3Jk2+pqlUF9o+2b8FFtW6+1y0C88XKp/QBMEcFRoZoRAvkffI
OME1uIJpvCUBiMHLiHdX/htDTSTid6SNHHbppNZHJJ9TkbCQhRuVWSFormgl31+2
xPf7CwKBgQD9qEwBfJ7d1I2s3Cidj8klml/1BJoA+hl4GtxBS50oclEfyFYfTxDE
w7KNK89v69bl3WFHYDESm9x3p/KGZ07TWDiyVq1hESJvDSfCV+Xw9jQfcN4BmLao
WAA3IJ/qayCkj2MG1Zdyswb0Fb6dEUma/wo0XSezAx3BxpgvGAHj4wKBgQDffUzU
V84KppePH05hIOhbtKJGp62vYP3Fllk3HWjP9xhyGBMZhHbRd7i6D5lYaxh8Isah
/7KPhhicQB4tHUCsX4HBjBb5q3yh05vnav2/0txw5RWeKncMARh+BpEuJFVcdUOu
Sy9bw8p7cO7d6l0KgeE+XrEgbTwTXXVdXyrn6wKBgQD2aPlgh7BFNOFmF7JtLJeD
nUdFyfSwfezbEsdVX2V3v4IBngqE0Hawg5eB0smCqpY+Yga6XXF/ypunb/Lo9qRY
RxKBW4Paou4//iafiJY6iMTrV7MXfmhLwzNowJtYv9aROtU51s2in0iVVvOuhdJ5
T4ZBfxCfRNsUAr+4uDxZtwKBgQDMVU2O8TFo0tO2Df6EsF9pybjwJEcGvxPn2esr
E5MHSFDdV9bywkC/g2cQg0pfd9vfNbzr4ndepnzmoQWllxaO+Dweq/e/srsXnOZP
7Mq+Ap2pC/aB+vCAAQBzOTRHca0hVUUxo9OHGWirX/BV3ZblCQhzicaEDBmrTiIp
e5TxSwKBgQCxHRG0SpQzc3oVUd3Xilc4UcqBMJ++W9HgWm7h//6DRuHp50t4UWLs
STytXGk1cFDmfHYaI/2H5nbepwNMmS46KeJyKPWa1klMAnQkFf14A21SJYacHNKt
i0hqu/BU+HjQGMJ36Ghnt64lQKkXuhdhssfvfoDdhgCsbjx6YDLwSQ==
-----END RSA PRIVATE KEY-----"""
]
}Tested Plugin Versions: publish-over-ssh-1.14.hpi
SystemMessage
systemMessage {
message = "<b>Testing System Message</b>"
}Tested Plugin Versions: antisamy-markup-formatter-1.5.hpi
SystemProperties
systemProperties = [
"hudson.model.DirectoryBrowserSupport.CSP":""
]Tested Plugin Versions: NA
Note. This file is generated using docs.gradle
gradle -b docs.gradle generate
Whatever you do, don't go editing the readme.md file directly :-)