Docker Jobs¶

Job Groups¶

Job groups are a great tool to configure categories of jobs together at the same time. Below the example are some starting point job-groups but we recommend creating your own to ensure that the jobs configured reflect the project’s needs.

An example project:

- job-group:
    name: odl-maven-jobs

    jobs:
      - gerrit-maven-clm
      - gerrit-maven-merge
      - gerrit-maven-release
      - gerrit-maven-verify
      - gerrit-maven-verify-dependencies:
          build-timeout: 180

    mvn-version: mvn35

- project:
    name: aaa
    jobs:
      - odl-maven-jobs

In this example we are using the job-group to assign a list of common jobs to the aaa project. The job-group also hardcodes mvn-version to mvn35 and build-timeout to 180 for all projects using this job-group.

A benefit of this method is for example disabling entire category of jobs by modifying the job-group, insert disable-job: true parameter against the jobs to disable.

Below is a list of Docker job groups:

---
- job-group:
    name: "{project-name}-gerrit-docker-jobs"

    # This job group contains all the recommended jobs that should be deployed
    # for any docker project ci.

    jobs:
      - gerrit-docker-verify
      - gerrit-docker-merge

- job-group:
    name: "{project-name}-github-docker-jobs"

    # This job group contains all the recommended jobs that should be deployed
    # for any docker project ci.

    jobs:
      - github-docker-verify
      - github-docker-merge

Macros¶

lf-docker-get-container-tag¶

Chooses a tag to label the container image based on the ‘container-tag-method’ parameter using the global-jjb script docker-get-container-tag.sh. Use one of the following methods:

If container-tag-method: latest, the literal string ‘latest’ is used.

If container-tag-method: git-describe, the tag is obtained using the git describe command on the repository, which requires that the repository has a git tag. For example, if the most recent tag is ‘v0.48.1’, this method yields a string like ‘v0.48.1’ or ‘v0.48.1-25-gaee2dcb’.

If container-tag-method: yaml-file, the tag is obtained from the YAML file ‘container-tag.yaml’ in the docker-root directory using the top-level entry ‘tag’. Alternately specify the directory with the YAML file in parameter ‘container-tag-yaml-dir’. An example file appears next.

Example container-tag.yaml file:

---
tag: 1.0.0

Optionally, teams can supply their own script to choose the docker tag. Pass the shell script path in optional configuration parameter ‘docker-get-container-tag-script’ which by default is the path to file docker-get-container-tag.sh. The script must create the file ‘env_docker_inject.txt’ in the workspace with a line that assigns a value to shell variable DOCKER_IMAGE_TAG, as shown next.

Example env_docker_inject.txt file:

DOCKER_IMAGE_TAG=1.0.0

lf-docker-build¶

Calls docker build to build the container.

lf-docker-push¶

Calls docker-push.sh script to push docker images.

Job Templates¶

Docker Verify¶

Executes a docker build task.

Template Names:

{project-name}-docker-verify-{stream}
gerrit-docker-verify
github-docker-verify

Comment Trigger:

recheck|reverify post a comment with one of the triggers to launch this job manually. Do not include any other text or vote in the same comment.

Required parameters:

container-public-registry:
build-node:	The node to run build on.
	Docker registry source with base images.
docker-name:	Name of the Docker image.
jenkins-ssh-credential:
	Credential to use for SSH. (Generally should be configured in defaults.yaml)
mvn-settings:	Maven settings.xml file containing credentials to use.

Optional parameters:

build-days-to-keep:
branch:	Git branch to fetch for the build. (default: master)
	Days to keep build logs in Jenkins. (default: 7)
build-timeout:	Timeout in minutes before aborting build. (default: 60)
container-tag-method:
	Specifies the docker tag-choosing method. Options are “latest”, “git-describe” or “yaml-file”. Option git-describe requires a git tag to exist in the repository. Option yaml-file requires a file “container-tag.yaml” to exist in the repository. (default: latest)
container-tag-yaml-dir:
	Directory with container-tag.yaml. (default: $DOCKER_ROOT)
docker-build-args:
	Additional arguments for the docker build command.
docker-get-container-tag-script:
	Path to script that chooses docker tag. (default: ../shell/docker-get-container-tag.sh)
docker-root:	Build directory within the repo. (default: $WORKSPACE, the repo root)
git-url:	URL clone project from. (default: $GIT_URL/$PROJECT)
pre_docker_build_script:
	Build script to execute before the main verify builder steps. (default: a string with only a comment)
post_docker_build_script:
	Build script to execute after the main verify builder steps. (default: a string with only a comment)
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 Gerrit file paths which can be used to filter which file modifications will trigger a build.
github_included_regions:
	Override Github file paths which can be used to filter which file modifications will trigger a build; must match parameter gerrit_trigger_file_paths

container-tag.yaml example:

---
tag: 1.0.0

Docker Merge¶

Executes a docker build task and publishes the resulting images to a specified Docker registry.

Template Names:

{project-name}-docker-merge-{stream}
gerrit-docker-merge
github-docker-merge

Comment Trigger:

remerge post a comment with the trigger to launch this job manually. Do not include any other text or vote in the same comment.

Required parameters:

container-public-registry:
build-node:	The node to run build on.
	Docker registry source with base images.
container-push-registry:
	Docker registry target for the deploy action.
docker-name:	Name of the Docker image.
jenkins-ssh-credential:
	Credential to use for SSH. (Generally should be configured in defaults.yaml)
mvn-settings:	Maven settings.xml file containing credentials to use.

Optional parameters:

build-days-to-keep:
branch:	Git branch to fetch for the build. (default: master)
	Days to keep build logs in Jenkins. (default: 7)
build-timeout:	Timeout in minutes before aborting build. (default: 60)
container-tag-method:
	Specifies the docker tag-choosing method. Options are “latest”, “git-describe” or “yaml-file”. Option git-describe requires a git tag to exist in the repository. Option yaml-file requires a file “container-tag.yaml” to exist in the repository. (default: latest)
container-tag-yaml-dir:
	Directory with container-tag.yaml. (default: $DOCKER_ROOT)
cron:	Cron schedule when to trigger the job. This parameter also supports multiline input via YAML pipe \| character in cases where one may want to provide more than 1 cron timer. No default. Use ‘@daily’ to run daily or ‘H H * * 0’ to run weekly.
docker-build-args:
	Additional arguments for the docker build command.
docker-get-container-tag-script:
	Path to script that chooses docker tag. (default: ../shell/docker-get-container-tag.sh)
docker-root:	Build directory within the repo. (default: $WORKSPACE, the repo root)
git-url:	URL clone project from. (default: $GIT_URL/$PROJECT)
pre_docker_build_script:
	Build script to execute before the main merge builder steps. (default: a string with only a comment)
post_docker_build_script:
	Build script to execute after the main merge builder steps. (default: a string with only a comment)
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 Gerrit file paths which can be used to filter which file modifications will trigger a build.
github_included_regions:
	Override Github file paths which can be used to filter which file modifications will trigger a build; must match parameter gerrit_trigger_file_paths

Sample container-tag.yaml File¶

---
tag: 1.0.0