3 The purpose of this repository is store generically defined, reusable JJB
4 templates, deployable across LF projects.
6 Define the following variables in the Jenkins server as
7 global environment variables as scripts in this repo expect these variables to
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
19 SONAR_URL=https://sonar.opendaylight.org
22 Note: Use **GIT_CLONE_URL** for GitHub projects as this
23 will be different from the URL used the poperties
26 ## Jenkins Plugin Requirements
30 - Config File Provider
44 ## Installing global-jjb
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
51 # Choose a global-jjb version to install
52 GLOBAL_JJB_VERSION=v0.1.0
54 # Add the new submodule to ci-management's jjb directory.
55 # Note: Perform once per ci-management repo.
57 git submodule add https://gerrit.linuxfoundation.org/infra/releng/global-jjb
59 # Checkout the version of global-jjb you wish to deploy.
61 git checkout $GLOBAL_JJB_VERSION
63 # Commit global-jjb version to the ci-management repo.
65 git add jjb/global-jjb
66 git commit -sm "Install global-jjb $GLOBAL_JJB_VERSION"
68 # Push the patch to ci-management for review
72 ## Parameters stored in defaults.yaml
74 Configure the following parameters in the ci-management repo's
77 **gerrit-server-name**: The name of the Gerrit Server as defined
78 in Gerrit Trigger global configuration.
80 **jenkins-ssh-credential**: The name of the Jenkins Credential to
81 use for ssh connections.
83 If you are using GitHub then configure the following parameters
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.
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 ':'
95 **github-org**: The name of the GitHub organization interpolated
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.
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.
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`
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`.
113 **mvn-site-id**: Maven Server ID from settings.xml containing the credentials
114 to push to a Maven site repository.
123 jenkins-ssh-credential: opendaylight-jenkins-ssh
124 gerrit-server-name: OpenDaylight
130 github_pr_admin_list:
132 lftools-version: '<1.0.0'
133 mvn-site-id: opendaylight-site
136 ## Config File Management
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.
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**.
158 - '{project-name}-ci-jobs'
160 project: ci-management
161 project-name: ci-management
162 build-node: centos7-basebuild-2c-1g
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).
173 **branch**: is the git branch to build from.
174 **jjb-version**: is the version of JJB to install in the build minion.
176 ## Deploying packer-jobs
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**.
189 - '{project-name}-packer-jobs'
191 project: ci-management
192 project-name: ci-management
194 build-node: centos7-basebuild-2c-1g
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.
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
231 ## Deploying Python jobs
233 We provide the following Python jobs templates:
235 ### {project-name}-tox-verify-{stream}
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.
244 - '{project-name}-tox-verify-{stream}'
246 project-name: builder
247 project: releng/builder
248 build-node: centos7-java-builder-2c-4g
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.
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: '')
269 ## Archiving logs in Jobs
271 There are 2 ways supported for archiving log information:
273 1) Job creates $WORKSPACE/archives directory and places logs there
275 This method pushes the entire archives directory to the log server
276 in the same structure as configured in the archives directory.
278 2) Via job variable ARCHIVE_ARTIFACTS using globstar patterns.
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.
284 ## Overriding merge and verify triggers
286 The default trigger conditions for Merge and Verify job types are overrideable
287 in a project configuration by overriding the following variables:
289 - gerrit_merge_triggers
290 - gerrit_verify_triggers
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>
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.