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-infra-jjbini-sandbox
  68 -----------------------
  69
  70 Provides jenkins_jobs.ini configuration for Jenkins sandbox.
  71
  72 .. todo:: This needs to be consolidated into lf-infra-jjbini when JJB 2.0 is available
  73
  74 lf-packer-common
  75 ----------------
  76
  77 Common packer configuration.
  78
  79 lf-packer-file-paths
  80 --------------------
  81
  82 Gerrit file-paths for packer jobs.
  83
  84 lf-packer-parameters
  85 --------------------
  86
  87 Parameters useful for packer related tasks.
  88
  89 :Parameters:
  90
  91     :packer-version: Version of packer to install / use.
  92         (shell: PACKER_VERSION)
  93
  94 lf-packer-verify-file-paths
  95 ---------------------------
  96
  97 Gerrit file-paths for packer verify jobs.
  98
  99 Job Templates
 100 =============
 101
 102 .. _gerrit-branch-lock:
 103
 104 Gerrit Branch Lock
 105 ------------------
 106
 107 Job submits a patch to lock or unlock a project's branch.
 108
 109 :Template Names:
 110     - {project-name}-gerrit-branch-lock-{stream}
 111     - gerrit-branch-lock
 112
 113 :Comment Trigger:
 114
 115     * lock branch
 116     * unlock branch
 117
 118 :Required parameters:
 119
 120     :build-node: The node to run build on.
 121     :jenkins-ssh-credential: Credential to use for SSH. (Generally
 122         should be configured in defaults.yaml)
 123
 124 :Optional parameters:
 125
 126     :branch: Git branch to build against. (default: master)
 127     :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
 128     :stream: Keyword that can be used to represent a release code-name.
 129         Often the same as the branch. (default: master)
 130     :submodule-timeout: Timeout (in minutes) for checkout operation.
 131         (default: 10)
 132     :gerrit_merge_triggers: Override Gerrit Triggers.
 133
 134 .. _lf-global-jjb-jenkins-cfg-merge:
 135
 136 Jenkins Configuration Merge
 137 ---------------------------
 138
 139 Jenkins job to manage Global Jenkins configuration.
 140
 141 .. note::
 142
 143    Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
 144    config definitions for "production" and "sandbox" systems.
 145
 146 :Template names:
 147
 148     - {project-name}-jenkins-cfg-merge
 149     - gerrit-jenkins-cfg-merge
 150     - github-jenkins-cfg-merge
 151
 152 :Optional parameters:
 153
 154     :branch: Git branch to build against. (default: master)
 155     :cron: How often to run the job on a cron schedule. (default: @daily)
 156     :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
 157     :jenkins-silos: Space separated list of Jenkins silos to update
 158         configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
 159         (default: production sandbox)
 160
 161 Typically this template is automatically pulled in by the
 162 "{project-name}-ci-jobs" job-group and does not need to be explicitly called if
 163 the job group is being used.
 164
 165 Minimal Example:
 166
 167 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-minimal.yaml
 168    :language: yaml
 169
 170 Full Example:
 171
 172 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-full.yaml
 173    :language: yaml
 174
 175 .. _jenkins-cfg-envvar:
 176
 177 Global Environment Variables
 178 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 179
 180 Global Environment Variables are managed via the
 181 ``jenkins-config/global-vars-SILO.sh`` file in ci-management. Replace SILO with
 182 the name of the Jenkins silo the variable configuration is for.
 183
 184 The format for this file is ``KEY=value`` for example::
 185
 186     GERRIT_URL=https://git.opendaylight.org/gerrit
 187     GIT_BASE=git://devvexx.opendaylight.org/mirror/$PROJECT
 188     GIT_URL=git://devvexx.opendaylight.org/mirror
 189     JENKINS_HOSTNAME=vex-yul-odl-jenkins-2
 190     LOGS_SERVER=https://logs.opendaylight.org
 191     NEXUS_URL=https://nexus.opendaylight.org
 192     ODLNEXUSPROXY=https://nexus.opendaylight.org
 193     SILO=sandbox
 194     SONAR_URL=https://sonar.opendaylight.org
 195
 196 Cloud Configuration
 197 ^^^^^^^^^^^^^^^^^^^
 198
 199 This configuration requires the OpenStack Cloud plugin in Jenkins and is
 200 currently the only cloud plugin supported.
 201
 202 OpenStack Cloud plugin version supported:
 203
 204 * 2.30 - 2.34
 205 * 2.35 - 2.37
 206
 207 Cloud configuration are managed via a directory structure in ci-management as
 208 follows:
 209
 210 - jenkins-config/clouds/openstack/
 211 - jenkins-config/clouds/openstack/cattle/cloud.cfg
 212 - jenkins-config/clouds/openstack/cattle/centos7-builder-2c-2g.cfg
 213 - jenkins-config/clouds/openstack/cattle/centos7-builder-4c-4g.cfg
 214 - jenkins-config/clouds/openstack/cattle/centos7-docker-4c-4g.cfg
 215
 216 The directory name inside of the "openstack" directory is used as the name of
 217 the cloud configuration. In this case "cattle" is being used as the cloud name.
 218
 219 The ``cloud.cfg`` file is a special file used to configure the main cloud
 220 configuration in the format ``KEY=value``.
 221
 222 :Cloud Parameters:
 223
 224     :CLOUD_URL: API endpoint URL for Keystone.
 225         (default: "")
 226     :CLOUD_IGNORE_SSL: Ignore unverified SSL certificates. (default: false)
 227     :CLOUD_ZONE: OpenStack region to use. (default: "")
 228     :CLOUD_CREDENTIAL_ID: Credential to use for authentication to OpenStack.
 229         (default: "os-cloud")
 230     :INSTANCE_CAP: Total number of instances the cloud will allow spin up.
 231         (default: null)
 232     :SANDBOX_CAP: Total number of instances the cloud will allow to
 233         spin up. This applies to "sandbox" systems and overrides the
 234         INSTANCE_CAP setting. (default: null)
 235
 236 :Template Parameters:
 237
 238     .. note::
 239
 240        In the case of template definitions of a parameter below is not passed
 241        the one defined in default clouds will be inherited.
 242
 243     :IMAGE_NAME: The image name to use for this template.
 244         (required)
 245     :HARDWARE_ID: OpenStack flavor to use. (required)
 246
 247     :LABELS: Labels to assign to the vm. (default: FILE_NAME)
 248     :NETWORK_ID: OpenStack network to use. (default: "")
 249     :USER_DATA_ID: User Data to pass into the instance.
 250         (default: jenkins-init-script)
 251     :INSTANCE_CAP: Total number of instances of this type that can be launched
 252         at one time. When defined in clouds.cfg it defines the total for the
 253         entire cloud. (default: null)
 254     :SANDBOX_CAP: Total number of instances of this type that can be launched
 255         at one time. When defined in clouds.cfg it defines the total for the
 256         entire cloud. This applies to "sandbox" systems and overrides the
 257         INSTANCE_CAP setting. (default: null)
 258     :FLOATING_IP_POOL: Floating ip pool to use. (default: "")
 259     :SECURITY_GROUPS: Security group to use. (default: "default")
 260     :AVAILABILITY_ZONE: OpenStack availability zone to use. (default: "")
 261     :START_TIMEOUT: Number of milliseconds to wait for the agent to be
 262         provisioned and connected. (default: 600000)
 263     :KEY_PAIR_NAME: SSH Public Key Pair to use for authentication.
 264         (default: jenkins)
 265     :NUM_EXECUTORS: Number of executors to enable for the instance.
 266         (default: 1)
 267     :JVM_OPTIONS: JVM Options to pass to Java. (default: "")
 268     :FS_ROOT: File system root for the workspace. (default: "/w")
 269     :RETENTION_TIME: Number of minutes to wait for an idle slave to be used
 270         again before it's removed. If set to -1, the slave will be kept
 271         forever. (default: 0)
 272     :CONNECTION_TYPE: The connection type for Jenkins to connect to the build
 273         minion. Valid options: JNLP, SSH. (default: "SSH")
 274
 275 For a live example see the OpenDaylight project jenkins-config directory.
 276 https://github.com/opendaylight/releng-builder/tree/master/jenkins-config
 277
 278 Troubleshooting
 279 ^^^^^^^^^^^^^^^
 280
 281 :Cloud Configuration:
 282
 283     The directory ``groovy-inserts`` contains the groovy script output that is
 284     used to push to Jenkins. In the event of a job failure this file can be
 285     inspected.
 286
 287  .. _lf-global-jjb-jenkins-cfg-verify:
 288
 289 Jenkins Configuration Verify
 290 ----------------------------
 291
 292 Jenkins job to verify the Global Jenkins configuration.
 293
 294 Requires the ``clouds-yaml`` file to be setup on the Jenkins host.
 295
 296 :Template names:
 297
 298     - {project-name}-jenkins-cfg-verify
 299     - gerrit-jenkins-cfg-verify
 300     - github-jenkins-cfg-verify
 301
 302 :Optional parameters:
 303
 304     :branch: Git branch to build against. (default: master)
 305     :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
 306
 307 This job is not part of the "{project-name}-ci-jobs" group. It must be called
 308 explicitly.
 309
 310 Example:
 311
 312 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-verify.yaml
 313    :language: yaml
 314
 315
 316 .. _jenkins-sandbox-cleanup:
 317
 318 Jenkins Sandbox Cleanup
 319 -----------------------
 320
 321 Cleanup Jenkins Sandbox of jobs and views periodically.
 322
 323 :Template names:
 324
 325     - {project-name}-jenkins-sandbox-cleanup
 326     - gerrit-jenkins-sandbox-cleanup
 327     - github-jenkins-sandbox-cleanup
 328
 329 :Comment Trigger: NONE
 330
 331 :Required parameters:
 332
 333     :build-node: The node to run build on.
 334     :jenkins-ssh-credential: Credential to use for SSH. (Generally
 335         should be configured in defaults.yaml)
 336
 337 :Optional parameters:
 338
 339     :cron: Schedule to run job. (default: '0 8 * * 6')
 340
 341
 342 .. _jjb-deploy:
 343
 344 JJB Deploy Job
 345 --------------
 346
 347 Deploy jobs to jenkins-sandbox system via code review comment.
 348
 349 This job checks out the current code review patch and then runs a
 350 ``jenkins-jobs update`` to push a patch defined by the comment.
 351
 352 :Template names:
 353
 354     - {project-name}-jjb-deploy-job
 355     - gerrit-jjb-deploy-job
 356     - github-jjb-deploy-job
 357
 358 :Comment Trigger: jjb-deploy JOB_NAME
 359
 360     .. note::
 361
 362        JOB_NAME can include the * wildcard character to push multiple jobs
 363        matching the pattern. For example ``jjb-deploy builder-jjb-*`` will push
 364        all builder-jjb-* jobs to the sandbox system.
 365
 366 :Required parameters:
 367
 368     :build-node: The node to run build on.
 369     :jenkins-ssh-credential: Credential to use for SSH. (Generally
 370         should be configured in defaults.yaml)
 371
 372 :Optional parameters:
 373
 374     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 375     :gerrit_jjb_deploy_job_triggers: Override Gerrit Triggers.
 376
 377
 378 .. _jjb-merge:
 379
 380 JJB Merge
 381 ---------
 382
 383 Runs `jenkins-jobs update` to update production job configuration
 384
 385 :Template Names:
 386     - {project-name}-jjb-merge
 387     - gerrit-jjb-merge
 388     - github-jjb-merge
 389
 390 :Comment Trigger: remerge
 391
 392 :Required parameters:
 393
 394     :build-node: The node to run build on.
 395     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 396         be configured in defaults.yaml)
 397
 398 :Optional parameters:
 399
 400     :branch: Git branch to fetch for the build. (default: master)
 401     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 402     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 403     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 404     :jjb-cache: JJB cache location. (default: $HOME/.cache/jenkins_jobs)
 405     :jjb-version: JJB version to install. (default: see job-template)
 406     :stream: Keyword that can be used to represent a release code-name.
 407         Often the same as the branch. (default: master)
 408     :submodule-recursive: Whether to checkout submodules recursively.
 409         (default: true)
 410     :submodule-timeout: Timeout (in minutes) for checkout operation.
 411         (default: 10)
 412
 413     :gerrit_merge_triggers: Override Gerrit Triggers.
 414     :gerrit_trigger_file_paths: Override file paths which can be used to
 415         filter which file modifications will trigger a build.
 416         (default defined by lf_jjb_common)
 417
 418
 419 .. _jjb-verify:
 420
 421 JJB Verify
 422 ----------
 423
 424 Runs `jenkins-jobs test` to validate JJB syntax
 425
 426 :Template Names:
 427     - {project-name}-jjb-verify
 428     - gerrit-jjb-verify
 429     - github-jjb-verify
 430
 431 :Comment Trigger: recheck|reverify
 432
 433 :Required parameters:
 434
 435     :build-node: The node to run build on.
 436     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 437         be configured in defaults.yaml)
 438
 439 :Optional parameters:
 440
 441     :branch: Git branch to fetch for the build. (default: master)
 442     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 443     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 444     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 445     :jjb-cache: JJB cache location. (default: $HOME/.cache/jenkins_jobs)
 446     :jjb-version: JJB version to install. (default: see job-template)
 447     :stream: Keyword that can be used to represent a release code-name.
 448         Often the same as the branch. (default: master)
 449     :submodule-recursive: Whether to checkout submodules recursively.
 450         (default: true)
 451     :submodule-timeout: Timeout (in minutes) for checkout operation.
 452         (default: 10)
 453
 454     :gerrit_verify_triggers: Override Gerrit Triggers.
 455     :gerrit_trigger_file_paths: Override file paths which can be used to
 456         filter which file modifications will trigger a build.
 457         (default defined by lf_jjb_common)
 458
 459 .. _jjb-verify-upstream-gjjb:
 460
 461 JJB Verify Upstream Global JJB
 462 ------------------------------
 463
 464 Runs ``jenkins-jobs test`` to validate JJB syntax for upstream global-jjb
 465 patches. This job is useful to notify upstream that they may be breaking
 466 project level jobs.
 467
 468 :Template Names:
 469     - {project-name}-jjb-verify-upstream-gjjb
 470     - gerrit-jjb-verify-upstream-gjjb
 471
 472 :Comment Trigger: recheck|reverify
 473
 474 :Required parameters:
 475
 476     :build-node: The node to run build on.
 477     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 478         be configured in defaults.yaml)
 479
 480 :Optional parameters:
 481
 482     :branch: Git branch to fetch for the build. (default: master)
 483     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 484     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 485     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 486     :jjb-cache: JJB cache location. (default: $HOME/.cache/jenkins_jobs)
 487     :jjb-version: JJB version to install. (default: see job-template)
 488     :stream: Keyword that can be used to represent a release code-name.
 489         Often the same as the branch. (default: master)
 490
 491 .. _info-yaml-verify:
 492
 493 Info YAML Verify
 494 ----------------
 495
 496 Info YAML Verify job validates that INFO.yaml file changes are kept isolated from
 497 other file changes. Verifies INFO.yaml files follow the schema defined in
 498 `global-jjb/info-schema`.
 499
 500 :Template Names:
 501     - {project-name}-info-yaml-verify
 502     - gerrit-info-yaml-verify
 503     - github-info-yaml-verify
 504
 505 :Required parameters:
 506
 507     :build-node: The node to run build on.
 508     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 509         be configured in defaults.yaml)
 510
 511 :Optional parameters:
 512
 513     :branch: Git branch to fetch for the build. (default: master)
 514     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 515     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 516     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 517     :stream: Keyword that can be used to represent a release code-name.
 518         Often the same as the branch. (default: master)
 519     :submodule-recursive: Whether to checkout submodules recursively.
 520         (default: true)
 521     :submodule-timeout: Timeout (in minutes) for checkout operation.
 522         (default: 10)
 523
 524     :gerrit_verify_triggers: Override Gerrit Triggers.
 525
 526 .. _license-checker:
 527
 528 License Checker
 529 ---------------
 530
 531 Job to scan projects for files missing license headers.
 532
 533 :Template Names:
 534     - {project-name}-license-check
 535     - gerrit-license-check
 536     - github-license-check
 537
 538 :Optional parameters:
 539
 540     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 541     :file-patterns: Space-separated list of file patterns to scan.
 542         (default: \*.go \*.groovy \*.java \*.py \*.sh)
 543     :spdx-disable: Disable the SPDX-Identifier checker. (default: false)
 544     :lhc-version: Version of LHC to use. (default: 0.2.0)
 545     :license-exclude-paths: Comma-separated list of paths to exclude from the
 546         license checker. The paths used here will be matched using a contains
 547         rule so it is best to be as precise with the path as possible.
 548         For example a path of '/src/generated/' will be searched as
 549         '**/src/generated/**'.
 550         Example: org/opendaylight/yang/gen,protobuff/messages
 551         (default: '')
 552     :licenses-allowed: Comma-separated list of allowed licenses.
 553         (default: Apache-2.0,EPL-1.0,MIT)
 554     :project-pattern: The ANT based pattern for Gerrit Trigger to choose which
 555         projects to trigger job against. (default: '**')
 556
 557 .. _gjjb-openstack-cron:
 558
 559 OpenStack Cron
 560 --------------
 561
 562 Cron job that runs regularly to perform periodic tasks against OpenStack.
 563
 564 This job requires a Config File Provider file named ``clouds-yaml`` available
 565 containing the credentials for the cloud.
 566
 567 :Template Names:
 568     - {project-name}-openstack-cron
 569     - gerrit-openstack-cron
 570     - github-openstack-cron
 571
 572 :Required parameters:
 573
 574     :build-node: The node to run build on.
 575     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 576         be configured in defaults.yaml)
 577     :jenkins-urls: URLs to Jenkins systems to check for active builds.
 578
 579 :Optional parameters:
 580
 581     :branch: Git branch to fetch for the build. (default: master)
 582     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 583     :build-timeout: Timeout in minutes before aborting build. (default: 90)
 584     :cron: Time when the packer image should be rebuilt (default: @hourly)
 585     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 586     :openstack-cloud: OS_CLOUD setting to pass to openstack client.
 587         (default: vex)
 588     :openstack-image-cleanup: Whether or not to run the image cleanup script.
 589         (default: true)
 590     :openstack-image-cleanup-age: Age in days of image before marking it for
 591         removal. (default: 30)
 592     :openstack-image-protect: Whether or not to run the image protect script.
 593         (default: true)
 594     :openstack-server-cleanup: Whether or not to run the server cleanup script.
 595         (default: true)
 596     :openstack-stack-cleanup: Whether or not to run the stack cleanup script.
 597         (default: true)
 598     :openstack-volume-cleanup: Whether or not to run the volume cleanup script.
 599         (default: true)
 600     :stream: Keyword that can be used to represent a release code-name.
 601         Often the same as the branch. (default: master)
 602     :submodule-recursive: Whether to checkout submodules recursively.
 603         (default: true)
 604     :submodule-timeout: Timeout (in minutes) for checkout operation.
 605         (default: 10)
 606
 607 Minimal Example:
 608
 609 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/openstack-cron-minimal.yaml
 610
 611 Full Example:
 612
 613 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/openstack-cron-full.yaml
 614
 615
 616 .. _gjjb-packer-merge:
 617
 618 Packer Merge
 619 ------------
 620
 621 Packer Merge job runs `packer build` to build system images in the cloud.
 622
 623 :Template Names:
 624     - {project-name}-packer-merge-{platforms}-{templates}
 625     - gerrit-packer-merge
 626     - github-packer-merge
 627
 628 :Comment Trigger: remerge
 629
 630 :Required parameters:
 631
 632     :build-node: The node to run build on.
 633     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 634         be configured in defaults.yaml)
 635     :mvn-settings: The name of settings file containing credentials for
 636         the project.
 637     :platforms: Platform or distribution to build. Typically json file
 638         found in the packer/vars directory. (Example: centos)
 639     :template: System template to build. Typically shell script found in
 640         the packer/provision directory. (Example: java-builder)
 641
 642 :Optional parameters:
 643
 644     :cron: Time when the packer image should be rebuilt (default: @monthly)
 645     :branch: Git branch to fetch for the build. (default: master)
 646     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 647     :build-timeout: Timeout in minutes before aborting build. (default: 90)
 648     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 649     :openstack: Packer template uses an OpenStack builder (default: true).
 650     :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
 651         (default: vex).
 652     :packer-cloud-settings: Name of settings file containing credentials
 653         for the cloud that packer will build on. (default: packer-cloud-env)
 654     :packer-version: Version of packer to install / use in build. (default: 1.0.2)
 655     :stream: Keyword that can be used to represent a release code-name.
 656         Often the same as the branch. (default: master)
 657     :submodule-recursive: Whether to checkout submodules recursively.
 658         (default: true)
 659     :submodule-timeout: Timeout (in minutes) for checkout operation.
 660         (default: 10)
 661
 662     :gerrit_verify_triggers: Override Gerrit Triggers.
 663
 664 Test an in-progress patch
 665 ^^^^^^^^^^^^^^^^^^^^^^^^^
 666
 667 To test an in-progress patch from a GitHub Pull Request. Upload this
 668 job to the :doc:`Jenkins Sandbox <lfdocs:jenkins-sandbox>`. Then when manually
 669 building the job replace the GERRIT_REFSPEC parameter with the GitHub Pull
 670 Request number of the patch you would like to test.
 671
 672 Example GitHub:
 673
 674 .. code-block:: none
 675
 676    GERRIT_REFSPEC: origin/pr/49/merge
 677
 678 .. _gjjb-packer-verify:
 679
 680 Packer Verify
 681 -------------
 682
 683 Packer Verify job runs `packer validate` to verify packer configuration.
 684
 685 :Template Names:
 686     - {project-name}-packer-verify
 687     - gerrit-packer-verify
 688     - github-packer-verify
 689
 690 :Comment Trigger: recheck|reverify
 691
 692 :Required parameters:
 693
 694     :build-node: The node to run build on.
 695     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 696         be configured in defaults.yaml)
 697     :mvn-settings: The name of settings file containing credentials for
 698         the project.
 699
 700 :Optional parameters:
 701
 702     :branch: Git branch to fetch for the build. (default: master)
 703     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 704     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 705     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 706     :openstack: Packer template uses an OpenStack builder (default: true).
 707     :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
 708         (default: vex).
 709     :packer-cloud-settings: Name of settings file containing credentials
 710         for the cloud that packer will build on. (default: packer-cloud-env)
 711     :packer-version: Version of packer to install / use in build. (default: 1.0.2)
 712     :stream: Keyword that can be used to represent a release code-name.
 713         Often the same as the branch. (default: master)
 714     :submodule-recursive: Whether to checkout submodules recursively.
 715         (default: true)
 716     :submodule-timeout: Timeout (in minutes) for checkout operation.
 717         (default: 10)
 718
 719     :gerrit_verify_triggers: Override Gerrit Triggers.
 720     :gerrit_trigger_file_paths: Override file paths which can be used to
 721         filter which file modifications will trigger a build.