-**jenkins-ssh-credential**: The name of the Jenkins Credential to use for ssh
-connections.
-
-If you are using GitHub then configure the following parameters in defaults.yaml
-
-**git-url**: Set this to the base URL of your GitHub repo. In
-general this should be <https://github.com>. If you are using GitHub
-Enterprise, or some other GitHub-style system, then it should be
-whatever your installation base URL is.
-
-**git-clone-url**: This is the clone prefix used by GitHub jobs. Set this to
-either the same thing as **git-url** or the
-'git@github.com:' including the trailing ':'
-
-**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 jobs that should deploy 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 source control.
-**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.
-
-## Deploying Python jobs
-
-We provide the following Python jobs templates:
-
-### {project-name}-tox-verify-{stream}
-
-Use this job to call python-tox to run builds and tests. The most common
-usage of this job is to run the Coala linter against projects.
-
-```
-- project:
- name: builder
- jobs:
- - '{project-name}-tox-verify-{stream}'
-
- project-name: builder
- project: releng/builder
- build-node: centos7-java-builder-2c-4g
- stream: master
-```
-
-Required parameters:
-
-**project**: is the project repo as defined in source control.
-**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).
-**stream**: typically `master` or matching the build branch. This
- is a useful keywords to map a release codename to a branch. For
- example OpenDaylight uses this to map stream=carbon to
- branch=stable/carbon.
-
-Optional parameters:
-
-**branch**: is the git branch to build from.
-**jjb-version**: is the version of JJB to install in the build minion.
-**tox-dir**: directory containing tox.ini file (default: '')
-**tox-envs**: tox environments to run (default: '')
-
-## Archiving logs in Jobs
-
-There are 2 ways supported for archiving log information:
-
-1) Job creates $WORKSPACE/archives directory and places logs there
-
-This method pushes the entire archives directory to the log server
-in the same structure as configured in the archives directory.
-
-2) Via job variable ARCHIVE_ARTIFACTS using globstar patterns.
-
-In this method a job can define a globstar for example `**/*.log` which then
-causes the archive script to do a globstar search for that pattern and archives
-any files it finds matching.
-
-## Appendix
-
-### ShellCheck
-
-When using ShellCheck to lint global-jjb or any projects that include
-global-jjb as part of their project (common with ci-management repos) then
-we require version 0.4.x of ShellCheck installed on the build vms. This version
-introduces annotations used by shell scripts in this repo.