From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Tue, 19 Jun 2018 17:22:26 +0000 (-0400)
Subject: Document undocumented macros
X-Git-Tag: v0.22.0~16^2~1
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=b0086f1184ceada7545d4b5798f47d879f95a1aa;p=releng%2Fglobal-jjb.git

Document undocumented macros

Change-Id: I1726c5c122a2d4b73d17f62dc9f3458f1ab8d731
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 08722cf7..241ce12d 100644
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -75,6 +75,11 @@ 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-package-listing
+------------------------
+
+Lists distro level packages.
+
 lf-infra-packer-build
 ---------------------
 
@@ -157,6 +162,27 @@ Cleanup maven settings.xml configuration. This should be called at the end of
 any macros that calles the
 :ref:`lf-provide-maven-settings <lf-provide-maven-settings>` macro.
 
+.. _provide-sigul-config:
+
+lf-provide-sigul-configuration
+------------------------------
+
+Provides sigual configuration to the Jenkins build node.
+
+Requires the following Config File Provider managed files in Jenkins
+preconfigured.
+
+* sigul-config
+* sigul-password
+* sigul-pki
+
+.. _provide-sigul-config-cleanup:
+
+lf-provide-sigul-configuration-cleanup
+--------------------------------------
+
+Cleanup configuration provided by `provide-sigul-config`.
+
 lf-rtd-trigger-build
 --------------------
 
@@ -167,6 +193,13 @@ lf-rtd-verify
 
 ReadTheDocs verify script.
 
+lf-sigul-install
+----------------
+
+Install Sigul.
+
+Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar.
+
 lf-infra-provide-docker-cleanup
 -------------------------------
 
@@ -181,6 +214,16 @@ 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
 -------------------