X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-ci-jobs.rst;h=d426b969db6f2484d24d9a39a611c73f9b609fdc;hb=623a1e669cf24e802e8c3ae0fc26ad2ee354e333;hp=70a6fa2186c04324eed46d468ad36d82bf69b7a1;hpb=b83660faf15e9b6983d5d6baa031ecec710140b8;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-ci-jobs.rst b/docs/jjb/lf-ci-jobs.rst index 70a6fa21..d426b969 100644 --- a/docs/jjb/lf-ci-jobs.rst +++ b/docs/jjb/lf-ci-jobs.rst @@ -70,6 +70,30 @@ Jobs related to Packer builds for CI using GitHub. Macros ====== +lf-infra-jjb-parameters +----------------------- + +:Required Parameters: + + :jjb-version: Version of Jenkins Job Builder (JJB) to install and use in + the jjb jobs. + +lf-jenkins-cfg-clouds +--------------------- + +Deploys Jenkins Cloud configuration read from the ``jenkins-clouds`` directory +in ci-management repositories. + +.. note:: + + Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style + config definitions for "production" and "sandbox" systems. + +:Required Parameters: + + :jenkins-silos: Space-separated list of Jenkins silos to update + configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini + lf-jenkins-cfg-global-vars -------------------------- @@ -84,7 +108,7 @@ ci-management/jenkins-config/global-vars-SILO.sh script. :Required parameters: - :jenkins-silos: Space separated list of Jenkins silos to update + :jenkins-silos: Space-separated list of Jenkins silos to update configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini lf-infra-jjbini @@ -207,11 +231,8 @@ currently the only cloud plugin supported. OpenStack Cloud plugin version supported: -* 2.30 -* 2.31 -* 2.32 -* 2.33 -* 2.34 +* 2.30 - 2.34 +* 2.35 - 2.37 Cloud configuration are managed via a directory structure in ci-management as follows: @@ -277,6 +298,8 @@ configuration in the format ``KEY=value``. :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") For a live example see the OpenDaylight project jenkins-config directory. https://github.com/opendaylight/releng-builder/tree/master/jenkins-config @@ -347,7 +370,7 @@ Runs `jenkins-jobs update` to update production job configuration :branch: Git branch to fetch for the build. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :build-timeout: Timeout in seconds before aborting build. (default: 10) + :build-timeout: Timeout in minutes before aborting build. (default: 10) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :stream: Keyword that can be used to represent a release code-name. Often the same as the branch. (default: master) @@ -382,7 +405,7 @@ Runs `jenkins-jobs test` to validate JJB syntax :branch: Git branch to fetch for the build. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :build-timeout: Timeout in seconds before aborting build. (default: 10) + :build-timeout: Timeout in minutes before aborting build. (default: 10) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :stream: Keyword that can be used to represent a release code-name. Often the same as the branch. (default: master) @@ -418,7 +441,7 @@ other file changes. Verifies INFO.yaml files follow the schema defined in :branch: Git branch to fetch for the build. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :build-timeout: Timeout in seconds before aborting build. (default: 10) + :build-timeout: Timeout in minutes before aborting build. (default: 10) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :stream: Keyword that can be used to represent a release code-name. Often the same as the branch. (default: master) @@ -426,6 +449,37 @@ other file changes. Verifies INFO.yaml files follow the schema defined in (default: true) :gerrit_verify_triggers: Override Gerrit Triggers. +.. _license-checker: + +License Checker +--------------- + +Job to scan projects for files missing license headers. + +:Template Names: + - {project-name}-license-check + - gerrit-license-check + - github-license-check + +:Optional parameters: + + :build-timeout: Timeout in minutes before aborting build. (default: 15) + :file-patterns: Space-separated list of file patterns to scan. + (default: \*.go \*.groovy \*.java \*.py \*.sh) + :spdx-disable: Disable the SPDX-Identifier checker. (default: false) + :lhc-version: Version of LHC to use. (default: 0.2.0) + :license-exclude-paths: Comma-separated list of paths to exclude from the + license checker. The paths used here will be matched using a contains + rule so it is best to be as precise with the path as possible. + For example a path of '/src/generated/' will be searched as + '**/src/generated/**'. + Example: org/opendaylight/yang/gen,protobuff/messages + (default: '') + :licenses-allowed: Comma-separated list of allowed licenses. + (default: Apache-2.0,EPL-1.0,MIT) + :project-pattern: The ANT based pattern for Gerrit Trigger to choose which + projects to trigger job against. (default: '**') + .. _gjjb-packer-merge: Packer Merge @@ -455,7 +509,7 @@ Packer Merge job runs `packer build` to build system images in the cloud. :cron: Time when the packer image should be rebuilt (default: @monthly) :branch: Git branch to fetch for the build. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :build-timeout: Timeout in seconds before aborting build. (default: 10) + :build-timeout: Timeout in minutes before aborting build. (default: 90) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :packer-cloud-settings: Name of settings file containing credentials for the cloud that packer will build on. (default: packer-cloud-env) @@ -492,7 +546,7 @@ Packer Verify job runs `packer validate` to verify packer configuration. :branch: Git branch to fetch for the build. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :build-timeout: Timeout in seconds before aborting build. (default: 10) + :build-timeout: Timeout in minutes before aborting build. (default: 10) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :packer-cloud-settings: Name of settings file containing credentials for the cloud that packer will build on. (default: packer-cloud-env)