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:
115 An example of a container release file appears below. The job applies the
116 container_release_tag string to all released containers. The job uses the
117 per-container version strings to pull images from the container registry.
121 $ cat releases/1.0.0-container.yaml
123 distribution_type: 'container'
124 container_release_tag: '1.0.0'
128 version: 1.0.0-20190806T184921Z
129 - name: test-frontend
130 version: 1.0.0-20190806T184921Z
135 Job should appear under gerrit-maven-stage
137 Example of a terse Jenkins job to call the global-jjb macro:
141 - gerrit-maven-stage:
143 build-node: centos7-docker-8c-8g
144 maven-versions-plugin: true
145 - '{project-name}-gerrit-release-jobs':
146 build-node: centos7-docker-8c-8g
150 Release Engineers: please follow the setup guide below before adding the job definition.
153 Setup for LFID, Nexus, Jenkins and Gerrit
154 =========================================
159 Create an ``lfid`` and an ``ssh-key``
161 ``YOUR_RELEASE_USERNAME`` for example: onap-release
163 ``YOUR_RELEASE_EMAIL`` for example: collab-it+onap-release@linuxfoundation.org
169 ssh-keygen -t rsa -C "collab-it+odl-release@linuxfoundation.org" -f /tmp/odl-release
172 `Create an LFID with the above values <https://identity.linuxfoundation.org>`_
178 Create a Nexus account called ``'jenkins-release'`` with promote privileges.
180 .. image:: ../_static/nexus-promote-privs.png
185 Log into your Gerrit with ``YOUR_RELEASE_USERNAME``, upload the public
186 part of the ``ssh-key`` you created earlier. Log out of Gerrit and log
187 in again with your normal account for the next steps.
190 In Gerrit create a new group called ``self-serve-release`` and give it
191 direct push rights via ``All-Projects`` Add ``YOUR_RELEASE_USERNAME``
192 to group ``self-serve-release`` and group ``Non-Interactive Users``
195 In All project, grant group self-serve-release the following:
199 [access "refs/heads/*"]
200 push = group self-serve-release
201 [access "refs/tags/*"]
202 createTag = group self-serve-release
203 createSignedTag = group self-serve-release
204 forgeCommitter = group self-serve-release
205 push = group self-serve-release
211 Add a global credential to Jenkins called ``jenkins-release`` and set
212 the ID: ``'jenkins-release'`` as its value insert the private half of
213 the ``ssh-key`` that you created for your Gerrit user.
215 Add Global vars in Jenkins:
216 Jenkins configure -> Global properties -> Environment variables
218 ``RELEASE_USERNAME = YOUR_RELEASE_USERNAME``
219 ``RELEASE_EMAIL = YOUR_RELEASE_EMAIL``
221 Jenkins configure -> Managed Files -> Add a New Config -> Custom File
224 Name: SIGNING_PUBKEY (optional)
225 Comment: SIGNING_PUBKEY (optional)
227 Content: (Ask Andy for the public signing key)
228 -----BEGIN PGP PUBLIC KEY BLOCK-----
231 Add or edit the managed file in Jenkins called ``lftoolsini``,
232 appending a nexus section: Jenkins Settings -> Managed files -> Add
233 (or edit) -> Custom file
238 username=jenkins-release
239 password=<plaintext password>
244 Upgrade your project's global-jjb if needed, then add the following to
245 your global defaults file (e.g., jjb/defaults.yaml).
249 jenkins-ssh-release-credential: 'jenkins-release'
257 Release verify and merge jobs are the same except for their scm,
258 trigger, and builders definition. This anchor is the common template.
266 :Template Name: {project-name}-release-merge
268 :Comment Trigger: remerge
270 :Required parameters:
272 :build-node: The node to run build on.
273 :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set
275 :stream: run this job against: **
277 :Optional parameters:
279 :branch: Git branch to fetch for the build. (default: all)
280 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
281 :build-timeout: Timeout in minutes before aborting build. (default: 15)
282 :project-pattern: Project to trigger build against. (default: \*\*)
284 :gerrit_merge_triggers: Override Gerrit Triggers.
285 :gerrit_trigger_file_paths: Override file paths filter which checks which
286 file modifications will trigger a build.
289 - compare-type: REG_EXP
290 pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'
296 :Template Name: {project-name}-release-verify
298 :Comment Trigger: recheck|reverify
300 :Required Parameters:
302 :build-node: The node to run build on.
303 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
305 :stream: run this job against: **
307 :Optional Parameters:
309 :branch: Git branch to fetch for the build. (default: all)
310 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
311 :build-node: The node to run build on.
312 :build-timeout: Timeout in minutes before aborting build. (default: 15)
313 :doc-dir: Directory where tox will place built docs.
314 as defined in the tox.ini (default: docs/_build/html)
315 :gerrit-skip-vote: Skip voting for this job. (default: false)
316 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
317 :project-pattern: Project to trigger build against. (default: \*\*)
319 :gerrit_verify_triggers: Override Gerrit Triggers.
320 :gerrit_trigger_file_paths: Override file paths filter which checks which
321 file modifications will trigger a build.
324 - compare-type: REG_EXP
325 pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'