Merge "Remove Unused Jenkins-Admin Groovy Scripts"

[releng/global-jjb.git] / docs / jjb / lf-macros.rst

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 1ab522c..419c2c6 100644 (file)
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -95,6 +95,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.
 
 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
 ---------------------
 
 lf-infra-packer-build
 ---------------------
 


@@ -177,6 +182,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.
 
 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
 --------------------
 
 lf-rtd-trigger-build
 --------------------
 


@@ -187,6 +213,13 @@ lf-rtd-verify
 
 ReadTheDocs verify script.
 
 
 ReadTheDocs verify script.
 

+lf-sigul-install
+----------------
+
+Install Sigul.
+
+Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar.
+

 lf-infra-provide-docker-cleanup
 -------------------------------
 
 lf-infra-provide-docker-cleanup
 -------------------------------
 


@@ -201,6 +234,16 @@ lf-infra-maven-parameters
 Provides parameters needed by Maven. Should be used by any jobs that need to
 call the mvn cli.
 
 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
 -------------------
 
 lf-infra-parameters
 -------------------