Skip to content

Check declarations

product-check reads explicitly named YAML or JSON files. It uses the delivered CRD to check declarations and can produce public descriptor previews and dependency findings. It does not contact Kubernetes, follow links, read Secrets or apply resources.

From a source checkout:

Terminal window
PUBLISHER_PREFLIGHT_ENABLED=true go run ./cmd/product-check \
--file website/public/examples/harbour-product.yaml

The command is default-off. Set PUBLISHER_PREFLIGHT_ENABLED=true explicitly. For more than one file, repeat --file; this is useful when producers and their consumer are stored separately.

The repository includes three products: two producers and a consumer with named inputs.

Terminal window
PUBLISHER_PREFLIGHT_ENABLED=true go run ./cmd/product-check \
--file docs/examples/composition.yaml

Expect three validated products and a required operational feature of composition. The report tells the operator what is needed. It does not enable that feature.

Add --format json for a machine-readable report. A valid report does not establish current readiness, credentials, endpoint access or a complete deployment. Keep the command’s exit status with its output; partial or failed output is not a pass.

The publisher reference documents exit codes, bounds, namespace handling and the independent browser report viewer. The released image also contains /product-check; use a verified digest and the documented read-only container invocation when you do not want to build from source.