X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-ci-jobs.rst;h=d3f343ed154131eb4f1a363994371a34a11990ff;hb=88fbfb8c7f9279990ae1c083b0bf9d36f6913818;hp=3cd6e72fbeca58420e6c0486e1fe55828e8544f4;hpb=a24ad567a740f4f4ac82a794edf0528a58620daf;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-ci-jobs.rst b/docs/jjb/lf-ci-jobs.rst index 3cd6e72f..d3f343ed 100644 --- a/docs/jjb/lf-ci-jobs.rst +++ b/docs/jjb/lf-ci-jobs.rst @@ -107,10 +107,13 @@ Job Templates Gerrit Branch Lock ------------------ -Job submits a patch to lock or unlock a project's branch. +Job submits a patch to lock or unlock a project's branch. This should only be +loaded once, as "ci-management-gerrit-branch-lock" (or "ci-management" +equivalent). That job will process lock/unlock requests for all projects and +all branches. :Template Names: - - {project-name}-gerrit-branch-lock-{stream} + - {project-name}-gerrit-branch-lock - gerrit-branch-lock :Comment Trigger: @@ -126,14 +129,9 @@ Job submits a patch to lock or unlock a project's branch. :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) - :submodule-disable: Disable submodule checkout operation. - (default: false) :gerrit_merge_triggers: Override Gerrit Triggers. .. _lf-global-jjb-jenkins-cfg-merge: @@ -245,11 +243,12 @@ configuration in the format ``KEY=value``. In the case of template definitions of a parameter below is not passed the one defined in default clouds will be inherited. - :IMAGE_NAME: The image name to use for this template. - (required) + :IMAGE_NAME: The image name to use for this template. (required) :HARDWARE_ID: OpenStack flavor to use. (required) :LABELS: Labels to assign to the vm. (default: FILE_NAME) + :VOLUME_SIZE: Volume size to assign to vm. (default: "") + :HARDWARE_ID: Hardware Id to assign to vm. (default: "") :NETWORK_ID: OpenStack network to use. (default: "") :USER_DATA_ID: User Data to pass into the instance. (default: jenkins-init-script) @@ -266,16 +265,18 @@ configuration in the format ``KEY=value``. :START_TIMEOUT: Number of milliseconds to wait for the agent to be provisioned and connected. (default: 600000) :KEY_PAIR_NAME: SSH Public Key Pair to use for authentication. - (default: jenkins) + (default: jenkins-ssh) :NUM_EXECUTORS: Number of executors to enable for the instance. (default: 1) - :JVM_OPTIONS: JVM Options to pass to Java. (default: "") + :JVM_OPTIONS: JVM Options to pass to Java. (default: null) :FS_ROOT: File system root for the workspace. (default: "/w") + :NODE_PROPERTIES: Node properties. (default: null) :RETENTION_TIME: Number of minutes to wait for an idle slave to be used again before it's removed. If set to -1, the slave will be kept forever. (default: 0) :CONNECTION_TYPE: The connection type for Jenkins to connect to the build minion. Valid options: JNLP, SSH. (default: "SSH") + :CONFIG_TYPE: Configuration drive. (default: null) For a live example see the OpenDaylight project jenkins-config directory. https://github.com/opendaylight/releng-builder/tree/master/jenkins-config