1 .. _lf-global-jjb-release:
3 #######################
4 Self-Serve Release Jobs
5 #######################
7 Self-serve release jobs allow a project team to direct Jenkins to
8 promote a jar file or container image from a staging area to a release
9 area. To trigger the action, create a releases/ or .releases/
10 directory, add a release yaml file to it, and submit a change set with
11 one release yaml file to Gerrit. Upon merge of the change, Jenkins will
12 sign the reference extrapolated by log_dir and promote the artifact. The
13 expected format of the release yaml file appears in schemas and examples
16 The build node for maven and container release jobs must be CentOS,
17 which supports the sigul client for accessing a signing server. The
18 build node for container release jobs must have Docker installed.
20 A Jenkins user can also trigger a release job via the "Build with
21 parameters" action, removing the need for a release yaml file. The
22 user must enter parameters in the same way as a release yaml file,
23 except for the special USE_RELEASE_FILE and DRY_RUN check boxes. The
24 user must uncheck the USE_RELEASE_FILE check box if the job should
25 run with a release file, while passing the required information as
26 build parameters. Similarly, the user must uncheck the DRY_RUN check
27 box to test the job while skipping repository promotion to Nexus.
29 The special parameters are as follows::
31 GERRIT_BRANCH = master
33 LOG_DIR = example-project-maven-stage-master/17/
34 DISTRIBUTION_TYPE = maven
35 USE_RELEASE_FILE = false
40 The release file regex is: (releases\/.*\.yaml|\.releases\/.*\.yaml).
41 In words, the directory name can be ".releases" or "releases"; the file
42 name can be anything with suffix ".yaml".
44 The JSON schema for a maven release job appears below.
49 $schema: "http://json-schema.org/schema#"
50 $id: "https://github.com/lfit/releng-global-jjb/blob/master/release-schema.yaml"
69 Example of a maven release file:
73 $ cat releases/1.0.0-maven.yaml
75 distribution_type: 'maven'
77 project: 'example-project'
78 log_dir: 'example-project-maven-stage-master/17/'
81 The JSON schema for a container release job appears below.
86 $schema: "http://json-schema.org/schema#"
87 $id: "https://github.com/lfit/releng-global-jjb/blob/master/release-container-schema.yaml"
93 - "container_release_tag"
104 additionalProperties: false
109 container_release_tag:
111 container_pull_registry"
113 container_push_registry"
119 An example of a container release file appears below. The job applies the
120 container_release_tag string to all released containers. The job uses the
121 per-container version strings to pull images from the container registry.
125 $ cat releases/1.0.0-container.yaml
127 distribution_type: 'container'
128 container_release_tag: '1.0.0'
129 container_pull_registry: 'nexus.onap.org:10003"
130 container_push_registry: 'nexus.onap.org:10002"
134 version: 1.0.0-20190806T184921Z
135 - name: test-frontend
136 version: 1.0.0-20190806T184921Z
141 Job should appear under gerrit-maven-stage
143 Example of a terse Jenkins job to call the global-jjb macro:
147 - gerrit-maven-stage:
149 build-node: centos7-docker-8c-8g
150 maven-versions-plugin: true
151 - '{project-name}-gerrit-release-jobs':
152 build-node: centos7-docker-8c-8g
156 Release Engineers: please follow the setup guide below before adding the job definition.
159 Setup for LFID, Nexus, Jenkins and Gerrit
160 =========================================
165 Create an ``lfid`` and an ``ssh-key``
167 ``YOUR_RELEASE_USERNAME`` for example: onap-release
169 ``YOUR_RELEASE_EMAIL`` for example: collab-it+onap-release@linuxfoundation.org
175 ssh-keygen -t rsa -C "collab-it+odl-release@linuxfoundation.org" -f /tmp/odl-release
178 `Create an LFID with the above values <https://identity.linuxfoundation.org>`_
184 Create a Nexus account called ``'jenkins-release'`` with promote privileges.
186 .. image:: ../_static/nexus-promote-privs.png
191 Log into your Gerrit with ``YOUR_RELEASE_USERNAME``, upload the public
192 part of the ``ssh-key`` you created earlier. Log out of Gerrit and log
193 in again with your normal account for the next steps.
196 In Gerrit create a new group called ``self-serve-release`` and give it
197 direct push rights via ``All-Projects`` Add ``YOUR_RELEASE_USERNAME``
198 to group ``self-serve-release`` and group ``Non-Interactive Users``
201 In All project, grant group self-serve-release the following:
205 [access "refs/heads/*"]
206 push = group self-serve-release
207 [access "refs/tags/*"]
208 createTag = group self-serve-release
209 createSignedTag = group self-serve-release
210 forgeCommitter = group self-serve-release
211 push = group self-serve-release
217 Add a global credential to Jenkins called ``jenkins-release`` and set
218 the ID: ``'jenkins-release'`` as its value insert the private half of
219 the ``ssh-key`` that you created for your Gerrit user.
221 Add Global vars in Jenkins:
222 Jenkins configure -> Global properties -> Environment variables
224 ``RELEASE_USERNAME = YOUR_RELEASE_USERNAME``
225 ``RELEASE_EMAIL = YOUR_RELEASE_EMAIL``
227 Jenkins configure -> Managed Files -> Add a New Config -> Custom File
230 Name: SIGNING_PUBKEY (optional)
231 Comment: SIGNING_PUBKEY (optional)
233 Content: (Ask Andy for the public signing key)
234 -----BEGIN PGP PUBLIC KEY BLOCK-----
237 Add or edit the managed file in Jenkins called ``lftoolsini``,
238 appending a nexus section: Jenkins Settings -> Managed files -> Add
239 (or edit) -> Custom file
244 username=jenkins-release
245 password=<plaintext password>
250 Upgrade your project's global-jjb if needed, then add the following to
251 your global defaults file (e.g., jjb/defaults.yaml).
255 jenkins-ssh-release-credential: 'jenkins-release'
263 Release verify and merge jobs are the same except for their scm,
264 trigger, and builders definition. This anchor is the common template.
272 :Template Name: {project-name}-release-merge
274 :Comment Trigger: remerge
276 :Required parameters:
278 :build-node: The node to run build on.
279 :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set
281 :stream: run this job against: **
283 :Optional parameters:
285 :branch: Git branch to fetch for the build. (default: all)
286 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
287 :build-timeout: Timeout in minutes before aborting build. (default: 15)
288 :project-pattern: Project to trigger build against. (default: \*\*)
290 :gerrit_merge_triggers: Override Gerrit Triggers.
291 :gerrit_trigger_file_paths: Override file paths filter which checks which
292 file modifications will trigger a build.
295 - compare-type: REG_EXP
296 pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'
302 :Template Name: {project-name}-release-verify
304 :Comment Trigger: recheck|reverify
306 :Required Parameters:
308 :build-node: The node to run build on.
309 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
311 :stream: run this job against: **
313 :Optional Parameters:
315 :branch: Git branch to fetch for the build. (default: all)
316 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
317 :build-node: The node to run build on.
318 :build-timeout: Timeout in minutes before aborting build. (default: 15)
319 :doc-dir: Directory where tox will place built docs.
320 as defined in the tox.ini (default: docs/_build/html)
321 :gerrit-skip-vote: Skip voting for this job. (default: false)
322 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
323 :project-pattern: Project to trigger build against. (default: \*\*)
325 :gerrit_verify_triggers: Override Gerrit Triggers.
326 :gerrit_trigger_file_paths: Override file paths filter which checks which
327 file modifications will trigger a build.
330 - compare-type: REG_EXP
331 pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'