Add template to update OpenStack cloud images
[releng/global-jjb.git] / docs / jjb / lf-macros.rst
index 9b5773a..e628179 100644 (file)
@@ -126,6 +126,11 @@ Run `packer build` to build system images.
     :platform: Build platform as found in the vars directory.
     :template: Packer template to build as found in the templates directory.
 
+:Optional parameters:
+
+    :update-cloud-image: Submit a change request to update new built cloud
+        image to Jenkins.
+
 lf-infra-packer-validate
 ------------------------
 
@@ -167,6 +172,13 @@ lf-infra-sysstat
 
 Retrieves system stats.
 
+lf-infra-update-packer-images
+-----------------------------
+
+Find and update the new built cloud image{s} in the ci-management source
+repository.
+
+
 lf-jacoco-nojava-workaround
 ---------------------------
 
@@ -240,7 +252,12 @@ Script to trigger a build on http://readthedocs.org
 lf-rtd-verify
 -------------
 
-ReadTheDocs verify script.
+ReadTheDocs verify script. Installs and runs tox.
+
+:Required parameters:
+
+    :doc-dir: Document directory.
+    :python-version: Python version.
 
 check-info-votes
 ----------------
@@ -280,7 +297,9 @@ Forcibly removes all of the docker images.
 lf-infra-sonar
 ---------------
 
-Runs Jenkins Sonar plug-in
+Runs Jenkins SonarQube plug-in.
+
+Requires ``SonarQube Scanner for Jenkins``
 
 :Optional Parameters:
     :sonar-task: Sonar task to run. (default: "")
@@ -338,6 +357,12 @@ lf-infra-tox-parameters
 Provides parameters needed by python-tox. Should be used by any jobs that need
 to run `tox <https://tox.readthedocs.io>`.
 
+
+lf-build-with-parameters-maven-release
+--------------------------------------
+
+Provides parameters needed for maven release jobs 'build with parameters'.
+
 Properties
 ==========