docs/jjb/lf-ci-jobs.rst

   1 #######
   2 CI Jobs
   3 #######
   4
   5 Job Groups
   6 ==========
   7
   8 .. include:: ../job-groups.rst
   9
  10 Below is a list of CI job groups:
  11
  12 .. literalinclude:: ../../jjb/lf-ci-job-groups.yaml
  13    :language: yaml
  14
  15
  16 Macros
  17 ======
  18
  19 lf-infra-jjb-parameters
  20 -----------------------
  21
  22 :Required Parameters:
  23
  24     :jjb-cache: Location of Jenkins Job Builder (JJB) cache used for jjb
  25         jobs.
  26     :jjb-version: Version of Jenkins Job Builder (JJB) to install and use in
  27         the jjb jobs.
  28
  29 lf-jenkins-cfg-clouds
  30 ---------------------
  31
  32 Deploys Jenkins Cloud configuration read from the ``jenkins-clouds`` directory
  33 in ci-management repositories.
  34
  35 .. note::
  36
  37    Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
  38    config definitions for "production" and "sandbox" systems.
  39
  40 :Required Parameters:
  41
  42     :jenkins-silos: Space-separated list of Jenkins silos to update
  43         configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
  44
  45 lf-jenkins-cfg-global-vars
  46 --------------------------
  47
  48 Manages the Global Jenkins variables. This macro will clear all exist macros
  49 in Jenkins and replaces them with the ones defined by the
  50 ci-management/jenkins-config/global-vars-SILO.sh script.
  51
  52 .. note::
  53
  54    Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
  55    config definitions for "production" and "sandbox" systems.
  56
  57 :Required parameters:
  58
  59     :jenkins-silos: Space-separated list of Jenkins silos to update
  60         configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
  61
  62 lf-infra-jjbini
  63 ---------------
  64
  65 Provides jenkins_jobs.ini configuration for Jenkins.
  66
  67 lf-packer-common
  68 ----------------
  69
  70 Common packer configuration.
  71
  72 lf-packer-file-paths
  73 --------------------
  74
  75 Gerrit file-paths for packer jobs.
  76
  77 lf-packer-parameters
  78 --------------------
  79
  80 Parameters useful for packer related tasks.
  81
  82 :Parameters:
  83
  84     :packer-version: Version of packer to install / use.
  85         (shell: PACKER_VERSION)
  86
  87 lf-packer-verify-file-paths
  88 ---------------------------
  89
  90 Gerrit file-paths for packer verify jobs.
  91
  92 lf-puppet-parameters
  93 --------------------
  94
  95 Parameters useful for Puppet related tasks.
  96
  97 :Parameters:
  98
  99     :puppet-lint-version: Version of puppet-lint to install / use.
 100         (shell: PUPPET_LINT_VERSION)
 101
 102 Job Templates
 103 =============
 104
 105 .. _gerrit-branch-lock:
 106
 107 Gerrit Branch Lock
 108 ------------------
 109
 110 Job submits a patch to lock or unlock a project's branch. This should only be
 111 loaded once, as "ci-management-gerrit-branch-lock" (or "ci-management"
 112 equivalent). That job will process lock/unlock requests for all projects and
 113 all branches.
 114
 115 :Template Names:
 116     - {project-name}-gerrit-branch-lock
 117     - gerrit-branch-lock
 118
 119 :Comment Trigger:
 120
 121     * lock branch
 122     * unlock branch
 123
 124 :Required parameters:
 125
 126     :build-node: The node to run build on.
 127     :jenkins-ssh-credential: Credential to use for SSH. (Generally
 128         should be configured in defaults.yaml)
 129
 130 :Optional parameters:
 131
 132     :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
 133     :submodule-timeout: Timeout (in minutes) for checkout operation.
 134         (default: 10)
 135     :gerrit_merge_triggers: Override Gerrit Triggers.
 136
 137 .. _lf-global-jjb-jenkins-cfg-merge:
 138
 139 Jenkins Configuration Merge
 140 ---------------------------
 141
 142 Jenkins job to manage Global Jenkins configuration.
 143
 144 .. note::
 145
 146    Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
 147    config definitions for "production" and "sandbox" systems.
 148
 149 :Template names:
 150
 151     - {project-name}-jenkins-cfg-merge
 152     - gerrit-jenkins-cfg-merge
 153     - github-jenkins-cfg-merge
 154
 155 :Optional parameters:
 156
 157     :branch: Git branch to build against. (default: master)
 158     :cron: How often to run the job on a cron schedule. (default: @daily)
 159     :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
 160     :jenkins-silos: Space separated list of Jenkins silos to update
 161         configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
 162         (default: production sandbox)
 163
 164 Typically this template is automatically pulled in by the
 165 "{project-name}-ci-jobs" job-group and does not need to be explicitly called if
 166 the job group is being used.
 167
 168 Minimal Example:
 169
 170 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-minimal.yaml
 171    :language: yaml
 172
 173 Full Example:
 174
 175 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-full.yaml
 176    :language: yaml
 177
 178 .. _jenkins-cfg-envvar:
 179
 180 Global Environment Variables
 181 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 182
 183 Global Environment Variables are managed via the
 184 ``jenkins-config/global-vars-SILO.sh`` file in ci-management. Replace SILO with
 185 the name of the Jenkins silo the variable configuration is for.
 186
 187 The format for this file is ``KEY=value`` for example::
 188
 189     GERRIT_URL=https://git.opendaylight.org/gerrit
 190     GIT_BASE=git://devvexx.opendaylight.org/mirror/$PROJECT
 191     GIT_URL=git://devvexx.opendaylight.org/mirror
 192     JENKINS_HOSTNAME=vex-yul-odl-jenkins-2
 193     LOGS_SERVER=https://logs.opendaylight.org
 194     NEXUS_URL=https://nexus.opendaylight.org
 195     ODLNEXUSPROXY=https://nexus.opendaylight.org
 196     SILO=sandbox
 197     SONAR_URL=https://sonar.opendaylight.org
 198
 199 Cloud Configuration
 200 ^^^^^^^^^^^^^^^^^^^
 201
 202 This configuration requires the OpenStack Cloud plugin in Jenkins and is
 203 currently the only cloud plugin supported.
 204
 205 OpenStack Cloud plugin version supported:
 206
 207 * 2.30 - 2.34
 208 * 2.35 - 2.37
 209
 210 Cloud configuration are managed via a directory structure in ci-management as
 211 follows:
 212
 213 - jenkins-config/clouds/openstack/
 214 - jenkins-config/clouds/openstack/cattle/cloud.cfg
 215 - jenkins-config/clouds/openstack/cattle/centos7-builder-2c-2g.cfg
 216 - jenkins-config/clouds/openstack/cattle/centos7-builder-4c-4g.cfg
 217 - jenkins-config/clouds/openstack/cattle/centos7-docker-4c-4g.cfg
 218
 219 The directory name inside of the "openstack" directory is used as the name of
 220 the cloud configuration. In this case "cattle" is being used as the cloud name.
 221
 222 The ``cloud.cfg`` file is a special file used to configure the main cloud
 223 configuration in the format ``KEY=value``.
 224
 225 :Cloud Parameters:
 226
 227     :CLOUD_URL: API endpoint URL for Keystone.
 228         (default: "")
 229     :CLOUD_IGNORE_SSL: Ignore unverified SSL certificates. (default: false)
 230     :CLOUD_ZONE: OpenStack region to use. (default: "")
 231     :CLOUD_CREDENTIAL_ID: Credential to use for authentication to OpenStack.
 232         (default: "os-cloud")
 233     :INSTANCE_CAP: Total number of instances the cloud will allow spin up.
 234         (default: null)
 235     :SANDBOX_CAP: Total number of instances the cloud will allow to
 236         spin up. This applies to "sandbox" systems and overrides the
 237         INSTANCE_CAP setting. (default: null)
 238
 239 :Template Parameters:
 240
 241     .. note::
 242
 243        In the case of template definitions of a parameter below is not passed
 244        the one defined in default clouds will be inherited.
 245
 246     :IMAGE_NAME: The image name to use for this template. (required)
 247     :HARDWARE_ID: OpenStack flavor to use. (required)
 248
 249     :LABELS: Labels to assign to the vm. (default: FILE_NAME)
 250     :VOLUME_SIZE: Volume size to assign to vm. (default: "")
 251     :HARDWARE_ID: Hardware Id to assign to vm. (default: "")
 252     :NETWORK_ID: OpenStack network to use. (default: "")
 253     :USER_DATA_ID: User Data to pass into the instance.
 254         (default: jenkins-init-script)
 255     :INSTANCE_CAP: Total number of instances of this type that can be launched
 256         at one time. When defined in clouds.cfg it defines the total for the
 257         entire cloud. (default: null)
 258     :SANDBOX_CAP: Total number of instances of this type that can be launched
 259         at one time. When defined in clouds.cfg it defines the total for the
 260         entire cloud. This applies to "sandbox" systems and overrides the
 261         INSTANCE_CAP setting. (default: null)
 262     :FLOATING_IP_POOL: Floating ip pool to use. (default: "")
 263     :SECURITY_GROUPS: Security group to use. (default: "default")
 264     :AVAILABILITY_ZONE: OpenStack availability zone to use. (default: "")
 265     :START_TIMEOUT: Number of milliseconds to wait for the agent to be
 266         provisioned and connected. (default: 600000)
 267     :KEY_PAIR_NAME: SSH Public Key Pair to use for authentication.
 268         (default: jenkins-ssh)
 269     :NUM_EXECUTORS: Number of executors to enable for the instance.
 270         (default: 1)
 271     :JVM_OPTIONS: JVM Options to pass to Java. (default: null)
 272     :FS_ROOT: File system root for the workspace. (default: "/w")
 273     :NODE_PROPERTIES: Node properties. (default: null)
 274     :RETENTION_TIME: Number of minutes to wait for an idle slave to be used
 275         again before it's removed. If set to -1, the slave will be kept
 276         forever. (default: 0)
 277     :CONNECTION_TYPE: The connection type for Jenkins to connect to the build
 278         minion. Valid options: JNLP, SSH. (default: "SSH")
 279     :CONFIG_TYPE: Configuration drive. (default: null)
 280
 281 For a live example see the OpenDaylight project jenkins-config directory.
 282 https://github.com/opendaylight/releng-builder/tree/master/jenkins-config
 283
 284 Troubleshooting
 285 ^^^^^^^^^^^^^^^
 286
 287 :Cloud Configuration:
 288
 289     The directory ``groovy-inserts`` contains the groovy script output that is
 290     used to push to Jenkins. In the event of a job failure this file can be
 291     inspected.
 292
 293  .. _lf-global-jjb-jenkins-cfg-verify:
 294
 295 Jenkins Configuration Verify
 296 ----------------------------
 297
 298 Jenkins job to verify the Global Jenkins configuration.
 299
 300 Requires the ``clouds-yaml`` file to be setup on the Jenkins host.
 301
 302 :Template names:
 303
 304     - {project-name}-jenkins-cfg-verify
 305     - gerrit-jenkins-cfg-verify
 306     - github-jenkins-cfg-verify
 307
 308 :Optional parameters:
 309
 310     :branch: Git branch to build against. (default: master)
 311     :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
 312
 313 This job is not part of the "{project-name}-ci-jobs" group. It must be called
 314 explicitly.
 315
 316 Example:
 317
 318 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-verify.yaml
 319    :language: yaml
 320
 321
 322 .. _jenkins-sandbox-cleanup:
 323
 324 Jenkins Sandbox Cleanup
 325 -----------------------
 326
 327 Cleanup Jenkins Sandbox of jobs and views periodically.
 328
 329 :Template names:
 330
 331     - {project-name}-jenkins-sandbox-cleanup
 332     - gerrit-jenkins-sandbox-cleanup
 333     - github-jenkins-sandbox-cleanup
 334
 335 :Comment Trigger: NONE
 336
 337 :Required parameters:
 338
 339     :build-node: The node to run build on.
 340     :jenkins-ssh-credential: Credential to use for SSH. (Generally
 341         should be configured in defaults.yaml)
 342
 343 :Optional parameters:
 344
 345     :cron: Schedule to run job. (default: '0 8 * * 6')
 346
 347
 348 .. _jjb-deploy:
 349
 350 JJB Deploy Job
 351 --------------
 352
 353 Deploy jobs to jenkins-sandbox system via code review comment.
 354
 355 This job checks out the current code review patch and then runs a
 356 ``jenkins-jobs update`` to push a patch defined by the comment.
 357
 358 :Template names:
 359
 360     - {project-name}-jjb-deploy-job
 361     - gerrit-jjb-deploy-job
 362     - github-jjb-deploy-job
 363
 364 :Comment Trigger: jjb-deploy JOB_NAME
 365
 366     .. note::
 367
 368        The JJB Deploy Job is configured to trigger only if the Gerrit comment
 369        starts with the `jjb-deploy` keyword.
 370
 371        Example of a valid command in Gerrit comment that triggers the job:
 372
 373        ``jjb-deploy builder-jjb-*``
 374
 375        Example of a invalid command in Gerrit comment that would _not_ trigger
 376        the job:
 377
 378        ``Update the job. jjb-deploy builder-jjb-*``
 379
 380        JOB_NAME can include the * wildcard character to push multiple jobs
 381        matching the pattern. For example ``jjb-deploy builder-jjb-*`` will push
 382        all builder-jjb-* jobs to the sandbox system.
 383
 384 :Required parameters:
 385
 386     :build-node: The node to run build on.
 387     :jenkins-ssh-credential: Credential to use for SSH. (Generally
 388         should be configured in defaults.yaml)
 389
 390 :Optional parameters:
 391
 392     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 393     :gerrit_jjb_deploy_job_triggers: Override Gerrit Triggers.
 394
 395
 396 .. _jjb-merge:
 397
 398 JJB Merge
 399 ---------
 400
 401 Runs `jenkins-jobs update` to update production job configuration
 402
 403 :Template Names:
 404     - {project-name}-jjb-merge
 405     - gerrit-jjb-merge
 406     - github-jjb-merge
 407
 408 :Comment Trigger: remerge
 409
 410 :Required parameters:
 411
 412     :build-node: The node to run build on.
 413     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 414         be configured in defaults.yaml)
 415
 416 :Optional parameters:
 417
 418     :branch: Git branch to fetch for the build. (default: master)
 419     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 420     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 421     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 422     :jjb-cache: JJB cache location. (default: $HOME/.cache/jenkins_jobs)
 423     :jjb-workers: Number of threads to run **update** with. Set to 0 by default
 424         which is equivalent to the number of available CPU cores. (default: 0)
 425     :jjb-version: JJB version to install. (default: see job-template)
 426     :stream: Keyword that can be used to represent a release code-name.
 427         Often the same as the branch. (default: master)
 428     :submodule-recursive: Whether to checkout submodules recursively.
 429         (default: true)
 430     :submodule-timeout: Timeout (in minutes) for checkout operation.
 431         (default: 10)
 432     :submodule-disable: Disable submodule checkout operation.
 433         (default: false)
 434
 435     :gerrit_merge_triggers: Override Gerrit Triggers.
 436     :gerrit_trigger_file_paths: Override file paths which can be used to
 437         filter which file modifications will trigger a build.
 438         (default defined by lf_jjb_common)
 439
 440
 441 .. _jjb-verify:
 442
 443 JJB Verify
 444 ----------
 445
 446 Runs `jenkins-jobs test` to validate JJB syntax. Optionally validates
 447 build-node labels used in templates and job definitions.
 448
 449 :Template Names:
 450     - {project-name}-jjb-verify
 451     - gerrit-jjb-verify
 452     - github-jjb-verify
 453
 454 :Comment Trigger: recheck|reverify
 455
 456 :Required parameters:
 457
 458     :build-node: The node to run build on.
 459     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 460         be configured in defaults.yaml)
 461
 462 :Optional parameters:
 463
 464     :branch: Git branch to fetch for the build. (default: master)
 465     :build-concurrent: Whether or not to allow this job to run multiple jobs
 466         simultaneously. (default: true)
 467     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 468     :build-node-label-check: Whether to check build-node labels in jobs
 469         against node names in cloud config files (default: false)
 470     :build-node-label-list: Space-separated list of external build-node
 471         labels not present in cloud config files (default: "")
 472     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 473     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 474     :jjb-cache: JJB cache location. (default: $HOME/.cache/jenkins_jobs)
 475     :jjb-version: JJB version to install. (default: see job-template)
 476     :stream: Keyword that can be used to represent a release code-name.
 477         Often the same as the branch. (default: master)
 478     :submodule-recursive: Whether to checkout submodules recursively.
 479         (default: true)
 480     :submodule-timeout: Timeout (in minutes) for checkout operation.
 481         (default: 10)
 482     :submodule-disable: Disable submodule checkout operation.
 483         (default: false)
 484     :throttle_categories: List of categories to throttle by.
 485     :throttle-enabled: Whether or not to enable throttling on the job.
 486         (default: true)
 487     :throttle-max-per-node: Max jobs to run on the same node. (default: 1)
 488     :throttle-max-total: Max jobs to run across the entire project. - 0
 489         means 'unlimited' (default: 0)
 490     :throttle-option: Throttle by the project or by list of categories
 491         defined in the throttle plugin configuration. (options: 'project',
 492         'category'; default: project)
 493
 494     :gerrit_verify_triggers: Override Gerrit Triggers.
 495     :gerrit_trigger_file_paths: Override file paths which can be used to
 496         filter which file modifications will trigger a build.
 497         (default defined by lf_jjb_common)
 498
 499 .. _jjb-verify-upstream-gjjb:
 500
 501 JJB Verify Upstream Global JJB
 502 ------------------------------
 503
 504 Runs ``jenkins-jobs test`` to validate JJB syntax for upstream global-jjb
 505 patches. This job is useful to notify upstream that they may be breaking
 506 project level jobs.
 507
 508 :Template Names:
 509     - {project-name}-jjb-verify-upstream-gjjb
 510     - gerrit-jjb-verify-upstream-gjjb
 511     - github-jjb-verify-upstream-gjjb
 512
 513 :Comment Trigger: recheck|reverify
 514
 515 :Required parameters:
 516
 517     :build-node: The node to run build on.
 518     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 519         be configured in defaults.yaml)
 520
 521 :Optional parameters:
 522
 523     :branch: Git branch to fetch for the build. (default: master)
 524     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 525     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 526     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 527     :jjb-cache: JJB cache location. (default: $HOME/.cache/jenkins_jobs)
 528     :jjb-version: JJB version to install. (default: see job-template)
 529     :stream: Keyword that can be used to represent a release code-name.
 530         Often the same as the branch. (default: master)
 531
 532 .. _info-yaml-verify:
 533
 534 Info YAML Verify
 535 ----------------
 536
 537 Info YAML Verify job validates that INFO.yaml file changes are kept isolated from
 538 other file changes. Verifies INFO.yaml files follow the schema defined in
 539 `lfit/releng-global-jjb/schema/info-schema.yaml`.
 540
 541 :Template Names:
 542     - {project-name}-info-yaml-verify
 543     - gerrit-info-yaml-verify
 544     - github-info-yaml-verify
 545
 546 :Required parameters:
 547
 548     :build-node: The node to run build on.
 549     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 550         be configured in defaults.yaml)
 551
 552 :Optional parameters:
 553
 554     :branch: Git branch to fetch for the build. (default: master)
 555     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 556     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 557     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 558     :stream: Keyword that can be used to represent a release code-name.
 559         Often the same as the branch. (default: master)
 560     :submodule-recursive: Whether to checkout submodules recursively.
 561         (default: true)
 562     :submodule-timeout: Timeout (in minutes) for checkout operation.
 563         (default: 10)
 564     :submodule-disable: Disable submodule checkout operation.
 565         (default: false)
 566
 567     :gerrit_verify_triggers: Override Gerrit Triggers.
 568
 569 .. _license-checker:
 570
 571 License Checker
 572 ---------------
 573
 574 Job to scan projects for files missing license headers.
 575
 576 :Template Names:
 577     - {project-name}-license-check
 578     - gerrit-license-check
 579     - github-license-check
 580
 581 :Optional parameters:
 582
 583     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 584     :file-patterns: Space-separated list of file patterns to scan.
 585         (default: \*.go \*.groovy \*.java \*.py \*.sh)
 586     :spdx-disable: Disable the SPDX-Identifier checker. (default: false)
 587     :lhc-version: Version of LHC to use. (default: 0.2.0)
 588     :license-exclude-paths: Comma-separated list of paths to exclude from the
 589         license checker. The paths used here will be matched using a contains
 590         rule so it is best to be as precise with the path as possible.
 591         For example a path of '/src/generated/' will be searched as
 592         '**/src/generated/**'.
 593         Example: org/opendaylight/yang/gen,protobuff/messages
 594         (default: '')
 595     :licenses-allowed: Comma-separated list of allowed licenses.
 596         (default: Apache-2.0,EPL-1.0,MIT)
 597     :project-pattern: The ANT based pattern for Gerrit Trigger to choose which
 598         projects to trigger job against. (default: '**')
 599
 600 .. _gjjb-openstack-cron:
 601
 602 OpenStack Cron
 603 --------------
 604
 605 Cron job that runs regularly to perform periodic tasks against OpenStack.
 606
 607 This job requires a Config File Provider file named ``clouds-yaml`` available
 608 containing the credentials for the cloud.
 609
 610 :Template Names:
 611     - {project-name}-openstack-cron
 612     - gerrit-openstack-cron
 613     - github-openstack-cron
 614
 615 :Required parameters:
 616
 617     :build-node: The node to run build on.
 618     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 619         be configured in defaults.yaml)
 620     :jenkins-urls: URLs to Jenkins systems to check for active builds.
 621
 622 :Optional parameters:
 623
 624     :branch: Git branch to fetch for the build. (default: master)
 625     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 626     :build-timeout: Timeout in minutes before aborting build. (default: 90)
 627     :cron: Time when the packer image should be rebuilt (default: @hourly)
 628     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 629     :openstack-cloud: OS_CLOUD setting to pass to openstack client.
 630         (default: vex)
 631     :openstack-image-cleanup: Whether or not to run the image cleanup script.
 632         (default: true)
 633     :openstack-image-cleanup-age: Age in days of image before marking it for
 634         removal. (default: 30)
 635     :openstack-image-protect: Whether or not to run the image protect script.
 636         (default: true)
 637     :openstack-server-cleanup: Whether or not to run the server cleanup script.
 638         (default: true)
 639     :openstack-stack-cleanup: Whether or not to run the stack cleanup script.
 640         (default: true)
 641     :openstack-volume-cleanup: Whether or not to run the volume cleanup script.
 642         (default: true)
 643     :stream: Keyword that can be used to represent a release code-name.
 644         Often the same as the branch. (default: master)
 645     :submodule-recursive: Whether to checkout submodules recursively.
 646         (default: true)
 647     :submodule-timeout: Timeout (in minutes) for checkout operation.
 648         (default: 10)
 649     :submodule-disable: Disable submodule checkout operation.
 650         (default: false)
 651
 652 Minimal Example:
 653
 654 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/openstack-cron-minimal.yaml
 655
 656 Full Example:
 657
 658 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/openstack-cron-full.yaml
 659
 660 .. _gjjb-openstack-update-cloud-image:
 661
 662 OpenStack Update Cloud Image
 663 ----------------------------
 664
 665 This job finds and updates OpenStack cloud images on the ci-management source
 666 repository.
 667
 668 The job is triggered in two ways:
 669
 670 1. When packer merge job completes, the new image name created is passed
 671    down to the job.
 672 2. When the job is triggered manually to update all new images.
 673
 674 When the job is triggered through an upstream packer merge job, this only
 675 generates a change request for the new image built.
 676
 677 When the job is triggered manually, this job finds the latest images on
 678 OpenStack cloud and compares them with the images currently used in the source
 679 ci-management source repository. If the compared images have newer
 680 time stamps are **all** updated through a change request.
 681
 682 This job requires a Jenkins configuration merge and verify job setup and
 683 working on Jenkins.
 684
 685 :Template Names:
 686     - {project-name}-openstack-update-cloud-image
 687     - gerrit-openstack-update-cloud-image
 688     - github-openstack-update-cloud-image
 689
 690 :Required parameters:
 691
 692     :build-node: The node to run build on.
 693     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 694         be configured in defaults.yaml)
 695     :new-image-name: Name of new image name passed from packer merge job or
 696         set to 'all' to update all images. (default: all)
 697
 698 :Optional parameters:
 699
 700     :branch: Git branch to fetch for the build. (default: master)
 701     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 702     :build-timeout: Timeout in minutes before aborting build. (default: 90)
 703     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 704     :openstack-cloud: OS_CLOUD setting to pass to openstack client.
 705         (default: vex)
 706     :stream: Keyword that can be used to represent a release code-name.
 707         Often the same as the branch. (default: master)
 708     :submodule-recursive: Whether to checkout submodules recursively.
 709         (default: true)
 710     :submodule-timeout: Timeout (in minutes) for checkout operation.
 711         (default: 10)
 712     :submodule-disable: Disable submodule checkout operation.
 713         (default: false)
 714     :update-cloud-image: Submit a change request to update new built cloud
 715         image to Jenkins. (default: false)
 716
 717 Minimal Example:
 718
 719 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/openstack-update-cloud-image-minimal.yaml
 720
 721 Full Example:
 722
 723 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/openstack-update-cloud-image-full.yaml
 724
 725
 726 .. _gjjb-packer-merge:
 727
 728 Packer Merge
 729 ------------
 730
 731 Packer Merge job runs `packer build` to build system images in the cloud.
 732
 733 :Template Names:
 734     - {project-name}-packer-merge-{platforms}-{templates}
 735     - gerrit-packer-merge
 736     - github-packer-merge
 737
 738 :Comment Trigger: remerge
 739
 740 :Required parameters:
 741
 742     :build-node: The node to run build on.
 743     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 744         be configured in defaults.yaml)
 745     :mvn-settings: The name of settings file containing credentials for
 746         the project.
 747     :platforms: Platform or distribution to build. Typically json file
 748         found in the packer/vars directory. (Example: centos-7)
 749     :templates: System template to build. Typically a yaml file or shell script
 750         found in the packer/provision directory. (Example: docker)
 751
 752 :Optional parameters:
 753
 754     :cron: Time when the packer image should be rebuilt (default: @monthly)
 755     :branch: Git branch to fetch for the build. (default: master)
 756     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 757     :build-timeout: Timeout in minutes before aborting build. (default: 90)
 758     :gerrit_verify_triggers: Override Gerrit Triggers.
 759     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 760     :openstack: Packer template uses an OpenStack builder (default: true).
 761     :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
 762         (default: vex).
 763     :packer-cloud-settings: Name of settings file containing credentials
 764         for the cloud that packer will build on. (default: packer-cloud-env)
 765     :packer-version: Version of packer to install / use in build. (default: 1.0.2)
 766     :stream: Keyword that can be used to represent a release code-name.
 767         Often the same as the branch. (default: master)
 768     :submodule-recursive: Whether to checkout submodules recursively.
 769         (default: true)
 770     :submodule-timeout: Timeout (in minutes) for checkout operation.
 771         (default: 10)
 772     :submodule-disable: Disable submodule checkout operation.
 773         (default: false)
 774     :update-cloud-image: Submit a change request to update newly built cloud
 775         image to Jenkins. (default: false)
 776
 777
 778 Test an in-progress patch
 779 ^^^^^^^^^^^^^^^^^^^^^^^^^
 780
 781 To test an in-progress patch from a GitHub Pull Request, upload this
 782 job to the :doc:`Jenkins Sandbox <lfdocs:jenkins-sandbox>`. Then when manually
 783 building the job, replace the GERRIT_REFSPEC parameter with the GitHub Pull
 784 Request number of the patch you would like to test.
 785
 786 Example GitHub:
 787
 788 .. code-block:: none
 789
 790    GERRIT_REFSPEC: origin/pr/49/merge
 791
 792
 793 .. _gjjb-packer-verify:
 794
 795 Packer Verify
 796 -------------
 797
 798 Packer Verify job runs `packer validate` to verify packer configuration. The
 799 verify job checks superficial syntax of the template and other files. It does
 800 not attempt to build an image, and cannot detect all possible build issues.
 801
 802 :Template Names:
 803     - {project-name}-packer-verify
 804     - gerrit-packer-verify
 805     - github-packer-verify
 806
 807 :Comment Trigger: recheck|reverify
 808
 809 :Required parameters:
 810
 811     :build-node: The node to run build on.
 812     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 813         be configured in defaults.yaml)
 814     :mvn-settings: The name of settings file containing credentials for
 815         the project.
 816
 817 :Optional parameters:
 818
 819     :branch: Git branch to fetch for the build. (default: master)
 820     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 821     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 822     :gerrit_trigger_file_paths: Override file paths which can be used to
 823         filter which file modifications will trigger a build.
 824     :gerrit_verify_triggers: Override Gerrit Triggers.
 825     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 826     :openstack: Packer template uses an OpenStack builder (default: true).
 827     :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
 828         (default: vex).
 829     :packer-cloud-settings: Name of settings file containing credentials
 830         for the cloud that packer will build on. (default: packer-cloud-env)
 831     :packer-version: Version of packer to install / use in build. (default: 1.0.2)
 832     :stream: Keyword that can be used to represent a release code-name.
 833         Often the same as the branch. (default: master)
 834     :submodule-recursive: Whether to checkout submodules recursively.
 835         (default: true)
 836     :submodule-timeout: Timeout (in minutes) for checkout operation.
 837         (default: 10)
 838     :submodule-disable: Disable submodule checkout operation.
 839         (default: false)
 840
 841
 842 .. _gjjb-packer-verify-build:
 843
 844 Packer Verify Build
 845 -------------------
 846
 847 Packer Verify Build job is essentially the same as the
 848 :ref:`Packer Merge job<gjjb-packer-merge>`. It is triggered only by its keyword,
 849 and will build a useable image. If the last patch set before a merge has a
 850 successful verify build, the merge job will not build the same image.
 851
 852 :Template Names:
 853    - {project-name}-packer-verify-build-{platforms}-{templates}
 854    - gerrit-packer-verify-build
 855    - github-packer-verify-build
 856
 857 :Comment Trigger: verify-build|packer-build
 858
 859 :Required parameters:
 860
 861    :build-node: The node to run build on.
 862    :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 863        be configured in defaults.yaml)
 864    :mvn-settings: The name of settings file containing credentials for
 865        the project.
 866    :platforms: Platform or distribution to build. Typically json file
 867        found in the packer/vars directory. (Example: centos-7)
 868    :templates: System template to build. Typically a yaml file or shell script
 869        found in the packer/provision directory. (Example: docker)
 870
 871 :Optional parameters:
 872
 873    :branch: Git branch to fetch for the build. (default: master)
 874    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 875    :build-timeout: Timeout in minutes before aborting build. (default: 10)
 876    :gerrit_trigger_file_paths: Override file paths which can be used to
 877        filter which file modifications will trigger a build.
 878    :gerrit_verify_triggers: Override Gerrit Triggers.
 879    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 880    :openstack: Packer template uses an OpenStack builder (default: true).
 881    :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
 882        (default: vex).
 883    :packer-cloud-settings: Name of settings file containing credentials
 884        for the cloud that packer will build on. (default: packer-cloud-env)
 885    :packer-version: Version of packer to install / use in build. (default: 1.0.2)
 886    :stream: Keyword that can be used to represent a release code-name.
 887        Often the same as the branch. (default: master)
 888    :submodule-recursive: Whether to checkout submodules recursively.
 889        (default: true)
 890    :submodule-timeout: Timeout (in minutes) for checkout operation.
 891        (default: 10)
 892    :submodule-disable: Disable submodule checkout operation.
 893        (default: false)
 894    :update-cloud-image: Submit a change request to update new built cloud
 895        image to Jenkins. (default: false)
 896
 897
 898 Puppet Verify
 899 -------------
 900
 901 Runs puppet-lint in the ``puppet-dir`` directory. puppet-lint runs recursively,
 902 the base directory is usually the best place to run from.
 903
 904 :Template Names:
 905
 906     - {project-name}-puppet-verify
 907     - gerrit-puppet-verify
 908     - github-puppet-verify
 909
 910 :Comment Trigger: recheck|reverify
 911
 912 :Required Parameters:
 913
 914     :build-node: The node to run build on.
 915     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 916         in defaults.yaml)
 917
 918 :Optional Parameters:
 919
 920     :branch: The branch to build against. (default: master)
 921     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 922     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 923     :gerrit_trigger_file_paths: Override file paths which used to filter which
 924         file modifications will trigger a build. Refer to JJB documentation for
 925         "file-path" details.
 926         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 927     :git-url: URL clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
 928     :puppet-dir: Directory containing the project's puppet module(s) relative
 929         to the workspace.
 930         (default: '')
 931     :puppet-lint-version: Version of puppet-lint to use for testing.
 932         (default: 2.3.6)
 933     :stream: Keyword representing a release code-name.
 934         Often the same as the branch. (default: master)
 935     :submodule-recursive: Whether to checkout submodules recursively.
 936         (default: true)
 937     :submodule-timeout: Timeout (in minutes) for checkout operation.
 938         (default: 10)
 939     :submodule-disable: Disable submodule checkout operation.
 940         (default: false)
 941
 942
 943 Sonar
 944 -----
 945
 946 Runs the Jenkins SonarQube Scanner plug-in to analyze code for bugs,
 947 code smells and security vulnerabilities, and to upload the result
 948 (possibly including code-coverage statistics) to a SonarQube server
 949 or to SonarCloud.io.
 950
 951 Requires ``SonarQube Scanner for Jenkins``
 952
 953 One of the optional parameters sonar-project-file and sonar-properties
 954 must be supplied; they cannot both be empty.
 955
 956 Plug-in configurations
 957     Manage Jenkins --> Configure System --> SonarQube servers
 958         - Name: Sonar (fixed)
 959         - Server URL: https://sonar.server.org/ or https://sonarcloud.io
 960         - Server authentication token: none for local, API token (saved as a
 961           "secret text" credential) for Sonarcloud
 962
 963     Manage Jenkins --> Global Tool Configuration --> SonarQube Scanner
 964         - Name: SonarQube Scanner (fixed)
 965         - Install automatically
 966         - Select latest version
 967
 968 .. note:: Sonar properties can be set directly in the job definition by
 969    setting the sonar-project-file to ``""`` and adding all properties under
 970    ``sonar-properties``.
 971
 972 :Template Names:
 973
 974     - {project-name}-sonar
 975     - gerrit-sonar
 976     - github-sonar
 977
 978 :Optional Parameters:
 979     :sonar-task: Sonar task to run. (default: "")
 980     :sonar-project-file: The filename for the project's properties
 981         (default: "sonar-project.properties")
 982     :sonar-properties: Sonar configuration properties. (default: "")
 983     :sonar-java-opts: JVM options. (default: "")
 984     :sonar-additional-args: Additional command line arguments. (default: "")
 985
 986
 987 Sonar with Prescan
 988 ------------------
 989
 990 The same as the Sonar job above, except the caller also defines a builder
 991 called ``lf-sonar-prescan``, in which they can put any builders that they want
 992 to run prior to the Sonar scan.
 993
 994 .. code-block:: yaml
 995
 996    - builder:
 997        name: lf-sonar-prescan
 998        builders:
 999          - shell: "# Pre-scan shell script"
