CKI pipeline configuration options
All pipelines share the same code and make decisions based on the passed configuration options in form of trigger variables. Other tools interacting with the pipeline may also need to do the same, one such example would be reporter which needs to know where to send emails for the pipeline.
All the options below are in alphabetical order.
Note that this list does not contain internal pipeline variables that are technically possible to be overridden but are not meant to be touched, such as
rpmbuild
options orccache
related variables.
For variables required by triggers but not needed for the pipeline run itself, please refer to the pipeline triggers documentation.
Pipeline configuration option list
The pipeline and tooling handles both
True
andtrue
(similarly withFalse/false
). For simplicity, only capitalized values are mentioned below.
-
architectures
: Space-separated list of architectures to run the pipeline for, in RPM architecture format. Required in every pipeline. -
ARTIFACT_*
: Information about where to find original pipeline artifacts if short pipelines are requested viatests_only=true
. Used by the CI bot. MUST NOT BE USED IN PRODUCTION. -
artifacts_mode
: Where pipeline artifacts should be stored, can bes3
orgitlab
, defaults tos3
. -
branch
: Target branch of the kernel repository that should be built and tested. Used in reporting and messaging, not in the pipeline itself.commit_hash
must be provided for a correct pipeline run. -
brew_task_id
: Brew or Koji task ID. Only applicable to Brew/Koji pipelines. -
build_selftests
:True
if any kernel selftests should be built,False
otherwise. Defaults toFalse
. Will causemake kselftest-merge
configuration target to be called. Has to be used together withtest_debug
option (as the selftest config target pulls in debug options). Only applicable to kernels built as tarballs. NOTE selftests build is currently only supported fordebug
builds onx86_64
architecture, other architectures are skipped. -
builder_image
: Container image used for kernel building. Defaults toquay.io/cki/builder-rawhide
. -
checkout_contacts
: A string representing a JSON-encoded list of emails involved with the KCIDB checkout. Defaults to ‘[]’. -
CKI_DEPLOYMENT_ENVIRONMENT
:retrigger
if the pipeline is a retrigger for testing and should be ignored by all tooling. Defaults toproduction
. -
commit_hash
: Commit to check out from the repository. Required if a kernel needs to be built. For MR child pipelines, this is set toCI_COMMIT_SHA
. -
compiler
: Which compiler toolchain to use to build the kernel. Can begcc
orclang
, defaults togcc
. Specific behavior ofclang
differs on supported functionality with Fedora configuration for given architecture. Has effect only when a kernel is built. -
source_package_name
: Name of the kernel package. Defaults tokernel
. -
config_target
:make
configuration target to use on top of Fedora configuration files. Defaults toolddefconfig
. Only applicable to kernels built as tarballs. -
copr_build
: Task ID of a COPR build, similar tobrew_task_id
. Only applicable to COPR pipelines. -
coverage
:True
to build a kernel with code coverage. Defaults toFalse
. -
coverage_dirs
: Space-separated list of kernel source directories to capture coverage data for. Has effect withcoverage=True
only. Default value is specified in kpet-db repository. -
cover_letter
: Link to a cover letter, if patch series are being tested and a cover letter exists. Optional. -
disttag_override
: Override for the RPM%dist
macro of the builder container image. This is necessary if the built kernel belongs to a different distribution release, e.g..el8_3
for a RHEL 8.3 kernel built on thebuilder-rhel
container image which has a%dist
macro of.el8
. Only applicable to kernels built as RPMs. -
domains
: A space-separated list of regular expressions fully-matching names or slash-separated paths of kpet “host domains” to restrict test execution to. All tests targeting hosts in the matching domains will be executed once for each of the regular expressions. Runkpet domain tree
to see available domains. If empty, tests will be executed once in all domains. Defaults toavailable
. -
download_separate_headers
: Iftrue
, download separate kernel-headers binary from koji. Defaults tofalse
. Useful if the headers are not part of the base kernel package. Only applicable to Brew/Koji/COPR pipelines. -
extra_baseline_run_set_patterns
: Space-separated string representing test set patterns of runs to add to the pipeline. Useful if baseline-like runs are needed to be executed on top of targeted testing. Defaults to an empty string, i.e. no extra runs. -
force_baseline
: Iftrue
, MR pipeline runs won’t run targeted testing but will pretend to be a git baseline run. Defaults tofalse
. -
git_url
: URL of the kernel repository that should be built and tested. Only used when a kernel is built. -
git_url_cache_owner
: The file name for the git cache is determined asowner.repo
from the git URL. Explicitly set this variable to override the owner component for the git cache used forgit_url
. -
image_tag
: Container tag used for all container images in the pipeline. Defaults toproduction
. -
kernel_config_url
: URL to a kernel configuration to use as a base for the built kernel. Optional, defaults to empty string. If not provided, Fedora rawhide configuration files are used. -
kernel_type
:upstream
orinternal
. Used by DataWarehouse and KCIDB submitter to determine whether the kernel build is internal, or can be shared publicly. Defaults tointernal
. -
kernel_version
Version part of the build NVR. Required for Brew/Koji/COPR builds. For builds done by CKI, it is determined in the pipeline. -
kpet_extra_components
: A regular expression matching kpet’s build “components” to consider included into the kernel being tested, along with automatically-detected ones. See the output ofkpet component list
for a list and description of recognized components. -
kpet_high_cost
: Override for kpet’s--high-cost
option. Defaults totriggered
. See the output ofkpet run generate --help
command for possible values. -
kpet_tree_family
: Value to pass to kpet tree selection script to pick appropriate test definitions. -
kpet_tree_name
: Automatically determined fromkpet_tree_family
and kpet tree selection script by default. Useful only as an override, e.g. for testing the CI pipelines. If defined, must match a kpet tree name as returned bykpet tree list
. -
KPET_ADDITIONAL_VARIABLES
: Additional environment variables that should be passed as variables to kpet. Only for pipelines triggered via the CI bot. MUST NOT BE USED IN PRODUCTION. -
make_target
:targz-pkg
ifmake targz-pkg
should be used for building the kernel,rpm
ifrpmbuild
should be used. Defaults torpm
. NOTE should be renamed tobuild_target
in the future to reflect not all kernels are build using themake
command. -
merge_branch
: Required ifmerge_tree
is specified. Name of the branch which should be merged into the tested kernel tree before patch application. -
merge_tree
: Optional. Link to a kernel repository that should be merged into the tested kernel tree before patch application. Seemerge_branch
for specifying the branch name. -
merge_tree_cache_owner
: The file name for the git cache is determined asowner.repo
from the git URL. Explicitly set this variable to override the owner component for the git cache used formerge_tree
. -
message_id
: Value of aMessage-ID
header, typically of the last email of the patch series. If specified, email report will be sentIn-Reply-To
of this email. If missing, email report will be sent without any threading. -
mr_diff_base_hash
: Source branch base commit, i.e. the last commit that is not part of the merge request. -
mr_id
: ID of the merge request that should be tested. Only applicable to kernels living in GitLab, where changes are not submitted as email patches but as merge requests. -
mr_source_branch_hash
: Source branch HEAD commit ifcommit_hash
points to a merge commit. For MR child pipelines, this is set toCI_MERGE_REQUEST_SOURCE_BRANCH_SHA
. -
name
: Pipeline type identifier, used e.g. in tree filtering in Data Warehouse. Typically contains upstream subtree name or distribution release, e.g.mainline.kernel.org
orkernel-rt-rhel83
. NOTE this variable is deprecated as it is ambiguous and must not be used in new code. -
native_architectures
: Space-separated list of RPM architectures supported by RHEL >= 8 other thanx86_64
that should use native compilation (aarch64
,s390x
,ppc64le
). This requires native gitlab-runners to be set up for that purpose. Currently, this is only the case foraarch64
. Defaults toaarch64
. -
native_tools
:True
if kernel tools should be built separately from kernel on a native architecture. Defaults toFalse
. Only available for kernels built as RPMs which have the required kernel features backported. -
package_name
: Name of the kernel variant, e.g.kernel
orkernel-rt
. Required for kernels built as RPMs (both ones built in the pipeline and by build systems) as boot test uses the value. Defaults tokernel
. -
patch_urls
: Links to raw patches or mboxes to apply, in a form of space-separated string. Patches are applied usinggit am
. -
patchwork_url
: Link to a Patchwork instance, if Patchwork is the origin of the patches. Used to properly grab patch names, as all patches downloaded from patchwork are calledmbox
. -
publish_elsewhere
: IfTrue
, publish the kernel repository on a Red Hat internal server. Defaults toFalse
. Useful when testing private kernels which are not accessible by the test environment. -
repo_name
: COPR repository name in a formatusername/copr
, if a COPR build is supposed to be tested. -
report_rules
: JSON encoded list of reporting rules for the current checkout. -
rpmbuild_with
: Space-separated strings marking a set of--with
options to be added to therpmbuild
command. Only applicable to kernels packaged as RPMs. Defaults to an empty string (no extra options added). -
rt_kernel
:True
if realtime kernel configuration options should be enabled for tarball packaged kernels. Defaults toFalse
. -
run_redhat_self_test
:True
if the pipeline should run the kernel’sredhat/self-test
testsuite. Defaults toFalse
. -
scratch
:True
if the kernel build is a scratch build (Brew/Koji) or is triggered by a merge request,False
if not. Defaults toTrue
. -
selftest_subsets
: Optional variable specifying a list of space-separated selftest subsets to build. If it’s missing andbuild_selftests
isTrue
, CKI will build all selftest subsets. Only applicable to kernels packaged as tarballs. -
send_pre_test_notification
:True
if an email should be sent to a patch or build submitter before testing starts. Defaults toFalse
. The email contains links to Beaker jobs for people to follow, thus is only useful for internal contributors. NOTE After migrating to UPT this notification will make no sense as there will be no test logs available in the Beaker jobs, and thus the option may end up being removed or reworked. -
send_ready_for_test_pre
:True
if the UMB messenger should send a “ready for test” message for parallel testing. Defaults toFalse
. -
send_ready_for_test_post
:True
if the UMB messenger should send a “ready for test” message for post-CKI testing (e.g. performance testing). Defaults toFalse
. -
send_report_to_upstream
:True
if the email report should be sent to the contributors. Causes the triggers to add emails to themail_to
,mail_cc
andmail_bcc
trigger variables and the reporter to send the email to them. NOTE recipient handling is being reworked and this variable will be removed later. -
server_url
: Value of the--server
option of thekoji
command to use to retrieve builds. Required for Brew/Koji pipelines and for COPR pipelines usingdownload_separate_headers
. -
skip_beaker
:True
if only a dry run for submitting a test job is needed. Defaults toTrue
in CI runs, toFalse
otherwise. -
skip_build
:True
if the build stage should be skipped in the pipeline. Useful for only running testing with already existing kernels. Defaults toFalse
. -
skip_createrepo
:True
if the createrepo stage should be skipped in the pipeline. Useful for only running testing with already existing kernels. Defaults toFalse
. -
skip_kernel_installation
:True
if the kernel installation task (Boot test - kpkginstall) should be skipped. Useful for external provisioner or systems which have a preconfigured kernel already installed. Defaults toFalse
. -
skip_merge
:True
if the merge stage should be skipped in the pipeline. Useful for only running testing with already existing kernels. Defaults toFalse
. -
skip_publish
:True
if the publish stage should be skipped in the pipeline. Useful for only running testing with already existing kernels. Defaults toFalse
. -
skip_results
:True
if result summary and known issue detection should be disabled. Defaults toFalse
. -
skip_setup
:True
if the setup stage should be skipped. Defaults toFalse
. -
skip_test
:True
if the test stage should be skipped. Defaults toFalse
. -
srpm_make_target
:make
target to build SRPM. Defaults torh-srpm
. -
subject
: Email subject to use with email reports for the test results, will be prefixed with the result summary. If missing, a generic subject mentioning the kernel version and pipeline name will be built. -
submitter
: Email of the patch or build submitter. -
test_debug
:True
if the debug kernels should also be tested. Defaults toFalse
. Onlyx86_64
debug builds and tests are implemented. -
test_priority
: Priority for submitting test jobs. Can below
,medium
,normal
,high
orurgent
. Defaults tonormal
. NOTE not every provisioner supports test run priorities. USE RESPONSIBLY. -
test_runner
: Where to run testing. Currently available runners areaws
(limited testing available in virtual machines) andbeaker
. Defaults tobeaker
. -
test_set
: Test set(s) to run for the pipeline, in the kpet generate-s
option syntax. By default, all sets are included for patch runs (and tests are picked via patch analysis) and official kernel builds are limited to sanitykt0
testing. Also check out documentation for targeted testing for builds on how to limit test sets for a single build. -
tests_regex
: If specified, tests names have tofullmatch()
this regular expression to run. Can be combined withtest_set
to only run specific tests from the set(s). Not meant for production use as the test names can change, always usetest_set
for production. Current list of test names can be retrieved by running kpet test list. -
test_upt
:True
if the pipeline is for running UPT smoke tests. Defaults toFalse
, i.e. generate the Beaker XML with kpet. -
top_url
: Value of the--topurl
option of thekoji
command to use to retrieve builds. Required for Brew/Koji pipelines and for COPR pipelines usingdownload_separate_headers
. -
trigger_job_name
: TheCI_JOB_NAME
which triggered the pipeline. Useful for consumers of downstream pipeline webhook events such as the kernel-webhook’s ckihook. A regular downstream pipeline is expected to be named using the following format:<RHELMAJOR>_<VARIANT>_<TYPE>_<SECLEVEL>
:<RHELMAJOR>
: RHEL major version, i.e.rhel8
or for CentOS Streamc9s
,c10s
, etc.<VARIANT>
: optional and can beautomotive
,realtime
orrealtime[_-]check
<TYPE>
:baseline
ormerge[_-]request
<SECLEVEL>
: optional; onlyprivate
is a valid value
There are also special coverage and shadow builds enabled for specific setups. These conform to the schema of
<RHELMAJOR>_<VARIANT>_baseline_coverage_build
and<CENTOSMAJOR>_<RHELMAJOR>_compat_<TYPE>
. Note that the<RHELMAJOR>
in case<CENTOSMAJOR>
is used as well matches the RHEL name, not the CentOS Stream name. -
upt_smoke_tests
: Space-separated list of UPT smoke tests to run. Defaults to all available smoke tests (See pipeline variables). Has effect only iftest_upt
isTrue
. -
watch_branch
Git branch to watch to trigger testing on changes. Defaults tobranch
. For use with baseline trigger only. -
watch_url
: Git repo URL to watch to trigger testing on changes. Defaults togit_url
. For use with baseline trigger only. -
web_url
: Value of the--weburl
option of thekoji
command to use to retrieve builds. Required for Brew/Koji pipelines and for COPR pipelines usingdownload_separate_headers
.