operator-sdk bundle validate

operator-sdk bundle validate

Validate an operator bundle image

Synopsis

The ‘operator-sdk bundle validate’ command can validate both content and format of an operator bundle image or an operator bundles directory on-disk containing operator metadata and manifests. This command will exit with an exit code of 1 if any validation errors arise, and 0 if only warnings arise or all validators pass.

More information about operator bundles and metadata: https://github.com/operator-framework/operator-registry#manifest-format.

NOTE: if validating an image, the image must exist in a remote registry, not just locally.

  1. operator-sdk bundle validate [flags]

Examples

  1. The following command flow will generate test-operator bundle image manifests
  2. and validate them, assuming a bundle for 'test-operator' version v0.1.0 exists at
  3. <project-root>/deploy/olm-catalog/test-operator/manifests:
  5.   # Generate manifests locally.
  6.   $ operator-sdk bundle create --generate-only
  8.   # Validate the directory containing manifests and metadata.
  9.   $ operator-sdk bundle validate ./deploy/olm-catalog/test-operator
  11. To build and validate an image:
  13.   # Create a registry namespace or use an existing one.
  14.   $ export NAMESPACE=<your registry namespace>
  16.   # Build and push the image using the docker CLI.
  17.   $ operator-sdk bundle create quay.io/$NAMESPACE/test-operator:v0.1.0
  18.   $ docker push quay.io/$NAMESPACE/test-operator:v0.1.0
  20.   # Ensure the image with modified metadata and Dockerfile is valid.
  21.   $ operator-sdk bundle validate quay.io/$NAMESPACE/test-operator:v0.1.0

Options

  1.   -h, --help                   help for validate
  2.   -b, --image-builder string   Tool to extract bundle image data. Only used when validating a bundle image. One of: [docker, podman] (default "docker")

SEE ALSO

Last modified May 27, 2020: bundle validate: update example to force choosing a registry namespace (#3119) (363f7b9d)