1000
1001 :Template Names:
1002
1003     - {project-name}-sonar-prescan
1004     - gerrit-sonar-prescan
1005     - github-sonar-prescan
1006
1007 :Required Parameters:
1008     :lf-sonar-prescan: A builder that will run prior to the Sonar scan.
1009
1010 :Optional Parameters:
1011     :sonar-task: Sonar task to run. (default: "")
1012     :sonar-project-file: The filename for the project's properties
1013         (default: "sonar-project.properties")
1014     :sonar-properties: Sonar configuration properties. (default: "")
1015     :sonar-java-opts: JVM options. (default: "")
1016     :sonar-additional-args: Additional command line arguments. (default: "")
1017
1018
1019 Sonar with Prescan Script
1020 -------------------------
1021
1022 The same as the Sonar job above, except the caller must supply a shell script
1023 to run prior to the Sonar scan. This is commonly used to install prerequisites,
1024 build the project, execute unit tests and generate a code-coverage report.
1025
1026 :Template Names:
1027
1028     - {project-name}-sonar-prescan-script
1029     - gerrit-sonar-prescan-script
1030     - github-sonar-prescan-script
1031
1032 :Required Parameters:
1033     :sonar-prescan-script: A shell script that will run prior to the Sonar scan.
1034
1035 :Optional Parameters:
1036     :sonar-task: Sonar task to run. (default: "")
1037     :sonar-project-file: The filename for the project's properties.
1038         (default: "sonar-project.properties")
1039     :sonar-properties: Sonar configuration properties. (default: "")
1040     :sonar-java-opts: JVM options. (default: "")
1041     :sonar-additional-args: Additional command line arguments. (default: "")