X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=ce7ac0d246bfdd33d988387c4eff12a60da3d64d;hb=603bc6bed1996d666f34ec88b06d9c3dfc69d090;hp=8a4fb0c159d77c880f19b7bbfdffceffe9754172;hpb=f0dae8046088b145652b9da6a15068b8c99ced6c;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index 8a4fb0c1..ce7ac0d2 100644 --- 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. +lf-infra-pre-build +------------------ + +Macro that runs before all builders to prepare the system for job use. + lf-infra-package-listing ------------------------ @@ -105,6 +110,14 @@ 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 ------------------------ @@ -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 ` 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 -------------------- @@ -213,13 +205,17 @@ lf-rtd-verify 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. +:Required Parameters: + :sign-artifacts: Whether or not to sign artifacts with Sigul. + :sign-dir: Directory to sign. + lf-infra-provide-docker-cleanup ------------------------------- @@ -228,6 +224,12 @@ 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 ------------------- @@ -293,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. +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 ===