X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=27da706b9061c6cf7ed51058cdea9e6f4c88fe68;hb=refs%2Ftags%2Fv0.26.0;hp=1ab522cb3430f6ed250c24b21a16cc2f6706bb65;hpb=7eea20901e957ef43de1918119c75688f5eb87ba;p=releng%2Fglobal-jjb.git

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 1ab522cb..27da706b 100644
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -95,11 +95,29 @@ lf-infra-gpg-verify-git-signature
 Verify gpg signature of the latest commit message in $WORKSPACE.
 This command assumes that $WORKSPACE is a git repo.
 
+lf-infra-pre-build
+------------------
+
+Macro that runs before all builders to prepare the system for job use.
+
+lf-infra-package-listing
+------------------------
+
+Lists distro level packages.
+
 lf-infra-packer-build
 ---------------------
 
 Run `packer build` to build system images.
 
+:Required parameters:
+
+    :openstack: Packer template uses an OpenStack builder (true|false).
+    :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
+    :packer-version: Version of packer to use.
+    :platform: Build platform as found in the vars directory.
+    :template: Packer template to build as found in the templates directory.
+
 lf-infra-packer-validate
 ------------------------
 
@@ -107,6 +125,8 @@ Run `packer validate` to verify packer configuration.
 
 :Required parameters:
 
+    :openstack: Packer template uses an OpenStack builder (true|false).
+    :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
     :packer-cloud-settings: Cloud configuration file. Loaded on the build
         server as CLOUDENV environment variable.
     :packer-version: Version of packer to use.
@@ -187,6 +207,17 @@ lf-rtd-verify
 
 ReadTheDocs verify script.
 
+lf-sigul-sign-dir
+-----------------
+
+Use Sigul to sign a directory via {sign-dir}.
+
+Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar.
+
+:Required Parameters:
+    :sign-artifacts: Whether or not to sign artifacts with Sigul.
+    :sign-dir: Directory to sign.
+
 lf-infra-provide-docker-cleanup
 -------------------------------
 
@@ -195,12 +226,34 @@ Forcibly removes all of the docker images.
 Parameters
 ==========
 
+lf-clm-parameters
+-------------------
+
+Provides the policy evaluation stage to run against Nexus IQ Server.
+Valid values include: 'build', 'stage-release', 'operate'.
+
+lf-cmake-parameters
+-------------------
+
+Provides parameters needed by CMake. Should be used by any jobs that need to
+call the ``cmake && make && make install`` pattern.
+
 lf-infra-maven-parameters
 -------------------------
 
 Provides parameters needed by Maven. Should be used by any jobs that need to
 call the mvn cli.
 
+lf-infra-openstack-parameters
+-----------------------------
+
+Provides parameters needed by OpenStack client CLI. Use in jobs that need to
+call the openstack cli.
+
+:Required Parameters:
+
+    :os-cloud: Configures ``OS_CLOUD`` envvar as used by openstack cli.
+
 lf-infra-parameters
 -------------------
 
@@ -244,6 +297,24 @@ Provides basic lf-infra recommended publisher configurations which should be
 used in all job templates. This primary objective of this trigger is to
 gather build logs and copy them to a log server.
 
+lf-infra-publish-windows
+------------------------
+
+Windows publisher for use at the end of Windows job templates. Takes care of
+cleaning out the workspace at the end of a job.
+
+lf-stack-delete
+---------------
+
+Requirements:
+
+* lftools >= v0.17.0
+
+Delete an openstack heat stack. Use at the end of a job that creates a stack.
+
+This macro requires a parameter defined in the job named STACK_NAME
+containing the name of the stack to delete.
+
 SCM
 ===
 
@@ -264,20 +335,33 @@ the GHPRB plugin and not manually.
 Wrappers
 ========
 
+lf-infra-wrappers-common
+------------------------
+
+Provides lf-infra recommended wrappers which should be used in every
+job-template. It's meant to be used by more specific wrappers below.
+
 lf-infra-wrappers
 -----------------
 
 Provides lf-infra recommended wrappers which should be used in every
-job-template.
+job-template that's run on Linux systems.
 
-This wrapper requires that a managed file called `npmrc` exists in the Jenkins.  The main use
-case here is to point to a npm proxy, on Nexus for example.
-The type of the file should be "Custom file".  You can set various npmrc settings in it.
-Documentation on npm configuration can be found at https://docs.npmjs.com/files/npmrc.
-If you are not using npm then it is fine for the file to be empty.
+This wrapper requires that a managed file called `npmrc` exists in the Jenkins.
+The main use case here is to point to a npm proxy, on Nexus for example.
+The type of the file should be "Custom file".  You can set various npmrc
+settings in it. Documentation on npm configuration can be found at
+https://docs.npmjs.com/files/npmrc. If you are not using npm then it is fine
+for the file to be empty.
 
 Example npmrc:
 
 .. code-block:: bash
 
    registry=https://nexus3.onap.org/repository/npm.public/
+
+lf-infra-wrappers-windows
+-------------------------
+
+Provides lf-infra recommended wrappers which should be used in every
+job-template that's run on Windows systems.