:Includes:
- gerrit-jenkins-cfg-merge
+ - gerrit-jenkins-sandbox-cleanup
- gerrit-jjb-deploy-job
- gerrit-jjb-merge
- gerrit-jjb-verify
:Includes:
- github-jenkins-cfg-merge
+ - github-jenkins-sandbox-cleanup
- github-jjb-deploy-job
- github-jjb-merge
- github-jjb-verify
Macros
======
+lf-infra-jjb-parameters
+-----------------------
+
+:Required Parameters:
+
+ :jjb-version: Version of Jenkins Job Builder (JJB) to install and use in
+ the jjb jobs.
+
+lf-jenkins-cfg-clouds
+---------------------
+
+Deploys Jenkins Cloud configuration read from the ``jenkins-clouds`` directory
+in ci-management repositories.
+
+.. note::
+
+ Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
+ config definitions for "production" and "sandbox" systems.
+
+:Required Parameters:
+
+ :jenkins-silos: Space-separated list of Jenkins silos to update
+ configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
+
lf-jenkins-cfg-global-vars
--------------------------
:Required parameters:
- :jenkins-silos: Space separated list of Jenkins silos to update
+ :jenkins-silos: Space-separated list of Jenkins silos to update
configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
lf-infra-jjbini
OpenStack Cloud plugin version supported:
-* 2.30
-* 2.31
-* 2.32
-* 2.33
-* 2.34
+* 2.30 - 2.34
+* 2.35 - 2.37
Cloud configuration are managed via a directory structure in ci-management as
follows:
:RETENTION_TIME: Number of minutes to wait for an idle slave to be used
again before it's removed. If set to -1, the slave will be kept
forever. (default: 0)
+ :CONNECTION_TYPE: The connection type for Jenkins to connect to the build
+ minion. Valid options: JNLP, SSH. (default: "SSH")
For a live example see the OpenDaylight project jenkins-config directory.
https://github.com/opendaylight/releng-builder/tree/master/jenkins-config
inspected.
+Jenkins Sandbox Cleanup
+-----------------------
+
+Cleanup Jenkins Sandbox of jobs and views periodically.
+
+:Template names:
+
+ - {project-name}-jenkins-sandbox-cleanup
+ - gerrit-jenkins-sandbox-cleanup
+ - github-jenkins-sandbox-cleanup
+
+:Comment Trigger: NONE
+
+:Required parameters:
+
+ :build-node: The node to run build on.
+ :jenkins-ssh-credential: Credential to use for SSH. (Generally
+ should be configured in defaults.yaml)
+
+:Optional parameters:
+
+ :cron: Schedule to run job. (default: '0 8 * * 6')
+
+
JJB Deploy Job
--------------
- gerrit-jjb-merge
- github-jjb-merge
+:Comment Trigger: remerge
+
:Required parameters:
:build-node: The node to run build on.
:branch: Git branch to fetch for the build. (default: master)
:build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
- :build-timeout: Timeout in seconds before aborting build. (default: 10)
+ :build-timeout: Timeout in minutes before aborting build. (default: 10)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:stream: Keyword that can be used to represent a release code-name.
Often the same as the branch. (default: master)
- gerrit-jjb-verify
- github-jjb-verify
+:Comment Trigger: recheck|reverify
+
:Required parameters:
:build-node: The node to run build on.
:branch: Git branch to fetch for the build. (default: master)
:build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
- :build-timeout: Timeout in seconds before aborting build. (default: 10)
+ :build-timeout: Timeout in minutes before aborting build. (default: 10)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:stream: Keyword that can be used to represent a release code-name.
Often the same as the branch. (default: master)
:branch: Git branch to fetch for the build. (default: master)
:build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
- :build-timeout: Timeout in seconds before aborting build. (default: 10)
+ :build-timeout: Timeout in minutes before aborting build. (default: 10)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:stream: Keyword that can be used to represent a release code-name.
Often the same as the branch. (default: master)
:Optional parameters:
+ :build-timeout: Timeout in minutes before aborting build. (default: 15)
:file-patterns: Space-separated list of file patterns to scan.
(default: \*.go \*.groovy \*.java \*.py \*.sh)
:spdx-disable: Disable the SPDX-Identifier checker. (default: false)
(default: '')
:licenses-allowed: Comma-separated list of allowed licenses.
(default: Apache-2.0,EPL-1.0,MIT)
+ :project-pattern: The ANT based pattern for Gerrit Trigger to choose which
+ projects to trigger job against. (default: '**')
+
+.. _gjjb-openstack-cron:
+
+OpenStack Cron
+--------------
+
+Cron job that runs regularly to perform periodic tasks against OpenStack.
+
+This job requires a Config File Provider file named ``clouds-yaml`` available
+containing the credentials for the cloud.
+
+:Template Names:
+ - {project-name}-openstack-cron
+ - gerrit-openstack-cron
+ - github-openstack-cron
+
+:Required parameters:
+
+ :build-node: The node to run build on.
+ :jenkins-ssh-credential: Credential to use for SSH. (Generally should
+ be configured in defaults.yaml)
+
+:Optional parameters:
+
+ :branch: Git branch to fetch for the build. (default: master)
+ :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+ :build-timeout: Timeout in minutes before aborting build. (default: 90)
+ :cron: Time when the packer image should be rebuilt (default: @daily)
+ :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+ :openstack-cloud: OS_CLOUD setting to pass to openstack client.
+ (default: vex)
+ :stream: Keyword that can be used to represent a release code-name.
+ Often the same as the branch. (default: master)
+ :submodule-recursive: Whether to checkout submodules recursively.
+ (default: true)
.. _gjjb-packer-merge:
- gerrit-packer-merge
- github-packer-merge
+:Comment Trigger: remerge
+
:Required parameters:
:build-node: The node to run build on.
:cron: Time when the packer image should be rebuilt (default: @monthly)
:branch: Git branch to fetch for the build. (default: master)
:build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
- :build-timeout: Timeout in seconds before aborting build. (default: 10)
+ :build-timeout: Timeout in minutes before aborting build. (default: 90)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:packer-cloud-settings: Name of settings file containing credentials
for the cloud that packer will build on. (default: packer-cloud-env)
- gerrit-packer-verify
- github-packer-verify
+:Comment Trigger: recheck|reverify
+
:Required parameters:
:build-node: The node to run build on.
:branch: Git branch to fetch for the build. (default: master)
:build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
- :build-timeout: Timeout in seconds before aborting build. (default: 10)
+ :build-timeout: Timeout in minutes before aborting build. (default: 10)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:packer-cloud-settings: Name of settings file containing credentials
for the cloud that packer will build on. (default: packer-cloud-env)
Code Review / releng / global-jjb.git / blobdiff