General Purpose Jobs

dco-license

A job to validate all new commits have been signed using –signoff.

dhall-diff

Ensure that generated configuration files are idempotent.

This job runs a render command and check that no files are modified.

dhall_render_command
Default: make

The command that render the configuration files.

dhall_version
Default: 1.31.1

The dhall version.

unittests

Perform setup common to all unit test jobs.

This performs basic host and general project setup tasks common to all types of unit test jobs.

unittests-fips

Enable fips and Perform setup common to all unit test jobs.

This performs basic host and general project setup tasks common to all types of unit test jobs related to fips.

markdownlint

Check any markdown for basic lint problems. Include a file named .markdownlint.json that is configured according to https://github.com/DavidAnson/markdownlint#optionsconfig to control rule specifics.

multinode

Do additional setup needed for multi-node jobs such as setting up overlay networks and setting up known-hosts and ssh keys

multinode-fips

Enable fips and do the setup needed for multi-node jobs such as setting up overlay networks and setting up known-hosts and ssh keys

run-test-command

Run simple command as test.

To use this, set the test_command variable to a single command or a list of commands. For complex list of commands, it is recommended to use a single command that runs a proper script.

zuul_work_dir
Default: {{ zuul.project.src_dir }}

Path to operate in.

shake-build

Run the shake build system command.

This job produces a shake.html report.

shake_target

The name of the target to build.

upload-git-mirror

Mirrors a tested project repository to a remote git server.

git_mirror_credentials
Type: dict

This is expected to be a Zuul Secret with these keys:

git_mirror_credentials{}.user

SSH user for the remote git repository

git_mirror_credentials{}.host

SSH host for the remote git repository

git_mirror_credentials{}.ssh_key

Literal private key contents. Should start with something like -----BEGIN RSA PRIVATE KEY-----.

git_mirror_credentials{}.host_key

SSH host key of the remote git server. Can be obtained with ssh-keyscan -H <host>.

git_mirror_repository

Path of the remote git repository

validate-zone-db

Validate zone.db files in project.

Responds to these variables:

zone_files
Default: {{ ansible_user_dir }}/{{ zuul.project.src_dir }}

Search for zone.db files recursively in this directory. Format should be domain.xyz/zone.db, where the parent directory is named for the zone described.

zone_db_list
Default: []

Override the default searching above with explicit domain/path references (see validate-zone-db role)

zuul-tenant-conf-check

Run the zuul-admin tenant-conf-check command.

This requires a partial zuul.conf (it only needs the connection entries, and those without any credential information) and a tenant config file. It will validate the syntax of the tenant config file (but not the job configuration of any projects in the tenants).

zuul_tenant_conf_check_zuul_conf_path

The path to the partial zuul.conf to use. This must contain the connection entries, but no credentials are required. Any other sections are ignored.

zuul_tenant_conf_check_tenant_config_path

The path to the tenant config file to check.

zuul_tenant_conf_check_image
Default: quay.io/zuul-ci/zuul-scheduler:latest

The Zuul scheduler container image which contains the zuul-admin command to run.

zuul_tenant_conf_check_registry_credentials

An optional value, expected in the form of a secret, that supplies credential information if zuul_tenant_conf_check_image is in a registry that requires authentication. The format is a dictionary keyed by the registry name. Example:

zuul_tenant_conf_check_registry_credentials:
  docker.io:
    username: 'username'
    password: 'password'
zuul_tenant_conf_check_registry_credentials.[registry_name]

The dictionary key should be the name of the registry

zuul_tenant_conf_check_registry_credentials.[registry_name].username

The registry username.

zuul_tenant_conf_check_registry_credentials.[registry_name].password

The registry password.