11 Recommended jobs that should be deployed for CI using Gerrit.
15 - gerrit-jenkins-cfg-merge
16 - gerrit-jjb-deploy-job
20 {project-name}-github-ci-jobs
21 -----------------------------
23 Recommended jobs that should be deployed CI using GitHub.
27 - github-jenkins-cfg-merge
28 - github-jjb-deploy-job
32 {project-name}-packer-jobs
33 --------------------------
35 Jobs related to Packer builds for CI using Gerrit.
40 - gerrit-packer-verify
42 {project-name}-github-packer-jobs
43 ---------------------------------
45 Jobs related to Packer builds for CI using GitHub.
50 - github-packer-verify
55 lf-jenkins-cfg-global-vars
56 --------------------------
58 Manages the Global Jenkins variables. This macro will clear all exist macros
59 in Jenkins and replaces them with the ones defined by the
60 ci-management/jenkins-config/global-vars-SILO.sh script.
64 Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
65 config definitions for "production" and "sandbox" systems.
69 :jenkins-silos: Space separated list of Jenkins silos to update
70 configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
75 Provides jenkins_jobs.ini configuration for Jenkins.
77 lf-infra-jjbini-sandbox
78 -----------------------
80 Provides jenkins_jobs.ini configuration for Jenkins sandbox.
82 .. todo:: This needs to be consolidated into lf-infra-jjbini when JJB 2.0 is available
87 Common packer configuration.
92 Gerrit file-paths for packer jobs.
97 Parameters useful for packer related tasks.
101 :packer-version: Version of packer to install / use.
102 (shell: PACKER_VERSION)
104 lf-packer-verify-file-paths
105 ---------------------------
107 Gerrit file-paths for packer verify jobs.
115 Job submits a patch to lock or unlock a project's branch.
118 - {project-name}-gerrit-branch-lock-{stream}
122 .. _lf-global-jjb-jenkins-cfg-merge:
124 Jenkins Configuration Merge
125 ---------------------------
127 Jenkins job to manage Global Jenkins configuration.
131 Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
132 config definitions for "production" and "sandbox" systems.
136 - {project-name}-jenkins-cfg-merge
137 - gerrit-jenkins-cfg-merge
138 - github-jenkins-cfg-merge
140 :Optional parameters:
142 :branch: Git branch to build against. (default: master)
143 :cron: How often to run the job on a cron schedule. (default: @daily)
144 :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
145 :jenkins-silos: Space separated list of Jenkins silos to update
146 configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
147 (default: production sandbox)
149 Typically this template is automatically pulled in by the
150 "{project-name}-ci-jobs" job-group and does not need to be explicitly called if
151 the job group is being used.
155 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-minimal.yaml
160 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-full.yaml
163 Global Environment Variables
164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
166 Global Environment Variables are managed via the
167 ``jenkins-config/global-vars-SILO.sh`` file in ci-management. Replace SILO with
168 the name of the Jenkins silo the variable configuration is for.
170 The format for this file is ``KEY=value`` for example::
172 GERRIT_URL=https://git.opendaylight.org/gerrit
173 GIT_BASE=git://devvexx.opendaylight.org/mirror/$PROJECT
174 GIT_URL=git://devvexx.opendaylight.org/mirror
175 JENKINS_HOSTNAME=vex-yul-odl-jenkins-2
176 LOGS_SERVER=https://logs.opendaylight.org
177 NEXUS_URL=https://nexus.opendaylight.org
178 ODLNEXUSPROXY=https://nexus.opendaylight.org
180 SONAR_URL=https://sonar.opendaylight.org
185 This configuration requires the OpenStack Cloud plugin in Jenkins and is
186 currently the only cloud plugin supported.
188 OpenStack Cloud plugin version supported:
194 Cloud configuration are managed via a directory structure in ci-management as
197 - jenkins-config/clouds/openstack/
198 - jenkins-config/clouds/openstack/cattle/cloud.cfg
199 - jenkins-config/clouds/openstack/cattle/centos7-builder-2c-2g.cfg
200 - jenkins-config/clouds/openstack/cattle/centos7-builder-4c-4g.cfg
201 - jenkins-config/clouds/openstack/cattle/centos7-docker-4c-4g.cfg
203 The directory name inside of the "openstack" directory is used as the name of
204 the cloud configuration. In this case "cattle" is being used as the cloud name.
206 The ``cloud.cfg`` file is a special file used to configure the main cloud
207 configuration in the format ``KEY=value``.
211 :CLOUD_URL: API endpoint URL for Keystone.
213 :CLOUD_IGNORE_SSL: Ignore unverified SSL certificates. (default: false)
214 :CLOUD_ZONE: OpenStack region to use. (default: "")
215 :CLOUD_CREDENTIAL_ID: Credential to use for authentication to OpenStack.
216 (default: "os-cloud")
217 :INSTANCE_CAP: Total number of instances the cloud will allow spin up.
219 :SANDBOX_CAP: Total number of instances the clodu will allow to
220 spin up. This applies to "sandbox" systems and overrides the
221 INSTANCE_CAP setting. (default: null)
223 :Template Parameters:
227 In the case of template definitions of a parameter below is not passed
228 the one defined in default clouds will be inherited.
230 :IMAGE_NAME: The image name to use for this template.
232 :LABELS: Labels to assign to the vm. (default: FILE_NAME)
233 :HARDWARE_ID: OpenStack flavor to use. (default: "")
234 :NETWORK_ID: OpenStack network to use. (default: "")
235 :USER_DATA_ID: User Data to pass into the instance.
236 (default: jenkins-init-script)
237 :INSTANCE_CAP: Total number of instances of this type that can be launched
238 at one time. When defined in clouds.cfg it defines the total for the
239 entire cloud. (default: null)
240 :SANDBOX_CAP: Total number of instances of this type that can be launched
241 at one time. When defined in clouds.cfg it defines the total for the
242 entire cloud. This applies to "sandbox" systems and overrides the
243 INSTANCE_CAP setting. (default: null)
244 :FLOATING_IP_POOL: Floating ip pool to use. (default: "")
245 :SECURITY_GROUPS: Security group to use. (default: "default")
246 :AVAILABILITY_ZONE: OpenStack availability zone to use. (default: "")
247 :START_TIMEOUT: Number of milliseconds to wait for the agent to be
248 provisioned and connected. (default: 600000)
249 :KEY_PAIR_NAME: SSH Public Key Pair to use for authentication.
251 :NUM_EXECUTORS: Number of executors to enable for the instance.
253 :JVM_OPTIONS: JVM Options to pass to Java. (default: "")
254 :FS_ROOT: File system root for the workspace. (default: "/w")
255 :RETENTION_TIME: Number of minutes to wait for an idle slave to be used
256 again before it's removed. If set to -1, the slave will be kept
257 forever. (default: 0)
259 For a live example see the OpenDaylight project jenkins-config directory.
260 https://github.com/opendaylight/releng-builder/tree/master/jenkins-config
265 :Cloud Configuration:
267 The directory ``groovy-inserts`` contains the groovy script output that is
268 used to push to Jenkins. In the event of a job failure this file can be
275 Deploy jobs to jenkins-sandbox system via code review comment
277 This job checks out the current code review patch and then runs a
278 `jenkins-jobs update` to push a patch defined by the comment.
282 - {project-name}-jjb-deploy-job
283 - gerrit-jjb-deploy-job
284 - github-jjb-deploy-job
286 :Comment Trigger: jjb-deploy JOB_NAME
290 JOB_NAME can include the * wildcard character to push multiple jobs
291 matching the pattern. For example `jjb-deploy builder-jjb-*`` will push
292 all builder-jjb-* jobs to the sandbox system.
294 :Required parameters:
296 :build-node: The node to run build on.
297 :jenkins-ssh-credential: Credential to use for SSH. (Generally
298 should be configured in defaults.yaml)
300 :Optional parameters:
302 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
303 :gerrit_jjb_deploy_job_triggers: Override Gerrit Triggers.
309 Runs `jenkins-jobs update` to update production job configuration
312 - {project-name}-jjb-merge
316 :Required parameters:
318 :build-node: The node to run build on.
319 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
320 be configured in defaults.yaml)
321 :mvn-settings: The name of settings file containing credentials for
324 :Optional parameters:
326 :branch: Git branch to fetch for the build. (default: master)
327 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
328 :build-timeout: Timeout in seconds before aborting build. (default: 10)
329 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
330 :stream: Keyword that can be used to represent a release code-name.
331 Often the same as the branch. (default: master)
332 :submodule-recursive: Whether to checkout submodules recursively.
335 :gerrit_merge_triggers: Override Gerrit Triggers.
336 :gerrit_trigger_file_paths: Override file paths which can be used to
337 filter which file modifications will trigger a build.
338 (default defined by lf_jjb_common)
344 Runs `jenkins-jobs test` to validate JJB syntax
347 - {project-name}-jjb-verify
351 :Required parameters:
353 :build-node: The node to run build on.
354 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
355 be configured in defaults.yaml)
356 :mvn-settings: The name of settings file containing credentials for
359 :Optional parameters:
361 :branch: Git branch to fetch for the build. (default: master)
362 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
363 :build-timeout: Timeout in seconds before aborting build. (default: 10)
364 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
365 :stream: Keyword that can be used to represent a release code-name.
366 Often the same as the branch. (default: master)
367 :submodule-recursive: Whether to checkout submodules recursively.
370 :gerrit_verify_triggers: Override Gerrit Triggers.
371 :gerrit_trigger_file_paths: Override file paths which can be used to
372 filter which file modifications will trigger a build.
373 (default defined by lf_jjb_common)
376 .. _gjjb-packer-merge:
381 Packer Merge job runs `packer build` to build system images in the cloud.
384 - {project-name}-packer-merge-{platforms}-{templates}
385 - gerrit-packer-merge
386 - github-packer-merge
388 :Required parameters:
390 :build-node: The node to run build on.
391 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
392 be configured in defaults.yaml)
393 :mvn-settings: The name of settings file containing credentials for
395 :platforms: Platform or distribution to build. Typically json file
396 found in the packer/vars directory. (Example: centos)
397 :template: System template to build. Typically shell script found in
398 the packer/provision directory. (Example: java-builder)
400 :Optional parameters:
402 :branch: Git branch to fetch for the build. (default: master)
403 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
404 :build-timeout: Timeout in seconds before aborting build. (default: 10)
405 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
406 :packer-cloud-settings: Name of settings file containing credentials
407 for the cloud that packer will build on. (default: packer-cloud-env)
408 :packer-version: Version of packer to install / use in build. (default: 1.0.2)
409 :stream: Keyword that can be used to represent a release code-name.
410 Often the same as the branch. (default: master)
411 :submodule-recursive: Whether to checkout submodules recursively.
414 :gerrit_verify_triggers: Override Gerrit Triggers.
417 .. _gjjb-packer-verify:
422 Packer Verify job runs `packer validate` to verify packer configuration.
425 - {project-name}-packer-verify
426 - gerrit-packer-verify
427 - github-packer-verify
429 :Required parameters:
431 :build-node: The node to run build on.
432 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
433 be configured in defaults.yaml)
434 :mvn-settings: The name of settings file containing credentials for
437 :Optional parameters:
439 :branch: Git branch to fetch for the build. (default: master)
440 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
441 :build-timeout: Timeout in seconds before aborting build. (default: 10)
442 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
443 :packer-cloud-settings: Name of settings file containing credentials
444 for the cloud that packer will build on. (default: packer-cloud-env)
445 :packer-version: Version of packer to install / use in build. (default: 1.0.2)
446 :stream: Keyword that can be used to represent a release code-name.
447 Often the same as the branch. (default: master)
448 :submodule-recursive: Whether to checkout submodules recursively.
451 :gerrit_verify_triggers: Override Gerrit Triggers.
452 :gerrit_trigger_file_paths: Override file paths which can be used to
453 filter which file modifications will trigger a build.