README.md

   1 # Global JJB
   2
   3 The purpose of this repository is store generically defined, reusable JJB
   4 templates, deployable across LF projects.
   5
   6 Define the following variables in the Jenkins server as
   7 global environment variables as scripts in this repo expect these variables to
   8 be available.
   9
  10 For example:
  11
  12 ```
  13 GIT_URL=ssh://jenkins-$SILO@git.opendaylight.org:29418
  14 GIT_CLONE_URL=git@github.com:
  15 JENKINS_HOSTNAME=jenkins092
  16 LOGS_SERVER=https://logs.opendaylight.org
  17 NEXUS_URL=https://nexus.opendaylight.org
  18 SILO=releng
  19 SONAR_URL=https://sonar.opendaylight.org
  20 ```
  21
  22 Note: Use **GIT_CLONE_URL** for GitHub projects as this
  23 will be different from the URL used the poperties
  24 configuration.
  25
  26 ## Jenkins Plugin Requirements
  27
  28 **Required**
  29
  30 - Config File Provider
  31 - Description Setter
  32 - Gerrit Trigger
  33 - Post Build Script
  34 - SSH Agent
  35 - Workspace Cleanup
  36
  37 **Optional**
  38
  39 - Mask Passwords
  40 - MsgInject
  41 - OpenStack Cloud
  42 - Timestamps
  43
  44 ## Installing global-jjb
  45
  46 Deploy global-jjb in the ci-management repository's jjb directory as
  47 a submodule. Installing, upgrading, and rolling back changes is simple via the
  48 versioned git tags.
  49
  50 ```
  51     # Choose a global-jjb version to install
  52     GLOBAL_JJB_VERSION=v0.1.0
  53
  54     # Add the new submodule to ci-management's jjb directory.
  55     # Note: Perform once per ci-management repo.
  56     cd jjb/
  57     git submodule add https://gerrit.linuxfoundation.org/infra/releng/global-jjb
  58
  59     # Checkout the version of global-jjb you wish to deploy.
  60     cd global-jjb
  61     git checkout $GLOBAL_JJB_VERSION
  62
  63     # Commit global-jjb version to the ci-management repo.
  64     cd ../..
  65     git add jjb/global-jjb
  66     git commit -sm "Install global-jjb $GLOBAL_JJB_VERSION"
  67
  68     # Push the patch to ci-management for review
  69     git review
  70 ```
  71
  72 ## Parameters stored in defaults.yaml
  73
  74 Configure the following parameters in the ci-management repo's
  75 defaults.yaml file.
  76
  77 **gerrit-server-name**: The name of the Gerrit Server as defined
  78 in Gerrit Trigger global configuration.
  79
  80 **jenkins-ssh-credential**: The name of the Jenkins Credential to
  81 use for ssh connections.
  82
  83 If you are using GitHub then configure the following parameters
  84 in defaults.yaml
  85
  86 **git-url**: Set this to the base URL of your GitHub repo. In
  87 general this should be <https://github.com>. If you are using
  88 GitHub Enterprise, or some other GitHub-style system, then it
  89 should be whatever your installation base URL is.
  90
  91 **git-clone-url**: This is the clone prefix used by GitHub jobs.
  92 Set this to either the same thing as **git-url** or the
  93 'git@github.com:' including the trailing ':'
  94
  95 **github-org**: The name of the GitHub organization interpolated
  96 into the scm config.
  97
  98 **github_pr_org**: The name of the GitHub organization. All members
  99 of this organization will be able to trigger any job using the
 100 `lf-infra-github-pr` macro.
 101
 102 **github_pr_whitelist**: List of GitHub members you wish to be able to
 103 trigger any job that uses the `lf-infra-github-pr-trigger` macro.
 104
 105 **github_pr_admin_list**: List of GitHub members that will have admin
 106 privileges on any job using the `lf-infra-github-pr-trigger`
 107 macro.
 108
 109 **lftools-version**: Version of lftools to install. Can be a specific version
 110 like '0.6.1' or a PEP-440 definition. <https://www.python.org/dev/peps/pep-0440/>
 111 For example `<1.0.0` or `>=1.0.0,<2.0.0`.
 112
 113 **mvn-site-id**: Maven Server ID from settings.xml containing the credentials
 114 to push to a Maven site repository.
 115
 116 defaults.yaml:
 117
 118 ```
 119 - defaults:
 120     name: global
 121
 122     # lf-infra defaults
 123     jenkins-ssh-credential: opendaylight-jenkins-ssh
 124     gerrit-server-name: OpenDaylight
 125     github-org: lfit
 126     github_pr_whitelist:
 127       - jpwku
 128       - tykeal
 129       - zxiiro
 130     github_pr_admin_list:
 131       - tykeal
 132     lftools-version: '<1.0.0'
 133     mvn-site-id: opendaylight-site
 134 ```
 135
 136 ## Config File Management
 137
 138 ### Logs
 139
 140 The logs account requires a Maven Settings file created called
 141 **jenkins-log-archives-settings** with a server ID of **logs** containing the
 142 credentials for the logs user in Nexus.
 143
 144 ## Deploying ci-jobs
 145
 146 The CI job group contains jobs that should deploy in all LF
 147 Jenkins infra. The minimal configuration needed to deploy the ci-management
 148 jobs is as follows which deploys the **{project-name}-ci-jobs** job group as
 149 defined in **lf-ci-jobs.yaml**.
 150
 151 ci-management.yaml:
 152
 153 ```
 154 - project:
 155     name: ci-jobs
 156
 157     jobs:
 158       - '{project-name}-ci-jobs'
 159
 160     project: ci-management
 161     project-name: ci-management
 162     build-node: centos7-basebuild-2c-1g
 163 ```
 164
 165 Required parameters:
 166
 167 **project**: is the project repo as defined in source control.
 168 **project-name**: is a custom name to call the job in Jenkins.
 169 **build-node**: is the name of the builder to use when building (Jenkins label).
 170
 171 Optional parameters:
 172
 173 **branch**: is the git branch to build from.
 174 **jjb-version**: is the version of JJB to install in the build minion.
 175
 176 ## Deploying packer-jobs
 177
 178 The packer job group contains jobs to build custom minion images. The minimal
 179 configuration needed to deploy the packer jobs is as follows which deploys the
 180 **{project-name}-packer-jobs** job group as defined in **lf-ci-jobs.yaml**.
 181
 182 ci-management.yaml:
 183
 184 ```
 185 - project:
 186     name: packer-jobs
 187
 188     jobs:
 189       - '{project-name}-packer-jobs'
 190
 191     project: ci-management
 192     project-name: ci-management
 193     branch: master
 194     build-node: centos7-basebuild-2c-1g
 195
 196     platforms:
 197       - centos
 198       - ubuntu-14.04
 199       - ubuntu-16.04
 200
 201     templates:
 202       - devstack
 203       - docker
 204       - gbp
 205       - java-builder
 206       - mininet
 207
 208     exclude:
 209       - platforms: centos
 210         templates: gbp
 211       - platforms: centos
 212         templates: mininet
 213 ```
 214
 215 Required parameters:
 216
 217 **project**: is the project repo as defined in source control.
 218 **project-name**: is a custom name to call the job in Jenkins.
 219 **build-node**: is the name of the builder to use when building (Jenkins label).
 220 **platforms**: is a list of supported platforms.
 221 **templates**: is a list of supported templates.
 222
 223 Optional parameters:
 224
 225 **branch**: is the git branch to build from.
 226 **packer-version**: is the version of packer to install in the build minion,
 227 when packer is not available.
 228 **exclude**: is a combination of platforms and templates which are not required
 229 to build.
 230
 231 ## Deploying Python jobs
 232
 233 We provide the following Python jobs templates:
 234
 235 ### {project-name}-tox-verify-{stream}
 236
 237 Use this job to call python-tox to run builds and tests. The most common
 238 usage of this job is to run the Coala linter against projects.
 239
 240 ```
 241 - project:
 242     name: builder
 243     jobs:
 244         - '{project-name}-tox-verify-{stream}'
 245
 246     project-name: builder
 247     project: releng/builder
 248     build-node: centos7-java-builder-2c-4g
 249     stream: master
 250 ```
 251
 252 Required parameters:
 253
 254 **project**: is the project repo as defined in source control.
 255 **project-name**: is a custom name to call the job in Jenkins.
 256 **build-node**: is the name of the builder to use when building (Jenkins label).
 257 **stream**: typically `master` or matching the build branch. This
 258             is a useful keywords to map a release codename to a branch. For
 259             example OpenDaylight uses this to map stream=carbon to
 260             branch=stable/carbon.
 261
 262 Optional parameters:
 263
 264 **branch**: is the git branch to build from.
 265 **jjb-version**: is the version of JJB to install in the build minion.
 266 **tox-dir**: directory containing tox.ini file (default: '')
 267 **tox-envs**: tox environments to run (default: '')
 268
 269 ## Archiving logs in Jobs
 270
 271 There are 2 ways supported for archiving log information:
 272
 273 1) Job creates $WORKSPACE/archives directory and places logs there
 274
 275 This method pushes the entire archives directory to the log server
 276 in the same structure as configured in the archives directory.
 277
 278 2) Via job variable ARCHIVE_ARTIFACTS using globstar patterns.
 279
 280 In this method a job can define a globstar for example `**/*.log` which then
 281 causes the archive script to do a globstar search for that pattern and archives
 282 any files it finds matching.
 283
 284 ## Overriding merge and verify triggers
 285
 286 The default trigger conditions for Merge and Verify job types are overrideable
 287 in a project configuration by overriding the following variables:
 288
 289 - gerrit_merge_triggers
 290 - gerrit_verify_triggers
 291
 292 These variables take a list of trigger-on values as defined in JJB docs here:
 293 <https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit>
 294
 295 ## Appendix
 296
 297 ### ShellCheck
 298
 299 When using ShellCheck to lint global-jjb or any projects that include
 300 global-jjb as part of their project (common with ci-management repos) then
 301 we require version 0.4.x of ShellCheck installed on the build vms. This version
 302 introduces annotations used by shell scripts in this repo.