docs/jjb/lf-ci-jobs.rst

   1 #######
   2 CI Jobs
   3 #######
   4
   5 Job Groups
   6 ==========
   7
   8 {project-name}-ci-jobs
   9 ----------------------
  10
  11 Recommended jobs that should be deployed for CI using Gerrit.
  12
  13 :Includes:
  14
  15     - gerrit-jenkins-cfg-merge
  16     - gerrit-jjb-deploy-job
  17     - gerrit-jjb-merge
  18     - gerrit-jjb-verify
  19
  20 {project-name}-github-ci-jobs
  21 -----------------------------
  22
  23 Recommended jobs that should be deployed CI using GitHub.
  24
  25 :Includes:
  26
  27     - github-jenkins-cfg-merge
  28     - github-jjb-deploy-job
  29     - github-jjb-merge
  30     - github-jjb-verify
  31
  32 {project-name}-packer-jobs
  33 --------------------------
  34
  35 Jobs related to Packer builds for CI using Gerrit.
  36
  37 :Includes:
  38
  39     - gerrit-packer-merge
  40     - gerrit-packer-verify
  41
  42 {project-name}-github-packer-jobs
  43 ---------------------------------
  44
  45 Jobs related to Packer builds for CI using GitHub.
  46
  47 :Includes:
  48
  49     - github-packer-merge
  50     - github-packer-verify
  51
  52 Macros
  53 ======
  54
  55 lf-jenkins-cfg-global-vars
  56 --------------------------
  57
  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.
  61
  62 .. note::
  63
  64    Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
  65    config definitions for "production" and "sandbox" systems.
  66
  67 :Required parameters:
  68
  69     :jenkins-silos: Space separated list of Jenkins silos to update
  70         configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
  71
  72 lf-infra-jjbini
  73 ---------------
  74
  75 Provides jenkins_jobs.ini configuration for Jenkins.
  76
  77 lf-infra-jjbini-sandbox
  78 -----------------------
  79
  80 Provides jenkins_jobs.ini configuration for Jenkins sandbox.
  81
  82 .. todo:: This needs to be consolidated into lf-infra-jjbini when JJB 2.0 is available
  83
  84 lf-packer-verify-file-paths
  85 ---------------------------
  86
  87 Gerrit file-paths for packer verify jobs.
  88
  89 lf-packer-file-paths
  90 --------------------
  91
  92 Gerrit file-paths for packer jobs.
  93
  94 lf-packer-common
  95 ----------------
  96
  97 Common packer configuration.
  98
  99 Job Templates
 100 =============
 101
 102 Gerrit Branch Lock
 103 ------------------
 104
 105 Job submits a patch to lock or unlock a project's branch.
 106
 107 :Template Names:
 108     - {project-name}-gerrit-branch-lock-{stream}
 109     - gerrit-branch-lock
 110
 111
 112 .. _lf-global-jjb-jenkins-cfg-merge:
 113
 114 Jenkins Configuration Merge
 115 ---------------------------
 116
 117 Jenkins job to manage Global Jenkins configuration.
 118
 119 .. note::
 120
 121    Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
 122    config definitions for "production" and "sandbox" systems.
 123
 124 :Template names:
 125
 126     - {project-name}-jenkins-cfg-merge
 127     - gerrit-jenkins-cfg-merge
 128     - github-jenkins-cfg-merge
 129
 130 :Optional parameters:
 131
 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)
 138
 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.
 142
 143 Miniaml Example:
 144
 145 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-minimal.yaml
 146    :language: yaml
 147
 148 Full Example:
 149
 150 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-full.yaml
 151    :language: yaml
 152
 153 Global Environment Variables
 154 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 155
 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.
 159
 160 The format for this file is ``KEY=value`` for example::
 161
 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
 169     SILO=sandbox
 170     SONAR_URL=https://sonar.opendaylight.org
 171
 172 Cloud Configuration
 173 ^^^^^^^^^^^^^^^^^^^
 174
 175 This configuration requires the OpenStack Cloud plugin in Jenkins and is
 176 currently the only cloud plugin supported.
 177
 178 OpenStack Cloud plugin version supported:
 179
 180 * 2.30
 181 * 2.31
 182
 183 Cloud configuration are managed via a directory structure in ci-management as
 184 follows:
 185
 186 - jenkins-config/clouds/openstack/
 187 - jenkins-config/clouds/openstack/cattle/cloud.cfg
 188 - jenkins-config/clouds/openstack/cattle/centos7-builder-2c-2g.cfg
 189 - jenkins-config/clouds/openstack/cattle/centos7-builder-4c-4g.cfg
 190 - jenkins-config/clouds/openstack/cattle/centos7-docker-4c-4g.cfg
 191
 192 The directory name inside of the "openstack" directory is used as the name of
 193 the cloud configuration. In this case "cattle" is being used as the cloud name.
 194
 195 The ``cloud.cfg`` file is a special file used to configure the main cloud
 196 configuration in the format ``KEY=value``.
 197
 198 :Cloud Parameters:
 199
 200     :CLOUD_URL: API endpoint URL for Keystone.
 201         (default: "")
 202     :CLOUD_IGNORE_SSL: Ignore unverified SSL certificates. (default: false)
 203     :CLOUD_ZONE: OpenStack region to use. (default: "")
 204     :CLOUD_CREDENTIAL_ID: Credential to use for authentication to OpenStack.
 205         (default: "os-cloud")
 206     :INSTANCE_CAP: Total number of instances the cloud will allow spin up.
 207         (default: null)
 208     :SANDBOX_CAP: Total number of instances the clodu will allow to
 209         spin up. This applies to "sandbox" systems and overrides the
 210         INSTANCE_CAP setting. (default: null)
 211
 212 :Template Parameters:
 213
 214     .. note::
 215
 216        In the case of template definitions of a parameter below is not passed
 217        the one defined in default clouds will be inherited.
 218
 219     :IMAGE_NAME: The image name to use for this template.
 220         (default: "")
 221     :LABELS: Labels to assign to the vm. (default: FILE_NAME)
 222     :HARDWARE_ID: OpenStack flavor to use. (default: "")
 223     :NETWORK_ID: OpenStack network to use. (default: "")
 224     :USER_DATA_ID: User Data to pass into the instance.
 225         (default: jenkins-init-script)
 226     :INSTANCE_CAP: Total number of instances of this type that can be launched
 227         at one time. When defined in clouds.cfg it defines the total for the
 228         entire cloud. (default: null)
 229     :SANDBOX_CAP: Total number of instances of this type that can be launched
 230         at one time. When defined in clouds.cfg it defines the total for the
 231         entire cloud. This applies to "sandbox" systems and overrides the
 232         INSTANCE_CAP setting. (default: null)
 233     :FLOATING_IP_POOL: Floating ip pool to use. (default: "")
 234     :SECURITY_GROUPS: Security group to use. (default: "default")
 235     :AVAILABILITY_ZONE: OpenStack availability zone to use. (default: "")
 236     :START_TIMEOUT: Number of milliseconds to wait for the agent to be
 237         provisioned and connected. (default: 600000)
 238     :KEY_PAIR_NAME: SSH Public Key Pair to use for authentication.
 239         (default: jenkins)
 240     :NUM_EXECUTORS: Number of executors to enable for the instance.
 241         (default: 1)
 242     :JVM_OPTIONS: JVM Options to pass to Java. (default: "")
 243     :FS_ROOT: File system root for the workspace. (default: "/w")
 244     :RETENTION_TIME: Number of minutes to wait for an idle slave to be used
 245         again before it's removed. If set to -1, the slave will be kept
 246         forever. (default: 0)
 247
 248 For a live example see the OpenDaylight project jenkins-config directory.
 249 https://github.com/opendaylight/releng-builder/tree/master/jenkins-config
 250
 251 Troubleshooting
 252 ^^^^^^^^^^^^^^^
 253
 254 :Cloud Configuration:
 255
 256     The directory ``groovy-inserts`` contains the groovy script output that is
 257     used to push to Jenkins. In the event of a job failure this file can be
 258     inspected.
 259
 260
 261 JJB Deploy Job
 262 --------------
 263
 264 Deploy jobs to jenkins-sandbox system via code review comment
 265
 266 This job checks out the current code review patch and then runs a
 267 `jenkins-jobs update` to push a patch defined by the comment.
 268
 269 :Template names:
 270
 271     - {project-name}-jjb-deploy-job
 272     - gerrit-jjb-deploy-job
 273     - github-jjb-deploy-job
 274
 275 :Comment Trigger: jjb-deploy JOB_NAME
 276
 277     .. note::
 278
 279        JOB_NAME can include the * wildcard character to push multiple jobs
 280        matching the pattern. For example `jjb-deploy builder-jjb-*`` will push
 281        all builder-jjb-* jobs to the sandbox system.
 282
 283 :Required parameters:
 284
 285     :build-node: The node to run build on.
 286     :jenkins-ssh-credential: Credential to use for SSH. (Generally
 287         should be configured in defaults.yaml)
 288
 289 :Optional parameters:
 290
 291     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 292     :gerrit_jjb_deploy_job_triggers: Override Gerrit Triggers.
 293
 294
 295 JJB Merge
 296 ---------
 297
 298 Runs `jenkins-jobs update` to update production job configuration
 299
 300 :Template Names:
 301     - {project-name}-jjb-merge
 302     - gerrit-jjb-merge
 303     - github-jjb-merge
 304
 305 :Required parameters:
 306
 307     :build-node: The node to run build on.
 308     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 309         be configured in defaults.yaml)
 310     :mvn-settings: The name of settings file containing credentials for
 311         the project.
 312
 313 :Optional parameters:
 314
 315     :branch: Git branch to fetch for the build. (default: master)
 316     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 317     :build-timeout: Timeout in seconds before aborting build. (default: 10)
 318     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 319     :stream: Keyword that can be used to represent a release code-name.
 320         Often the same as the branch. (default: master)
 321     :submodule-recursive: Whether to checkout submodules recursively.
 322         (default: true)
 323
 324     :gerrit_merge_triggers: Override Gerrit Triggers.
 325     :gerrit_trigger_file_paths: Override file paths which can be used to
 326         filter which file modifications will trigger a build.
 327         (default defined by lf_jjb_common)
 328
 329
 330 JJB Verify
 331 ----------
 332
 333 Runs `jenkins-jobs test` to validate JJB syntax
 334
 335 :Template Names:
 336     - {project-name}-jjb-verify
 337     - gerrit-jjb-verify
 338     - github-jjb-verify
 339
 340 :Required parameters:
 341
 342     :build-node: The node to run build on.
 343     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 344         be configured in defaults.yaml)
 345     :mvn-settings: The name of settings file containing credentials for
 346         the project.
 347
 348 :Optional parameters:
 349
 350     :branch: Git branch to fetch for the build. (default: master)
 351     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 352     :build-timeout: Timeout in seconds before aborting build. (default: 10)
 353     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 354     :stream: Keyword that can be used to represent a release code-name.
 355         Often the same as the branch. (default: master)
 356     :submodule-recursive: Whether to checkout submodules recursively.
 357         (default: true)
 358
 359     :gerrit_verify_triggers: Override Gerrit Triggers.
 360     :gerrit_trigger_file_paths: Override file paths which can be used to
 361         filter which file modifications will trigger a build.
 362         (default defined by lf_jjb_common)
 363
 364
 365 Packer Merge
 366 ------------
 367
 368 Packer Merge job runs `packer build` to build system images in the cloud.
 369
 370 :Template Names:
 371     - {project-name}-packer-merge-{platforms}-{templates}
 372     - gerrit-packer-merge
 373     - github-packer-merge
 374
 375 :Required parameters:
 376
 377     :build-node: The node to run build on.
 378     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 379         be configured in defaults.yaml)
 380     :mvn-settings: The name of settings file containing credentials for
 381         the project.
 382     :platforms: Platform or distribution to build. Typically json file
 383         found in the packer/vars directory. (Example: centos)
 384     :template: System template to build. Typically shell script found in
 385         the packer/provision directory. (Example: java-builder)
 386
 387 :Optional parameters:
 388
 389     :branch: Git branch to fetch for the build. (default: master)
 390     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 391     :build-timeout: Timeout in seconds before aborting build. (default: 10)
 392     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 393     :packer-cloud-settings: Name of settings file containing credentials
 394         for the cloud that packer will build on. (default: packer-cloud-env)
 395     :packer-version: Version of packer to install / use in build. (default: 1.0.2)
 396     :stream: Keyword that can be used to represent a release code-name.
 397         Often the same as the branch. (default: master)
 398     :submodule-recursive: Whether to checkout submodules recursively.
 399         (default: true)
 400
 401     :gerrit_verify_triggers: Override Gerrit Triggers.
 402
 403
 404 Packer Verify
 405 -------------
 406
 407 Packer Verify job runs `packer validate` to verify packer configuration.
 408
 409 :Template Names:
 410     - {project-name}-packer-verify
 411     - gerrit-packer-verify
 412     - github-packer-verify
 413
 414 :Required parameters:
 415
 416     :build-node: The node to run build on.
 417     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 418         be configured in defaults.yaml)
 419     :mvn-settings: The name of settings file containing credentials for
 420         the project.
 421
 422 :Optional parameters:
 423
 424     :branch: Git branch to fetch for the build. (default: master)
 425     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 426     :build-timeout: Timeout in seconds before aborting build. (default: 10)
 427     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 428     :packer-cloud-settings: Name of settings file containing credentials
 429         for the cloud that packer will build on. (default: packer-cloud-env)
 430     :packer-version: Version of packer to install / use in build. (default: 1.0.2)
 431     :stream: Keyword that can be used to represent a release code-name.
 432         Often the same as the branch. (default: master)
 433     :submodule-recursive: Whether to checkout submodules recursively.
 434         (default: true)
 435
 436     :gerrit_verify_triggers: Override Gerrit Triggers.
 437     :gerrit_trigger_file_paths: Override file paths which can be used to
 438         filter which file modifications will trigger a build.