X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=README.md;h=003d7cef6acfed95e96e7419f5772cd275bfc24d;hb=HEAD;hp=3bad6b0fc198074ba095012cc621b6f2b93c0ebf;hpb=0912741cdcac047d4ef2e0d689a0260debc92b32;p=releng%2Fglobal-jjb.git diff --git a/README.md b/README.md index 3bad6b0f..003d7cef 100644 --- a/README.md +++ b/README.md @@ -1,134 +1,47 @@ # Global JJB -The purpose of this repository is store generically define reusable JJB -templates that can be deployed across LF projects. +Global-JJB is a library project containing reusable Jenkins Job Builder +templates. Developed for LFCI to deploy management Jenkins jobs to an LF +managed Jenkins instance, there are other jobs defined which may be helpful +to projects that use the same build technology. The intention is to help +projects save time from having to define their own job templates. -The following variables are necessary to be defined in the Jenkins server as -global environment variables as scripts in this repo expect these variables to -be available. +## Guides -For example: +### [Install](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/) -``` -GIT_URL=ssh://jenkins-$SILO@git.opendaylight.org:29418 -JENKINS_HOSTNAME=jenkins092 -LOGS_SERVER=https://logs.opendaylight.org -NEXUS_URL=https://nexus.opendaylight.org -SILO=releng -``` +- [Jenkins configuration](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#jenkins-configuration) -## Jenkins Plugin Requirements +- [ci-management](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#ci-management) -**Required** +- [Deploy ci-jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#deploy-ci-jobs) -- Config File Provider -- Description Setter -- Gerrit Trigger -- Post Build Script -- SSH Agent -- Workspace Cleanup +- [Deploy packer-jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#deploy-packer-jobs) -**Optional** +### [Configuration](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html) -- Mask Passwords -- MsgInject -- OpenStack Cloud -- Timestamps +- [defaults.yaml](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#defaults-yaml) -## Installing global-jjb +- [Jenkins Files](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#jenkins-files) -global-jjb should be deployed in the ci-management repository's jjb directory as -a submodule. global-jjb is versioned and tagged in Gerrit so installing, -upgrading, and rolling back changes should be simple via the Gerrit tag system. +- [Jenkins CI Jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#jenkins-ci-jobs) -``` - # Choose a global-jjb version to install - GLOBAL_JJB_VERSION=v0.1.0 +- [Log Archiving](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#log-archiving) - # Add the new submodule to ci-management's jjb directory. - # Note: Only needs to be performed once per ci-management repo. - cd jjb/ - git submodule add https://gerrit.linuxfoundation.org/infra/releng/global-jjb +### [Best Practices](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html) - # Checkout the version of global-jjb you wish to deploy. - cd global-jjb - git checkout $GLOBAL_JJB_VERSION +- [JJB YAML Layout](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#jjb-yaml-layout) - # Commit global-jjb version to the ci-management repo. - cd ../.. - git add jjb/global-jjb - git commit -sm "Install global-jjb $GLOBAL_JJB_VERSION" +- [Passing parameters to shell scripts](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#passing-parameters-to-shell-scripts) - # Push the patch to ci-management for review - git review -``` +- [Shell scripts](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#shell-scripts) -## Parameters stored in defaults.yaml +- [Usage of config-file-provider](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#usage-of-config-file-provider) -There are a few project specific parameters that should be stored in the -ci-management repo's defaults.yaml file. +- [Preserving Objects in Variable References](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#preserving-objects-in-variable-references) -**gerrit-server-name**: The name of the Gerrit Server as defined in Gerrit -Trigger global configuration. +- [Using single quotes around variables](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#using-single-quotes-around-variables) -**jenkins-ssh-credential**: The name of the Jenkins Credential to use for ssh -connections. +- [Variable expansion and Defaults](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#variable-expansion-and-defaults) -If you are using GitHub then there are two more parameters which -will need to be placed in the defaults.yaml - -**github-url**: The URL of GitHub. (Default: https://github.com) - -**github-org**: The name of the GitHub organization. - -defaults.yaml: - -``` -- defaults: - name: global - - # lf-infra defaults - jenkins-ssh-credential: opendaylight-jenkins-ssh - gerrit-server-name: OpenDaylight - github-org: lfit -``` - -## Config File Management - -### Logs - -The logs account requires a Maven Settings file created called -**jenkins-log-archives-settings** with a server ID of **logs** containing the -credentials for the logs user in Nexus. - -## Deploying ci-jobs - -The CI job group contains multiple jobs that should be deployed in all LF -Jenkins infra. The minimal configuration needed to deploy the ci-management -jobs is as follows which deploys the **{project-name}-ci-jobs** job group as -defined in **lf-ci-jobs.yaml**. - -ci-management.yaml: - -``` -- project: - name: ci-jobs - - jobs: - - '{project-name}-ci-jobs' - - project: ci-management - project-name: ci-management - build-node: centos7-basebuild-2c-1g -``` - -Required parameters: - -**project**: is the project repo as defined in Gerrit. -**project-name**: is a custom name to call the job in Jenkins. -**build-node**: is the name of the builder to use when building (Jenkins label). - -Optional parameters: - -**branch**: is the git branch to build from. -**jjb-version**: is the version of JJB to install in the build minion. +## For Detail Documentation [Global-JJB](http://docs.releng.linuxfoundation.org/projects/global-jjb)