package
0.0.0-20250403192851-34a345b3f333
Repository: https://github.com/openshift/ci-tools.git
Documentation: pkg.go.dev

# README

ci-operator-checkconfig

This program can be used to perform validation over a set of ci-operator configuration files. It is used in openshift/release to enforce the correctness of all configuration files present there, via a pre-submit job.

It acts mostly as a front-end for the validation code in pkg/validation, which is also used by other components, guaranteeing the configuration files will be usable by them. Since it operates on several thousands of files, the validation code must be efficient and work at scale. Files are validated in parallel and work is reused between them as much as possible.

Validation is performed after loading information from openshift/release and is based on the resolved contents of the configuration files (meaning multi-stage tests are fully expanded), so the same checks done just prior to the actual execution of the test can also be done here. Since all configuration files are loaded, cross-configuration validation can also be performed.

Testing locally

To validate a local copy of openshift/release, simply execute:

ci-operator-checkconfig \
    --config-dir path/to/release/ci-operator/config \
    --registry path/to/release/ci-operator/step-registry \
    --cluster-profiles-config path/to/release/ci-operator/step-registry/cluster-profiles/cluster-profiles-config.yaml 
    …