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 defaults.yaml:
 114
 115 ```
 116 - defaults:
 117     name: global
 118
 119     # lf-infra defaults
 120     jenkins-ssh-credential: opendaylight-jenkins-ssh
 121     gerrit-server-name: OpenDaylight
 122     github-org: lfit
 123     github_pr_whitelist:
 124       - jpwku
 125       - tykeal
 126       - zxiiro
 127     github_pr_admin_list:
 128       - tykeal
 129     lftools-version: '<1.0.0'
 130 ```
 131
 132 ## Config File Management
 133
 134 ### Logs
 135
 136 The logs account requires a Maven Settings file created called
 137 **jenkins-log-archives-settings** with a server ID of **logs** containing the
 138 credentials for the logs user in Nexus.
 139
 140 ## Deploying ci-jobs
 141
 142 The CI job group contains jobs that should deploy in all LF
 143 Jenkins infra. The minimal configuration needed to deploy the ci-management
 144 jobs is as follows which deploys the **{project-name}-ci-jobs** job group as
 145 defined in **lf-ci-jobs.yaml**.
 146
 147 ci-management.yaml:
 148
 149 ```
 150 - project:
 151     name: ci-jobs
 152
 153     jobs:
 154       - '{project-name}-ci-jobs'
 155
 156     project: ci-management
 157     project-name: ci-management
 158     build-node: centos7-basebuild-2c-1g
 159 ```
 160
 161 Required parameters:
 162
 163 **project**: is the project repo as defined in source control.
 164 **project-name**: is a custom name to call the job in Jenkins.
 165 **build-node**: is the name of the builder to use when building (Jenkins label).
 166
 167 Optional parameters:
 168
 169 **branch**: is the git branch to build from.
 170 **jjb-version**: is the version of JJB to install in the build minion.
 171
 172 ## Deploying packer-jobs
 173
 174 The packer job group contains jobs to build custom minion images. The minimal
 175 configuration needed to deploy the packer jobs is as follows which deploys the
 176 **{project-name}-packer-jobs** job group as defined in **lf-ci-jobs.yaml**.
 177
 178 ci-management.yaml:
 179
 180 ```
 181 - project:
 182     name: packer-jobs
 183
 184     jobs:
 185       - '{project-name}-packer-jobs'
 186
 187     project: ci-management
 188     project-name: ci-management
 189     branch: master
 190     build-node: centos7-basebuild-2c-1g
 191
 192     platforms:
 193       - centos
 194       - ubuntu-14.04
 195       - ubuntu-16.04
 196
 197     templates:
 198       - devstack
 199       - docker
 200       - gbp
 201       - java-builder
 202       - mininet
 203
 204     exclude:
 205       - platforms: centos
 206         templates: gbp
 207       - platforms: centos
 208         templates: mininet
 209 ```
 210
 211 Required parameters:
 212
 213 **project**: is the project repo as defined in source control.
 214 **project-name**: is a custom name to call the job in Jenkins.
 215 **build-node**: is the name of the builder to use when building (Jenkins label).
 216 **platforms**: is a list of supported platforms.
 217 **templates**: is a list of supported templates.
 218
 219 Optional parameters:
 220
 221 **branch**: is the git branch to build from.
 222 **packer-version**: is the version of packer to install in the build minion,
 223 when packer is not available.
 224 **exclude**: is a combination of platforms and templates which are not required
 225 to build.
 226
 227 ## Deploying Python jobs
 228
 229 We provide the following Python jobs templates:
 230
 231 ### {project-name}-tox-verify-{stream}
 232
 233 Use this job to call python-tox to run builds and tests. The most common
 234 usage of this job is to run the Coala linter against projects.
 235
 236 ```
 237 - project:
 238     name: builder
 239     jobs:
 240         - '{project-name}-tox-verify-{stream}'
 241
 242     project-name: builder
 243     project: releng/builder
 244     build-node: centos7-java-builder-2c-4g
 245     stream: master
 246 ```
 247
 248 Required parameters:
 249
 250 **project**: is the project repo as defined in source control.
 251 **project-name**: is a custom name to call the job in Jenkins.
 252 **build-node**: is the name of the builder to use when building (Jenkins label).
 253 **stream**: typically `master` or matching the build branch. This
 254             is a useful keywords to map a release codename to a branch. For
 255             example OpenDaylight uses this to map stream=carbon to
 256             branch=stable/carbon.
 257
 258 Optional parameters:
 259
 260 **branch**: is the git branch to build from.
 261 **jjb-version**: is the version of JJB to install in the build minion.
 262 **tox-dir**: directory containing tox.ini file (default: '')
 263 **tox-envs**: tox environments to run (default: '')
 264
 265 ## Archiving logs in Jobs
 266
 267 There are 2 ways supported for archiving log information:
 268
 269 1) Job creates $WORKSPACE/archives directory and places logs there
 270
 271 This method pushes the entire archives directory to the log server
 272 in the same structure as configured in the archives directory.
 273
 274 2) Via job variable ARCHIVE_ARTIFACTS using globstar patterns.
 275
 276 In this method a job can define a globstar for example `**/*.log` which then
 277 causes the archive script to do a globstar search for that pattern and archives
 278 any files it finds matching.
 279
 280 ## Overriding merge and verify triggers
 281
 282 The default trigger conditions for Merge and Verify job types are overrideable
 283 in a project configuration by overriding the following variables:
 284
 285 - gerrit_merge_triggers
 286 - gerrit_verify_triggers
 287
 288 These variables take a list of trigger-on values as defined in JJB docs here:
 289 <https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit>
 290
 291 ## Appendix
 292
 293 ### ShellCheck
 294
 295 When using ShellCheck to lint global-jjb or any projects that include
 296 global-jjb as part of their project (common with ci-management repos) then
 297 we require version 0.4.x of ShellCheck installed on the build vms. This version
 298 introduces annotations used by shell scripts in this repo.