Operator Bundle Tooling in Operator SDK

This document gives an overview of using operator-sdk to work with Operator bundles, namely on-disk metadata and manifests, and creating bundles.

Commands

The following operator-sdk subcommands create or interact with Operator manifests, metadata, and bundles:

  • generate csv: creates a new or updates an existing CSV in a manifests/ directory and copies your CRDs to the versioned bundle directory. Read more about this command here.

  • bundle create: creates an Operator bundle from manifests and metadata on disk, or writes bundle metadata to disk. This subcommand has corresponding functionality to opm alpha bundle build. Output and underlying behavior between these commands is the same, except nothing is written to disk unless --generate-only is set (false by default). Refer to opm alpha bundle build docs for more information. CLI differences between these commands:

    operator-sdkopm
    operator-sdk bundle create —default=<channel-name>opm alpha bundle build —default-channel=<channel-name>
    operator-sdk bundle create —generate-onlyopm alpha bundle generate
    operator-sdk bundle create <image-tag>opm alpha bundle build —tag <image-tag>

  • bundle validate: validates an Operator bundle image or unpacked manifests and metadata. This subcommand has corresponding functionality to opm alpha bundle validate. Refer to the opm alpha bundle validate docs for more information. CLI differences between these commands:

    operator-sdkopm
    operator-sdk bundle validate <image-tag>opm alpha bundle validate —tag <image-tag>
    operator-sdk bundle validate <directory>no equivalent

Last modified April 25, 2020: website: update OLM integration docs (#2911) (b48b8c28)