Add submodule-timeout for submodule operations

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

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 419c2c6..34f9e96 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-pre-build
+------------------
+
+Macro that runs before all builders to prepare the system for job use.
+

 lf-infra-package-listing
 ------------------------
 
 lf-infra-package-listing
 ------------------------
 


@@ -105,6 +110,14 @@ lf-infra-packer-build
 
 Run `packer build` to build system images.
 
 
 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
 ------------------------
 
 lf-infra-packer-validate
 ------------------------
 


@@ -182,27 +195,6 @@ 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
 --------------------
 


@@ -213,13 +205,17 @@ lf-rtd-verify
 
 ReadTheDocs verify script.
 
 
 ReadTheDocs verify script.
 

-lf-sigul-install
-----------------
+lf-sigul-sign-dir
+-----------------

 
 

-Install Sigul.
+Use Sigul to sign a directory via {sign-dir}.

 
 Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar.
 
 
 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
 -------------------------------
 
 lf-infra-provide-docker-cleanup
 -------------------------------
 


@@ -228,6 +224,18 @@ Forcibly removes all of the docker images.
 Parameters
 ==========
 
 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
 -------------------------
 
 lf-infra-maven-parameters
 -------------------------
 


@@ -287,6 +295,18 @@ 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.
 
 used in all job templates. This primary objective of this trigger is to
 gather build logs and copy them to a log server.
 

+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
 ===
 
 SCM
 ===
 


@@ -295,6 +315,11 @@ lf-infra-gerrit-scm
 
 Basic SCM configuration for Gerrit based projects.
 
 
 Basic SCM configuration for Gerrit based projects.
 

+:Required parameters:
+
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
+

 lf-infra-github-scm
 -------------------
 
 lf-infra-github-scm
 -------------------
 


@@ -304,23 +329,41 @@ On the `branch` variable you can assign `$sha1` or `$ghprbActualCommit`
 as the value.  This will require that the job be triggered via
 the GHPRB plugin and not manually.
 
 as the value.  This will require that the job be triggered via
 the GHPRB plugin and not manually.
 

+:Required parameters:
+
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
+

 Wrappers
 ========
 
 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
 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/
 
 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.