Capture instance metadata with job logs

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

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 9b9b089..3df86ab 100644 (file)
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -44,6 +44,11 @@ Checks files for
     :licenses-allowed: Comma-separated list of allowed licenses.
         For example: Apache-2.0,EPL-1.0,MIT
 
+lf-infra-capture-instance-metadata
+----------------------------------
+
+Capture instance metadata.
+
 lf-infra-create-netrc
 ---------------------
 
@@ -222,6 +227,27 @@ that want to use Maven.
 
     :mvn-version: Version of Maven to install.
 
+lf-packagecloud-file-provider
+-----------------------------
+
+Provisions files required by the Ruby gem package_cloud, namely
+".packagecloud" and "packagecloud_api" in the Jenkins home directory.
+
+lf-packagecloud-push
+--------------------
+
+Pushes DEB/RPM package files to PackageCloud using the Ruby gem package_cloud.
+
+:Required parameters:
+
+    :build-dir: Directory with deb/rpm files to push
+    :debian-distribution-versions: list of DEB package distro/version strings
+        separated by space; example: ubuntu/bionic debian/stretch
+    :packagecloud-account: PackageCloud account ID; example: oran
+    :packagecloud-repo: PackageCloud repository; example: master, staging
+    :rpm-distribution-versions: list of RPM package distro/version strings
+        separated by space; example: el/4 el/5
+
 lf-pip-install
 --------------
 
@@ -259,15 +285,16 @@ ReadTheDocs verify script. Installs and runs tox.
     :doc-dir: Document directory.
     :python-version: Python version.
 
-lf-rtdv2-build
+lf-rtdv3-build
 ---------------
 
-ReadTheDocs Version 2 verify and merge scripts.
-This is an update to the read the docs scripts that leverages the new Read the Docs v3 api
+Read the docs scripts that leverage the new Read the Docs v3 api
 `RTD v3 API <https://docs.readthedocs.io/en/stable/api/v3.html>`_
-Runs tox to verify that the docs are good and then runs the RTDv2 shell script.
+Runs tox to verify that the docs are good and then runs the RTDv3 shell script.
 This script handles creating projects as needed, assiging subprojects to the main
 read the docs project and triggering builds to update the documentation.
+Jobs will run but skip verify bits until a .readthedocs.yaml is found in the root
+of their repository.
 
 
 check-info-votes
@@ -350,8 +377,14 @@ Requires ``SonarQube Scanner for Jenkins``
 Parameters
 ==========
 
+lf-autotools-parameters
+-----------------------
+
+Provides parameters needed by configure and make. Should be used by any jobs
+that need to call the ``configure && make`` pattern.
+
 lf-clm-parameters
--------------------
+-----------------
 
 Provides the policy evaluation stage to run against Nexus IQ Server.
 Valid values include: 'build', 'stage-release', 'operate'.
@@ -425,7 +458,8 @@ lf-infra-publish
 
 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.
+gather package listing, instance metadata, sar reports, build logs and copy
+them to a log server.
 
 lf-infra-publish-windows
 ------------------------