X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-ci-jobs.rst;h=a394741dfe8ff1507875ab1d96c33e7befd335ca;hb=d1f9c96c053c12d82811d54bb571fd39e0c443f4;hp=19de22d1952401157a28fc1776915ad1acd912a6;hpb=2ea5908d7197fd2a895e1992920db2d7cfdf64d7;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-ci-jobs.rst b/docs/jjb/lf-ci-jobs.rst index 19de22d1..a394741d 100644 --- a/docs/jjb/lf-ci-jobs.rst +++ b/docs/jjb/lf-ci-jobs.rst @@ -5,52 +5,40 @@ CI Jobs Job Groups ========== -{project-name}-ci-jobs ----------------------- +.. include:: ../job-groups.rst -Recommended jobs that should be deployed for CI using Gerrit. +Below is a list of CI job groups: -:Includes: - - - gerrit-jenkins-cfg-merge - - gerrit-jjb-deploy-job - - gerrit-jjb-merge - - gerrit-jjb-verify - -{project-name}-github-ci-jobs ------------------------------ - -Recommended jobs that should be deployed CI using GitHub. +.. literalinclude:: ../../jjb/lf-ci-job-groups.yaml + :language: yaml -:Includes: - - github-jenkins-cfg-merge - - github-jjb-deploy-job - - github-jjb-merge - - github-jjb-verify +Macros +====== -{project-name}-packer-jobs --------------------------- +lf-infra-jjb-parameters +----------------------- -Jobs related to Packer builds for CI using Gerrit. +:Required Parameters: -:Includes: + :jjb-version: Version of Jenkins Job Builder (JJB) to install and use in + the jjb jobs. - - gerrit-packer-merge - - gerrit-packer-verify +lf-jenkins-cfg-clouds +--------------------- -{project-name}-github-packer-jobs ---------------------------------- +Deploys Jenkins Cloud configuration read from the ``jenkins-clouds`` directory +in ci-management repositories. -Jobs related to Packer builds for CI using GitHub. +.. note:: -:Includes: + Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style + config definitions for "production" and "sandbox" systems. - - github-packer-merge - - github-packer-verify +:Required Parameters: -Macros -====== + :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 -------------------------- @@ -66,7 +54,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 @@ -81,24 +69,36 @@ Provides jenkins_jobs.ini configuration for Jenkins sandbox. .. todo:: This needs to be consolidated into lf-infra-jjbini when JJB 2.0 is available -lf-packer-verify-file-paths ---------------------------- +lf-packer-common +---------------- -Gerrit file-paths for packer verify jobs. +Common packer configuration. lf-packer-file-paths -------------------- Gerrit file-paths for packer jobs. -lf-packer-common ----------------- +lf-packer-parameters +-------------------- -Common packer configuration. +Parameters useful for packer related tasks. + +:Parameters: + + :packer-version: Version of packer to install / use. + (shell: PACKER_VERSION) + +lf-packer-verify-file-paths +--------------------------- + +Gerrit file-paths for packer verify jobs. Job Templates ============= +.. _gerrit-branch-lock: + Gerrit Branch Lock ------------------ @@ -108,27 +108,33 @@ Job submits a patch to lock or unlock a project's branch. - {project-name}-gerrit-branch-lock-{stream} - gerrit-branch-lock +:Comment Trigger: -Jenkins Configuration Merge ---------------------------- + * lock branch + * unlock branch -Jenkins job to manage Global Jenkins configuration. +:Required parameters: -Global Environment Variables are managed via the -``jenkins-config/global-vars-SILO.sh`` file in ci-management. Replace SILO with -the name of the Jenkins silo the variable configuration is for. + :build-node: The node to run build on. + :jenkins-ssh-credential: Credential to use for SSH. (Generally + should be configured in defaults.yaml) -The format for this file is ``KEY=value`` for example:: +:Optional parameters: - GERRIT_URL=https://git.opendaylight.org/gerrit - GIT_BASE=git://devvexx.opendaylight.org/mirror/$PROJECT - GIT_URL=git://devvexx.opendaylight.org/mirror - JENKINS_HOSTNAME=vex-yul-odl-jenkins-2 - LOGS_SERVER=https://logs.opendaylight.org - NEXUS_URL=https://nexus.opendaylight.org - ODLNEXUSPROXY=https://nexus.opendaylight.org - SILO=sandbox - SONAR_URL=https://sonar.opendaylight.org + :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: + +Jenkins Configuration Merge +--------------------------- + +Jenkins job to manage Global Jenkins configuration. .. note:: @@ -154,7 +160,7 @@ Typically this template is automatically pulled in by the "{project-name}-ci-jobs" job-group and does not need to be explicitly called if the job group is being used. -Miniaml Example: +Minimal Example: .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-minimal.yaml :language: yaml @@ -164,6 +170,142 @@ Full Example: .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-full.yaml :language: yaml +.. _jenkins-cfg-envvar: + +Global Environment Variables +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Global Environment Variables are managed via the +``jenkins-config/global-vars-SILO.sh`` file in ci-management. Replace SILO with +the name of the Jenkins silo the variable configuration is for. + +The format for this file is ``KEY=value`` for example:: + + GERRIT_URL=https://git.opendaylight.org/gerrit + GIT_BASE=git://devvexx.opendaylight.org/mirror/$PROJECT + GIT_URL=git://devvexx.opendaylight.org/mirror + JENKINS_HOSTNAME=vex-yul-odl-jenkins-2 + LOGS_SERVER=https://logs.opendaylight.org + NEXUS_URL=https://nexus.opendaylight.org + ODLNEXUSPROXY=https://nexus.opendaylight.org + SILO=sandbox + SONAR_URL=https://sonar.opendaylight.org + +Cloud Configuration +^^^^^^^^^^^^^^^^^^^ + +This configuration requires the OpenStack Cloud plugin in Jenkins and is +currently the only cloud plugin supported. + +OpenStack Cloud plugin version supported: + +* 2.30 - 2.34 +* 2.35 - 2.37 + +Cloud configuration are managed via a directory structure in ci-management as +follows: + +- jenkins-config/clouds/openstack/ +- jenkins-config/clouds/openstack/cattle/cloud.cfg +- jenkins-config/clouds/openstack/cattle/centos7-builder-2c-2g.cfg +- jenkins-config/clouds/openstack/cattle/centos7-builder-4c-4g.cfg +- jenkins-config/clouds/openstack/cattle/centos7-docker-4c-4g.cfg + +The directory name inside of the "openstack" directory is used as the name of +the cloud configuration. In this case "cattle" is being used as the cloud name. + +The ``cloud.cfg`` file is a special file used to configure the main cloud +configuration in the format ``KEY=value``. + +:Cloud Parameters: + + :CLOUD_URL: API endpoint URL for Keystone. + (default: "") + :CLOUD_IGNORE_SSL: Ignore unverified SSL certificates. (default: false) + :CLOUD_ZONE: OpenStack region to use. (default: "") + :CLOUD_CREDENTIAL_ID: Credential to use for authentication to OpenStack. + (default: "os-cloud") + :INSTANCE_CAP: Total number of instances the cloud will allow spin up. + (default: null) + :SANDBOX_CAP: Total number of instances the cloud will allow to + spin up. This applies to "sandbox" systems and overrides the + INSTANCE_CAP setting. (default: null) + +:Template Parameters: + + .. note:: + + 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) + :HARDWARE_ID: OpenStack flavor to use. (required) + + :LABELS: Labels to assign to the vm. (default: FILE_NAME) + :NETWORK_ID: OpenStack network to use. (default: "") + :USER_DATA_ID: User Data to pass into the instance. + (default: jenkins-init-script) + :INSTANCE_CAP: Total number of instances of this type that can be launched + at one time. When defined in clouds.cfg it defines the total for the + entire cloud. (default: null) + :SANDBOX_CAP: Total number of instances of this type that can be launched + at one time. When defined in clouds.cfg it defines the total for the + entire cloud. This applies to "sandbox" systems and overrides the + INSTANCE_CAP setting. (default: null) + :FLOATING_IP_POOL: Floating ip pool to use. (default: "") + :SECURITY_GROUPS: Security group to use. (default: "default") + :AVAILABILITY_ZONE: OpenStack availability zone to use. (default: "") + :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) + :NUM_EXECUTORS: Number of executors to enable for the instance. + (default: 1) + :JVM_OPTIONS: JVM Options to pass to Java. (default: "") + :FS_ROOT: File system root for the workspace. (default: "/w") + :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 + +Troubleshooting +^^^^^^^^^^^^^^^ + +:Cloud Configuration: + + The directory ``groovy-inserts`` contains the groovy script output that is + used to push to Jenkins. In the event of a job failure this file can be + inspected. + + +Jenkins Sandbox Cleanup +----------------------- + +Cleanup Jenkins Sandbox of jobs and views periodically. + +:Template names: + + - {project-name}-jenkins-sandbox-cleanup + - gerrit-jenkins-sandbox-cleanup + - github-jenkins-sandbox-cleanup + +:Comment Trigger: NONE + +: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: + + :cron: Schedule to run job. (default: '0 8 * * 6') + JJB Deploy Job -------------- @@ -209,24 +351,27 @@ Runs `jenkins-jobs update` to update production job configuration - gerrit-jjb-merge - github-jjb-merge +:Comment Trigger: remerge + :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) - :mvn-settings: The name of settings file containing credentials for - the project. :Optional parameters: :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) + :jjb-version: JJB version to install. (default: see job-template) :stream: Keyword that can be used to represent a release code-name. 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 @@ -244,30 +389,168 @@ Runs `jenkins-jobs test` to validate JJB syntax - gerrit-jjb-verify - github-jjb-verify +:Comment Trigger: recheck|reverify + :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) - :mvn-settings: The name of settings file containing credentials for - the project. :Optional parameters: :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) + :jjb-version: JJB version to install. (default: see job-template) :stream: Keyword that can be used to represent a release code-name. 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 filter which file modifications will trigger a build. (default defined by lf_jjb_common) +.. _jjb-verify-upstream-gjjb: + +JJB Verify Upstream Global JJB +------------------------------ + +Runs ``jenkins-jobs test`` to validate JJB syntax for upstream global-jjb +patches. This job is useful to notify upstream that they may be breaking +project level jobs. + +:Template Names: + - {project-name}-jjb-verify-upstream-gjjb + - gerrit-jjb-verify-upstream-gjjb + +:Comment Trigger: recheck|reverify + +: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 fetch for the build. (default: master) + :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) + :build-timeout: Timeout in minutes before aborting build. (default: 10) + :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) + :jjb-version: JJB version to install. (default: see job-template) + :stream: Keyword that can be used to represent a release code-name. + Often the same as the branch. (default: master) + +.. _info-yaml-verify: + +Info YAML Verify +---------------- + +Info YAML Verify job validates that INFO.yaml file changes are kept isolated from +other file changes. Verifies INFO.yaml files follow the schema defined in +`global-jjb/info-schema`. + +:Template Names: + - {project-name}-info-yaml-verify + - gerrit-info-yaml-verify + - github-info-yaml-verify + +: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 fetch for the build. (default: master) + :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) + :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) + :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: + +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-openstack-cron: + +OpenStack Cron +-------------- + +Cron job that runs regularly to perform periodic tasks against OpenStack. + +This job requires a Config File Provider file named ``clouds-yaml`` available +containing the credentials for the cloud. + +:Template Names: + - {project-name}-openstack-cron + - gerrit-openstack-cron + - github-openstack-cron + +: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 fetch for the build. (default: master) + :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) + :build-timeout: Timeout in minutes before aborting build. (default: 90) + :cron: Time when the packer image should be rebuilt (default: @daily) + :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) + :openstack-cloud: OS_CLOUD setting to pass to openstack client. + (default: vex) + :stream: Keyword that can be used to represent a release code-name. + 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: Packer Merge ------------ @@ -279,6 +562,8 @@ Packer Merge job runs `packer build` to build system images in the cloud. - gerrit-packer-merge - github-packer-merge +:Comment Trigger: remerge + :Required parameters: :build-node: The node to run build on. @@ -293,10 +578,14 @@ Packer Merge job runs `packer build` to build system images in the cloud. :Optional parameters: + :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) + :openstack: Packer template uses an OpenStack builder (default: true). + :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter. + (default: vex). :packer-cloud-settings: Name of settings file containing credentials for the cloud that packer will build on. (default: packer-cloud-env) :packer-version: Version of packer to install / use in build. (default: 1.0.2) @@ -304,10 +593,14 @@ 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. +.. _gjjb-packer-verify: + Packer Verify ------------- @@ -318,6 +611,8 @@ Packer Verify job runs `packer validate` to verify packer configuration. - gerrit-packer-verify - github-packer-verify +:Comment Trigger: recheck|reverify + :Required parameters: :build-node: The node to run build on. @@ -330,8 +625,11 @@ 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) + :openstack: Packer template uses an OpenStack builder (default: true). + :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter. + (default: vex). :packer-cloud-settings: Name of settings file containing credentials for the cloud that packer will build on. (default: packer-cloud-env) :packer-version: Version of packer to install / use in build. (default: 1.0.2) @@ -339,6 +637,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