X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-ci-jobs.rst;h=8c0ad44be5d04a884abe7e24a6016a98362196ae;hb=50bb84fc6e18daa187d5047968dc130b215a02c0;hp=53087216c8dd75207643817bfb5a25166569458f;hpb=2bbf29ef6e1a538ce2adf2511b18ab50e431958b;p=releng%2Fglobal-jjb.git

diff --git a/docs/jjb/lf-ci-jobs.rst b/docs/jjb/lf-ci-jobs.rst
index 53087216..8c0ad44b 100644
--- a/docs/jjb/lf-ci-jobs.rst
+++ b/docs/jjb/lf-ci-jobs.rst
@@ -97,6 +97,8 @@ Gerrit file-paths for packer verify jobs.
 Job Templates
 =============
 
+.. _gerrit-branch-lock:
+
 Gerrit Branch Lock
 ------------------
 
@@ -106,6 +108,26 @@ Job submits a patch to lock or unlock a project's branch.
     - {project-name}-gerrit-branch-lock-{stream}
     - gerrit-branch-lock
 
+:Comment Trigger:
+
+    * lock branch
+    * unlock branch
+
+:Required parameters:
+
+    :build-node: The node to run build on.
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally
+        should be configured in defaults.yaml)
+
+:Optional parameters:
+
+    :branch: Git branch to build against. (default: master)
+    :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
+    :stream: Keyword that can be used to represent a release code-name.
+        Often the same as the branch. (default: master)
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
+    :gerrit_merge_triggers: Override Gerrit Triggers.
 
 .. _lf-global-jjb-jenkins-cfg-merge:
 
@@ -260,6 +282,33 @@ Troubleshooting
     used to push to Jenkins. In the event of a job failure this file can be
     inspected.
 
+ .. _lf-global-jjb-jenkins-cfg-verify:
+
+Jenkins Configuration Verify
+----------------------------
+
+Jenkins job to verify the Global Jenkins configuration.
+
+Requires the ``clouds-yaml`` file to be setup on the Jenkins host.
+
+:Template names:
+
+    - {project-name}-jenkins-cfg-verify
+    - gerrit-jenkins-cfg-verify
+    - github-jenkins-cfg-verify
+
+:Optional parameters:
+
+    :branch: Git branch to build against. (default: master)
+    :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
+
+This job is not part of the "{project-name}-ci-jobs" group. It must be called
+explicitly.
+
+Example:
+
+.. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-verify.yaml
+   :language: yaml
 
 Jenkins Sandbox Cleanup
 -----------------------
@@ -348,6 +397,8 @@ Runs `jenkins-jobs update` to update production job configuration
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
 
     :gerrit_merge_triggers: Override Gerrit Triggers.
     :gerrit_trigger_file_paths: Override file paths which can be used to
@@ -384,6 +435,8 @@ Runs `jenkins-jobs test` to validate JJB syntax
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
 
     :gerrit_verify_triggers: Override Gerrit Triggers.
     :gerrit_trigger_file_paths: Override file paths which can be used to
@@ -451,6 +504,9 @@ other file changes. Verifies INFO.yaml files follow the schema defined in
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
+
     :gerrit_verify_triggers: Override Gerrit Triggers.
 
 .. _license-checker:
@@ -518,6 +574,8 @@ containing the credentials for the cloud.
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
 
 .. _gjjb-packer-merge:
 
@@ -562,6 +620,8 @@ Packer Merge job runs `packer build` to build system images in the cloud.
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
 
     :gerrit_verify_triggers: Override Gerrit Triggers.
 
@@ -604,6 +664,8 @@ Packer Verify job runs `packer validate` to verify packer configuration.
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
 
     :gerrit_verify_triggers: Override Gerrit Triggers.
     :gerrit_trigger_file_paths: Override file paths which can be used to