Use clouds.yaml for openstack packer builders
[releng/global-jjb.git] / docs / jjb / lf-macros.rst
1 #############
2 Global Macros
3 #############
4
5 Builders
6 ========
7
8 lf-fetch-dependent-patches
9 --------------------------
10
11 Fetch all patches provided via comment trigger
12
13 This macro will fetch all patches provided via comment trigger and will
14 create a list of projects from those patches via environment variable
15 called DEPENDENCY_BUILD_ORDER which can be used if necessary to build
16 projects in the specified order. The order is determined by first patch
17 instance for a project in the patch list.
18
19 lf-license-check
20 ----------------
21
22 Checks files for
23
24 :Required parameters:
25
26     :file-patterns: Space-separated list of file patterns to scan.
27         For example: \*.go \*.groovy \*.java \*.py \*.sh
28     :spdx-disable: Disable the SPDX-Identifier checker.
29     :lhc-version: Version of LHC to use.
30     :license-exclude-paths: Comma-separated list of paths to exclude from the
31         license checker. The paths used here will be matched using a contains
32         rule so it is best to be as precise with the path as possible.
33         For example a path of '/src/generated/' will be searched as
34         '**/src/generated/**'.
35         Example: org/opendaylight/yang/gen,protobuff/messages
36     :licenses-allowed: Comma-separated list of allowed licenses.
37         For example: Apache-2.0,EPL-1.0,MIT
38
39 lf-infra-create-netrc
40 ---------------------
41
42 Create a ~/.netrc file from a Maven settings.xml
43
44 :Required parameters:
45
46     :server-id: The id of a server as defined in settings.xml.
47
48 :Optional parameters:
49
50     :ALT_NEXUS_SERVER: URL of custom nexus server.
51         If set this will take precedence.
52         Use this to point at nexus3.$PROJECTDOMAIN
53         for example.
54
55 lf-infra-deploy-maven-file
56 --------------------------
57
58 Deploy files to a repository.
59
60 :Required parameters:
61
62     :global-settings-file: Global settings file to use.
63     :group-id: Group ID of the repository.
64     :maven-repo-url: URL of a Maven repository to upload to.
65     :mvn-version: Version of Maven to use.
66     :repo-id: Repository ID
67     :settings-file: Maven settings file to use.
68     :upload-files-dir: Path to directory containing one or more files
69
70 lf-infra-docker-login
71 ---------------------
72
73 Login into a custom hosted docker registry and / or docker.io
74
75 The Jenkins system should have the following global variables defined
76
77 :Environment variables:
78
79     :DOCKER_REGISTRY: The DNS address of the registry (IP or FQDN)
80         ex: nexus3.example.com (GLOBAL variable)
81
82     :REGISTRY_PORTS: Required if DOCKER_REGISTRY is set. Space separated list
83         of the registry ports to login to. ex: 10001 10002 10003 10004
84         (GLOBAL variable)
85
86     :DOCKERHUB_EMAIL: If this variable is set then an attempt to login to
87         DockerHub (docker.io) will be also made. It should be set to the email
88         address for the credentials that will get looked up. Only _one_
89         credential will ever be found in the maven settings file for DockerHub.
90         (GLOBAL variable)
91
92 lf-infra-gpg-verify-git-signature
93 ---------------------------------
94
95 Verify gpg signature of the latest commit message in $WORKSPACE.
96 This command assumes that $WORKSPACE is a git repo.
97
98 lf-infra-pre-build
99 ------------------
100
101 Macro that runs before all builders to prepare the system for job use.
102
103 lf-infra-package-listing
104 ------------------------
105
106 Lists distro level packages.
107
108 lf-infra-packer-build
109 ---------------------
110
111 Run `packer build` to build system images.
112
113 :Required parameters:
114
115     :openstack: Packer template uses an OpenStack builder (true|false).
116     :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
117     :packer-version: Version of packer to use.
118     :platform: Build platform as found in the vars directory.
119     :template: Packer template to build as found in the templates directory.
120
121 lf-infra-packer-validate
122 ------------------------
123
124 Run `packer validate` to verify packer configuration.
125
126 :Required parameters:
127
128     :packer-cloud-settings: Cloud configuration file. Loaded on the build
129         server as CLOUDENV environment variable.
130     :packer-version: Version of packer to use.
131
132 lf-infra-push-gerrit-patch
133 --------------------------
134
135 Push a change through a Jenkins job to a Gerrit repository in an automated
136 way using git-review.
137
138 :Required parameters:
139
140     :gerrit-commit-message: Commit message to assign.
141     :gerrit-host: Gerrit hostname.
142     :gerrit-topic: Gerrit topic.
143     :gerrit-user: Gerrit user-id used for submitting the change.
144     :reviewers-email: Reviewers email. Space-separated list of
145         email addresses to CC on the patch.
146     :project: Gerrit project name.
147
148 .. _lf-infra-ship-logs:
149
150 lf-infra-ship-logs
151 ------------------
152
153 Gather and deploy logs to a log server.
154
155 lf-infra-sysstat
156 ----------------
157
158 Retrieves system stats.
159
160 lf-jacoco-nojava-workaround
161 ---------------------------
162
163 Workaround for Jenkins not able to find Java in JaCoCo runs.
164
165 lf-maven-install
166 ----------------
167
168 Call maven-target builder with a goal of --version to force Jenkins to
169 install the need provided version of Maven. This is needed for any shell scripts
170 that want to use Maven.
171
172 :Required parameters:
173
174     :mvn-version: Version of Maven to install.
175
176 lf-pip-install
177 --------------
178
179 Call pip install to install packages into a virtualenv located in
180 /tmp/v/VENV
181
182 .. note:: The first package listed in PIP_PACKAGES is used as the VENV name.
183
184 .. _lf-provide-maven-settings:
185
186 lf-provide-maven-settings
187 -------------------------
188
189 Push a global settings and user settings maven files to the build node.
190
191 lf-provide-maven-settings-cleanup
192 ---------------------------------
193
194 Cleanup maven settings.xml configuration. This should be called at the end of
195 any macros that calles the
196 :ref:`lf-provide-maven-settings <lf-provide-maven-settings>` macro.
197
198 .. _provide-sigul-config:
199
200 lf-provide-sigul-configuration
201 ------------------------------
202
203 Provides sigual configuration to the Jenkins build node.
204
205 Requires the following Config File Provider managed files in Jenkins
206 preconfigured.
207
208 * sigul-config
209 * sigul-password
210 * sigul-pki
211
212 .. _provide-sigul-config-cleanup:
213
214 lf-provide-sigul-configuration-cleanup
215 --------------------------------------
216
217 Cleanup configuration provided by `provide-sigul-config`.
218
219 lf-rtd-trigger-build
220 --------------------
221
222 Script to trigger a build on http://readthedocs.org
223
224 lf-rtd-verify
225 -------------
226
227 ReadTheDocs verify script.
228
229 lf-sigul-install
230 ----------------
231
232 Install Sigul.
233
234 Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar.
235
236 lf-infra-provide-docker-cleanup
237 -------------------------------
238
239 Forcibly removes all of the docker images.
240
241 Parameters
242 ==========
243
244 lf-clm-parameters
245 -------------------
246
247 Provides the policy evaluation stage to run against Nexus IQ Server.
248 Valid values include: 'build', 'stage-release', 'operate'.
249
250 lf-cmake-parameters
251 -------------------
252
253 Provides parameters needed by CMake. Should be used by any jobs that need to
254 call the ``cmake && make && make install`` pattern.
255
256 lf-infra-maven-parameters
257 -------------------------
258
259 Provides parameters needed by Maven. Should be used by any jobs that need to
260 call the mvn cli.
261
262 lf-infra-openstack-parameters
263 -----------------------------
264
265 Provides parameters needed by OpenStack client CLI. Use in jobs that need to
266 call the openstack cli.
267
268 :Required Parameters:
269
270     :os-cloud: Configures ``OS_CLOUD`` envvar as used by openstack cli.
271
272 lf-infra-parameters
273 -------------------
274
275 Standard parameters used in the LF CI environments. Gerrit variables are
276 not used by GitHub projects, but defining them is not harmful. Should be used
277 in every job template.
278
279 lf-infra-node-parameters
280 ------------------------
281
282 Provides parameters needed by NodeJS and NPM. Should be used by any jobs that
283 need to run NodeJS or NPM.
284
285 lf-infra-tox-parameters
286 -----------------------
287
288 Provides parameters needed by python-tox. Should be used by any jobs that need
289 to run `tox <https://tox.readthedocs.io>`.
290
291 Properties
292 ==========
293
294 lf-infra-properties
295 -------------------
296
297 Configures the build-discarder plugin for Jenkins with the recommended lf-infra
298 settings. Should be used in all job-templates.
299
300 Publishers
301 ==========
302
303 lf-jacoco-report
304 ----------------
305
306 Provides basic configuration for the JaCoCo plugin.
307
308 lf-infra-publish
309 ----------------
310
311 Provides basic lf-infra recommended publisher configurations which should be
312 used in all job templates. This primary objective of this trigger is to
313 gather build logs and copy them to a log server.
314
315 SCM
316 ===
317
318 lf-infra-gerrit-scm
319 -------------------
320
321 Basic SCM configuration for Gerrit based projects.
322
323 lf-infra-github-scm
324 -------------------
325
326 Basic SCM configuration for GitHub based projects.
327
328 On the `branch` variable you can assign `$sha1` or `$ghprbActualCommit`
329 as the value.  This will require that the job be triggered via
330 the GHPRB plugin and not manually.
331
332 Wrappers
333 ========
334
335 lf-infra-wrappers
336 -----------------
337
338 Provides lf-infra recommended wrappers which should be used in every
339 job-template.
340
341 This wrapper requires that a managed file called `npmrc` exists in the Jenkins.  The main use
342 case here is to point to a npm proxy, on Nexus for example.
343 The type of the file should be "Custom file".  You can set various npmrc settings in it.
344 Documentation on npm configuration can be found at https://docs.npmjs.com/files/npmrc.
345 If you are not using npm then it is fine for the file to be empty.
346
347 Example npmrc:
348
349 .. code-block:: bash
350
351    registry=https://nexus3.onap.org/repository/npm.public/