X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-release-jobs.rst;h=dddaac31404803dde4c86730881ed0ac3df05471;hb=5fe7f08ff027accd25c96df8bc3f88030f89ffb7;hp=eb4e8022f2721bbe4f435f7a603db0ea2db15b4c;hpb=b7c2eb944f2ca44bb07a1841306dc75e3e8c03bd;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-release-jobs.rst b/docs/jjb/lf-release-jobs.rst index eb4e8022..dddaac31 100644 --- a/docs/jjb/lf-release-jobs.rst +++ b/docs/jjb/lf-release-jobs.rst @@ -4,66 +4,81 @@ Self Serve Release Jobs ####################### -Self serve release jobs allow a project to create a releases directory and then place a release file in it. -Jenkins will pick this up and then promote the artifact from the staging log directory (log_dir) and tag the release -with the defined version. maven_central_url is optional +Self serve release jobs allow a project to create a releases/ or .releases/ directory and then place a release yaml file in it. +Jenkins will pick this up and sign the ref extrapolated by log_dir and promote the artifact, whether maven or container. + +Maven release jobs can also trigger via "Build with parameters" negating the need for a release file. +The parameters will need to be filled out in the same was as a release file's would, excepting the special +USE_RELEASE_FILE and DRY_RUN check boxes. The USE_RELEASE_FILE check box will need to be unchecked, if the job +is expected to run with a release file, while passing the required information as build parameters. +Similarly, the DRY_RUN check box will need to be unchecked, if the job needs to be tested while skipping +repository promotion to Nexus. + +The Special Parameters are as follows: + +GERRIT_BRANCH = master +VERSION = 1.0.0 +LOG_DIR = example-project-maven-stage-master/17/ +DISTRIBUTION_TYPE = maven +USE_RELEASE_FILE = false +DRY_RUN = false .. note:: - Example of a project's release file: + Example of a maven release file: + +.. note:: + + Release files regex: (releases\/.*\.yaml|\.releases\/.*\.yaml) + directory can be .releases/ or releases/ + file can be ANYTHING.yaml + .. code-block:: bash - $ cat releases/1.0.0.yaml + $ cat releases/maven-1.0.0.yaml --- distribution_type: 'maven' version: '1.0.0' - project: 'example-test-release' - log_dir: 'example-test-release-maven-stage-master/17/' - maven_central_url: 'oss.sonatype.org' + project: 'example-project' + log_dir: 'example-project-maven-stage-master/17/' -.. note:: - Example of a terse Jenkins job to call global-jjb macro: + Example of a container release file: -.. code-block:: none - - - project: - name: '{project-name}-gerrit-release-jobs' - project: 'example-test-release' - build-node: centos7-builder-2c-1g - project-name: example-test-release - jobs: - - '{project-name}-gerrit-release-jobs' +.. code-block:: bash -.. note:: + $ cat releases/container-1.0.0.yaml + --- + distribution_type: 'container' + version: '1.0.0' + project: 'test' + containers: + - name: test-backend + version: 1.0.0-20190806T184921Z + - name: test-frontend + version: 1.0.0-20190806T184921Z - Example of a verbose Jenkins job to call global-jjb macro: -.. code-block:: none +.. note:: - - project: - name: '{project-name}-releases-verify' - project: 'example-test-release' - build-node: centos7-builder-2c-1g - project-name: example-test-release - jobs: - - 'gerrit-releases-verify' + Job should be appended under gerrit-maven-stage + Example of a terse Jenkins job to call global-jjb macro: .. code-block:: none - - project: - name: '{project-name}-releases-merge' - project: 'example-test-release' - build-node: centos7-builder-2c-1g - project-name: example-test-release - jobs: - - 'gerrit-releases-merge' + - gerrit-maven-stage: + sign-artifacts: true + build-node: centos7-docker-8c-8g + maven-versions-plugin: true + - '{project-name}-gerrit-release-jobs': + build-node: centos7-docker-8c-8g .. note:: Release Engineers Please follow the setup guide before adding the job definition: + Setup for LFID Nexus Jenkins and Gerrit: ======================================== @@ -72,8 +87,8 @@ LFID Create an ``lfid`` and an ``ssh-key`` -``RELEASE_USERNAME`` -``RELEASE_EMAIL`` +``YOUR_RELEASE_USERNAME`` for example: onap-release +``YOUR_RELEASE_EMAIL`` for example: collab-it+onap-release@linuxfoundation.org ssh-key example: @@ -82,7 +97,8 @@ ssh-key example: ssh-keygen -t rsa -C "collab-it+odl-release@linuxfoundation.org" -f /tmp/odl-release -`Create an LFID `_ +`Create an LFID with the above values `_ + Nexus ===== @@ -94,41 +110,46 @@ Create a Nexus account called ``'jenkins-release'`` with promote privileges. Gerrit ====== -Log into your Gerrit with ``RELEASE_USERNAME``, upload the ``ssh-key`` you created earlier. +Log into your Gerrit with ``YOU_RELEASE_USERNAME``, upload the publick part of the ``ssh-key`` you created earlier. Log out of Gerrit and log in again with your normal account for the next steps. + In Gerrit create a new group called ``self-serve-release`` and give it direct push rights via ``All-Projects`` -``push - refs/heads/*`` +Add ``YOUR_RELEASE_USERNAME`` to group ``self-serve-release`` and group ``Non-Interactive Users`` -1. Add a push reference -2. Set the ref as refs/heads/* -3. Make sure "force push" is not checked -Add ``RELEASE_USERNAME`` to group ``self-serve-release`` and group ``Non-Interactive Users`` +In All project, grant group self-serve-release the following: + +.. code-block:: none + + [access "refs/heads/*"] + push = group self-serve-release + [access "refs/tags/*"] + createTag = group self-serve-release + createSignedTag = group self-serve-release + forgeCommitter = group self-serve-release + push = group self-serve-release -Give group ``self-serve-release`` Forge Committer rights on ``refs/tags/*`` -Give group ``self-serve-release`` Allow on ``Create Signed Tag`` -Give group ``self-serve-release`` Allow on ``Create Annotated Tag`` Jenkins ======= Add a global credential to Jenkins called ``jenkins-release`` and set the ID: ``'jenkins-release'`` -as its value insert the ``ssh-key`` that you uploaded to Gerrit. +as its value insert the private half of the ``ssh-key`` that you created for your Gerrit user. Add Global vars in Jenkins: Jenkins configure -> Global properties -> Environment variables -``RELEASE_USERNAME = $RELEASE_USERNAME`` -``RELEASE_EMAIL = $RELEASE_EMAIL`` +``RELEASE_USERNAME = YOUR_RELEASE_USERNAME`` +``RELEASE_EMAIL = YOUR_RELEASE_EMAIL`` -Jenkins configure -> Managed Files -> Custom File +Jenkins configure -> Managed Files -> Add a New Config -> Custom File id: signing-pubkey Name: SIGNING_PUBKEY (optional) Comment: SIGNING_PUBKEY (optional) -Content: (ask andy) +Content: (Ask Andy for the public signing key) -----BEGIN PGP PUBLIC KEY BLOCK----- @@ -137,9 +158,9 @@ Jenkins Settings -> Managed files -> Add (or edit) -> Custom file .. code-block:: none - [nexus] + [nexus.example.com] username=jenkins-release - password=redacted + password= Ci-management ============= @@ -166,21 +187,8 @@ Job Templates Release Merge ------------- -Runs: - -- sigul-install -- sigul-configuration -- checkout ref from taglist.log -- applies the $PROJECT.bundle -- signs, tags and pushes - -.. code-block:: bash - - lftools nexus release --server $NEXUS_URL $STAGING_REPO - - :Template Name: - - {project-name}-release-merge-{stream} + - {project-name}-release-merge :Comment Trigger: remerge @@ -189,11 +197,11 @@ Runs: :build-node: The node to run build on. :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set in defaults.yaml) - :stream: run this job against: master + :stream: run this job against: ** :Optional parameters: - :branch: Git branch to fetch for the build. (default: master) + :branch: Git branch to fetch for the build. (default: all) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) :build-timeout: Timeout in minutes before aborting build. (default: 15) :project-pattern: Project to trigger build against. (default: \*\*) @@ -203,38 +211,28 @@ Runs: file modifications will trigger a build. **default**:: - - compare-type: ANT - pattern: 'releases/*.yaml' + - compare-type: REG_EXP + pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)' Release Verify ------------------ -Release verify job checks the schema and ensures that the staging-repo.txt.gz -is available on the job. - -- sigul-install -- sigul-configuration -- checkout ref from taglist.log -- applies the $PROJECT.bundle -- signs and shows signature - - :Template Names: - - {project-name}-release-verify-{stream} + - {project-name}-release-verify :Comment Trigger: recheck|reverify :Required Parameters: :build-node: The node to run build on. - :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set + :jenkins-ssh-credential: Credential to use for SSH. (Generally set in defaults.yaml) - :stream: run this job against: master + :stream: run this job against: ** :Optional Parameters: - :branch: Git branch to fetch for the build. (default: master) + :branch: Git branch to fetch for the build. (default: all) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) :build-node: The node to run build on. :build-timeout: Timeout in minutes before aborting build. (default: 15) @@ -249,5 +247,5 @@ is available on the job. file modifications will trigger a build. **default**:: - - compare-type: ANT - pattern: 'releases/*.yaml' + - compare-type: REG_EXP + pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'