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
84 lf-packer-verify-file-paths
85 ---------------------------
87 Gerrit file-paths for packer verify jobs.
92 Gerrit file-paths for packer jobs.
97 Common packer configuration.
105 Job submits a patch to lock or unlock a project's branch.
108 - {project-name}-gerrit-branch-lock-{stream}
112 .. _lf-global-jjb-jenkins-cfg-merge:
114 Jenkins Configuration Merge
115 ---------------------------
117 Jenkins job to manage Global Jenkins configuration.
121 Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
122 config definitions for "production" and "sandbox" systems.
126 - {project-name}-jenkins-cfg-merge
127 - gerrit-jenkins-cfg-merge
128 - github-jenkins-cfg-merge
130 :Optional parameters:
132 :branch: Git branch to build against. (default: master)
133 :cron: How often to run the job on a cron schedule. (default: @daily)
134 :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
135 :jenkins-silos: Space separated list of Jenkins silos to update
136 configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
137 (default: production sandbox)
139 Typically this template is automatically pulled in by the
140 "{project-name}-ci-jobs" job-group and does not need to be explicitly called if
141 the job group is being used.
145 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-minimal.yaml
150 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-full.yaml
153 Global Environment Variables
154 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
156 Global Environment Variables are managed via the
157 ``jenkins-config/global-vars-SILO.sh`` file in ci-management. Replace SILO with
158 the name of the Jenkins silo the variable configuration is for.
160 The format for this file is ``KEY=value`` for example::
162 GERRIT_URL=https://git.opendaylight.org/gerrit
163 GIT_BASE=git://devvexx.opendaylight.org/mirror/$PROJECT
164 GIT_URL=git://devvexx.opendaylight.org/mirror
165 JENKINS_HOSTNAME=vex-yul-odl-jenkins-2
166 LOGS_SERVER=https://logs.opendaylight.org
167 NEXUS_URL=https://nexus.opendaylight.org
168 ODLNEXUSPROXY=https://nexus.opendaylight.org
170 SONAR_URL=https://sonar.opendaylight.org
175 This configuration requires the OpenStack Cloud plugin in Jenkins and is
176 currently the only cloud plugin supported.
178 OpenStack Cloud plugin version supported:
184 Cloud configuration are managed via a directory structure in ci-management as
187 - jenkins-config/clouds/openstack/
188 - jenkins-config/clouds/openstack/cattle/cloud.cfg
189 - jenkins-config/clouds/openstack/cattle/centos7-builder-2c-2g.cfg
190 - jenkins-config/clouds/openstack/cattle/centos7-builder-4c-4g.cfg
191 - jenkins-config/clouds/openstack/cattle/centos7-docker-4c-4g.cfg
193 The directory name inside of the "openstack" directory is used as the name of
194 the cloud configuration. In this case "cattle" is being used as the cloud name.
196 The ``cloud.cfg`` file is a special file used to configure the main cloud
197 configuration in the format ``KEY=value``.
201 :CLOUD_URL: API endpoint URL for Keystone.
203 :CLOUD_IGNORE_SSL: Ignore unverified SSL certificates. (default: false)
204 :CLOUD_ZONE: OpenStack region to use. (default: "")
205 :CLOUD_CREDENTIAL_ID: Credential to use for authentication to OpenStack.
206 (default: "os-cloud")
207 :INSTANCE_CAP: Total number of instances the cloud will allow spin up.
209 :SANDBOX_CAP: Total number of instances the clodu will allow to
210 spin up. This applies to "sandbox" systems and overrides the
211 INSTANCE_CAP setting. (default: null)
213 :Template Parameters:
217 In the case of template definitions of a parameter below is not passed
218 the one defined in default clouds will be inherited.
220 :IMAGE_NAME: The image name to use for this template.
222 :LABELS: Labels to assign to the vm. (default: FILE_NAME)
223 :HARDWARE_ID: OpenStack flavor to use. (default: "")
224 :NETWORK_ID: OpenStack network to use. (default: "")
225 :USER_DATA_ID: User Data to pass into the instance.
226 (default: jenkins-init-script)
227 :INSTANCE_CAP: Total number of instances of this type that can be launched
228 at one time. When defined in clouds.cfg it defines the total for the
229 entire cloud. (default: null)
230 :SANDBOX_CAP: Total number of instances of this type that can be launched
231 at one time. When defined in clouds.cfg it defines the total for the
232 entire cloud. This applies to "sandbox" systems and overrides the
233 INSTANCE_CAP setting. (default: null)
234 :FLOATING_IP_POOL: Floating ip pool to use. (default: "")
235 :SECURITY_GROUPS: Security group to use. (default: "default")
236 :AVAILABILITY_ZONE: OpenStack availability zone to use. (default: "")
237 :START_TIMEOUT: Number of milliseconds to wait for the agent to be
238 provisioned and connected. (default: 600000)
239 :KEY_PAIR_NAME: SSH Public Key Pair to use for authentication.
241 :NUM_EXECUTORS: Number of executors to enable for the instance.
243 :JVM_OPTIONS: JVM Options to pass to Java. (default: "")
244 :FS_ROOT: File system root for the workspace. (default: "/w")
245 :RETENTION_TIME: Number of minutes to wait for an idle slave to be used
246 again before it's removed. If set to -1, the slave will be kept
247 forever. (default: 0)
249 For a live example see the OpenDaylight project jenkins-config directory.
250 https://github.com/opendaylight/releng-builder/tree/master/jenkins-config
255 :Cloud Configuration:
257 The directory ``groovy-inserts`` contains the groovy script output that is
258 used to push to Jenkins. In the event of a job failure this file can be
265 Deploy jobs to jenkins-sandbox system via code review comment
267 This job checks out the current code review patch and then runs a
268 `jenkins-jobs update` to push a patch defined by the comment.
272 - {project-name}-jjb-deploy-job
273 - gerrit-jjb-deploy-job
274 - github-jjb-deploy-job
276 :Comment Trigger: jjb-deploy JOB_NAME
280 JOB_NAME can include the * wildcard character to push multiple jobs
281 matching the pattern. For example `jjb-deploy builder-jjb-*`` will push
282 all builder-jjb-* jobs to the sandbox system.
284 :Required parameters:
286 :build-node: The node to run build on.
287 :jenkins-ssh-credential: Credential to use for SSH. (Generally
288 should be configured in defaults.yaml)
290 :Optional parameters:
292 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
293 :gerrit_jjb_deploy_job_triggers: Override Gerrit Triggers.
299 Runs `jenkins-jobs update` to update production job configuration
302 - {project-name}-jjb-merge
306 :Required parameters:
308 :build-node: The node to run build on.
309 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
310 be configured in defaults.yaml)
311 :mvn-settings: The name of settings file containing credentials for
314 :Optional parameters:
316 :branch: Git branch to fetch for the build. (default: master)
317 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
318 :build-timeout: Timeout in seconds before aborting build. (default: 10)
319 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
320 :stream: Keyword that can be used to represent a release code-name.
321 Often the same as the branch. (default: master)
322 :submodule-recursive: Whether to checkout submodules recursively.
325 :gerrit_merge_triggers: Override Gerrit Triggers.
326 :gerrit_trigger_file_paths: Override file paths which can be used to
327 filter which file modifications will trigger a build.
328 (default defined by lf_jjb_common)
334 Runs `jenkins-jobs test` to validate JJB syntax
337 - {project-name}-jjb-verify
341 :Required parameters:
343 :build-node: The node to run build on.
344 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
345 be configured in defaults.yaml)
346 :mvn-settings: The name of settings file containing credentials for
349 :Optional parameters:
351 :branch: Git branch to fetch for the build. (default: master)
352 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
353 :build-timeout: Timeout in seconds before aborting build. (default: 10)
354 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
355 :stream: Keyword that can be used to represent a release code-name.
356 Often the same as the branch. (default: master)
357 :submodule-recursive: Whether to checkout submodules recursively.
360 :gerrit_verify_triggers: Override Gerrit Triggers.
361 :gerrit_trigger_file_paths: Override file paths which can be used to
362 filter which file modifications will trigger a build.
363 (default defined by lf_jjb_common)
366 .. _gjjb-packer-merge:
371 Packer Merge job runs `packer build` to build system images in the cloud.
374 - {project-name}-packer-merge-{platforms}-{templates}
375 - gerrit-packer-merge
376 - github-packer-merge
378 :Required parameters:
380 :build-node: The node to run build on.
381 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
382 be configured in defaults.yaml)
383 :mvn-settings: The name of settings file containing credentials for
385 :platforms: Platform or distribution to build. Typically json file
386 found in the packer/vars directory. (Example: centos)
387 :template: System template to build. Typically shell script found in
388 the packer/provision directory. (Example: java-builder)
390 :Optional parameters:
392 :branch: Git branch to fetch for the build. (default: master)
393 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
394 :build-timeout: Timeout in seconds before aborting build. (default: 10)
395 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
396 :packer-cloud-settings: Name of settings file containing credentials
397 for the cloud that packer will build on. (default: packer-cloud-env)
398 :packer-version: Version of packer to install / use in build. (default: 1.0.2)
399 :stream: Keyword that can be used to represent a release code-name.
400 Often the same as the branch. (default: master)
401 :submodule-recursive: Whether to checkout submodules recursively.
404 :gerrit_verify_triggers: Override Gerrit Triggers.
407 .. _gjjb-packer-verify:
412 Packer Verify job runs `packer validate` to verify packer configuration.
415 - {project-name}-packer-verify
416 - gerrit-packer-verify
417 - github-packer-verify
419 :Required parameters:
421 :build-node: The node to run build on.
422 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
423 be configured in defaults.yaml)
424 :mvn-settings: The name of settings file containing credentials for
427 :Optional parameters:
429 :branch: Git branch to fetch for the build. (default: master)
430 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
431 :build-timeout: Timeout in seconds before aborting build. (default: 10)
432 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
433 :packer-cloud-settings: Name of settings file containing credentials
434 for the cloud that packer will build on. (default: packer-cloud-env)
435 :packer-version: Version of packer to install / use in build. (default: 1.0.2)
436 :stream: Keyword that can be used to represent a release code-name.
437 Often the same as the branch. (default: master)
438 :submodule-recursive: Whether to checkout submodules recursively.
441 :gerrit_verify_triggers: Override Gerrit Triggers.
442 :gerrit_trigger_file_paths: Override file paths which can be used to
443 filter which file modifications will trigger a build.