OLM and Bundle CLI Overview
This document gives an overview of using operator-sdk
to work with Operator manifests related to OLM,
namely bundles and package manifests. See the manifests generation
doc for an in-depth discussion of these commands.
Commands
OLM installation
The following operator-sdk
subcommands manage an OLM installation:
olm install
: install a particular version of OLM.olm status
: check the status of a particular version of OLM running in a cluster. This command can infer the version of an error-free OLM installation.olm uninstall
: uninstall a particular version of OLM running in a cluster. This command can infer the version of an error-free OLM installation.
Manifests and metadata
The following make
recipes and operator-sdk
subcommands create or interact with Operator package manifests and bundles:
generate kustomize manifests
: creates kustomize bases and akustomization.yaml
inconfig/manifests
.
Bundles
make bundle
: runs the following commands:generate kustomize manifests
: see above.generate bundle
: creates a new or updates an existing bundle in the<project-root>/bundle
directory. This command generates both manifests and metadata.bundle validate
: validates an Operator bundle image or unpacked manifests and metadata.
make bundle-build
: builds a bundle image using thebundle.Dockerfile
generated bymake bundle
.
Package Manifests
generate packagemanifests
: creates a new or updates an existing versioned directory as part of the package manifests in the<project-root>/packagemanifests
directory.run packagemanifests
: runs an Operator’s package manifests format with an existing OLM installation.
Last modified July 20, 2020: *: remove legacy CLI docs (#3455) (132dbe2c)