Chapter 6. opm CLI
6.1. Installing the opm CLI
6.1.1. About the opm CLI
The opm CLI tool is provided by the Operator Framework for use with the Operator bundle format. This tool allows you to create and maintain catalogs of Operators from a list of Operator bundles that are similar to software repositories. The result is a container image which can be stored in a container registry and then installed on a cluster.
A catalog contains a database of pointers to Operator manifest content that can be queried through an included API that is served when the container image is run. On OpenShift Container Platform, Operator Lifecycle Manager (OLM) can reference the image in a catalog source, defined by a CatalogSource object, which polls the image at regular intervals to enable frequent updates to installed Operators on the cluster.
Additional resources
- See Operator Framework packaging format for more information about the bundle format.
- To create a bundle image using the Operator SDK, see Working with bundle images.
6.1.2. Installing the opm CLI
You can install the opm CLI tool on your Linux, macOS, or Windows workstation.
Prerequisites
For Linux, you must provide the following packages. RHEL 8 meets these requirements:
-
podmanversion 1.9.3+ (version 2.0+ recommended) -
glibcversion 2.28+
-
Procedure
- Navigate to the OpenShift mirror site and download the latest version of the tarball that matches your operating system.
Unpack the archive.
For Linux or macOS:
$ tar xvf <file>
- For Windows, unzip the archive with a ZIP program.
Place the file anywhere in your
PATH.For Linux or macOS:
Check your
PATH:$ echo $PATH
Move the file. For example:
$ sudo mv ./opm /usr/local/bin/
For Windows:
Check your
PATH:C:\> path
Move the file:
C:\> move opm.exe <directory>
Verification
After you install the
opmCLI, verify that it is available:$ opm version
6.1.3. Additional resources
-
See Managing custom catalogs for
opmprocedures including creating, updating, and pruning catalogs.
6.2. opm CLI reference
The opm command-line interface (CLI) is a tool for creating and maintaining Operator catalogs.
opm CLI syntax
$ opm <command> [<subcommand>] [<argument>] [<flags>]
| Flag | Description |
|---|---|
|
| Skip TLS certificate verification for container image registries while pulling bundles or indexes. |
The SQLite-based catalog format, including the related CLI commands, is a deprecated feature. Deprecated functionality is still included in OpenShift Container Platform and continues to be supported; however, it will be removed in a future release of this product and is not recommended for new deployments.
For the most recent list of major functionality that has been deprecated or removed within OpenShift Container Platform, refer to the Deprecated and removed features section of the OpenShift Container Platform release notes.
6.2.1. generate
Generate various artifacts for declarative config indexes.
Command syntax
$ opm generate <subcommand> [<flags>]
| Subcommand | Description |
|---|---|
|
| Generate a Dockerfile for a declarative config index. |
| Flags | Description |
|---|---|
|
| Help for generate. |
6.2.1.1. dockerfile
Generate a Dockerfile for a declarative config index.
This command creates a Dockerfile in the same directory as the <dcRootDir> (named <dcDirName>.Dockerfile) that is used to build the index. If a Dockerfile with the same name already exists, this command fails.
When specifying extra labels, if duplicate keys exist, only the last value of each duplicate key gets added to the generated Dockerfile.
Command syntax
$ opm generate dockerfile <dcRootDir> [<flags>]
| Flag | Description |
|---|---|
|
|
Image in which to build catalog. The default value is |
|
|
Extra labels to include in the generated Dockerfile. Labels have the form |
|
| Help for Dockerfile. |
To build with the official Red Hat image, use the registry.redhat.io/openshift4/ose-operator-registry:v4.11 value with the -i flag.
6.2.2. index
Generate Operator index for SQLite database format container images from pre-existing Operator bundles.
As of OpenShift Container Platform 4.11, the default Red Hat-provided Operator catalog releases in the file-based catalog format. The default Red Hat-provided Operator catalogs for OpenShift Container Platform 4.6 through 4.10 released in the deprecated SQLite database format.
The opm subcommands, flags, and functionality related to the SQLite database format are also deprecated and will be removed in a future release. The features are still supported and must be used for catalogs that use the deprecated SQLite database format.
Many of the opm subcommands and flags for working with the SQLite database format, such as opm index prune, do not work with the file-based catalog format. For more information about working with file-based catalogs, see "Additional resources".
Command syntax
$ opm index <subcommand> [<flags>]
| Subcommand | Description |
|---|---|
|
| Add Operator bundles to an index. |
|
| Prune an index of all but specified packages. |
|
| Prune an index of stranded bundles, which are bundles that are not associated with a particular image. |
|
| Delete an entire Operator from an index. |
6.2.2.1. add
Add Operator bundles to an index.
Command syntax
$ opm index add [<flags>]
| Flag | Description |
|---|---|
|
|
Container image for on-image |
|
|
Tool to build container images: |
|
| Comma-separated list of bundles to add. |
|
|
Tool to interact with container images, such as for saving and building: |
|
| Previous index to add to. |
|
| If enabled, only creates the Dockerfile and saves it to local disk. |
|
|
Graph update mode that defines how channel graphs are updated: |
|
| Optional: If generating the Dockerfile, specify a file name. |
|
| Allow registry load errors. |
|
|
Tool to pull container images: |
|
| Custom tag for container image being built. |
6.2.2.2. prune
Prune an index of all but specified packages.
Command syntax
$ opm index prune [<flags>]
| Flag | Description |
|---|---|
|
|
Container image for on-image |
|
|
Tool to interact with container images, such as for saving and building: |
|
| Index to prune. |
|
| If enabled, only creates the Dockerfile and saves it to local disk. |
|
| Optional: If generating the Dockerfile, specify a file name. |
|
| Comma-separated list of packages to keep. |
|
| Allow registry load errors. |
|
| Custom tag for container image being built. |
6.2.2.3. prune-stranded
Prune an index of stranded bundles, which are bundles that are not associated with a particular image.
Command syntax
$ opm index prune-stranded [<flags>]
| Flag | Description |
|---|---|
|
|
Container image for on-image |
|
|
Tool to interact with container images, such as for saving and building: |
|
| Index to prune. |
|
| If enabled, only creates the Dockerfile and saves it to local disk. |
|
| Optional: If generating the Dockerfile, specify a file name. |
|
| Comma-separated list of packages to keep. |
|
| Allow registry load errors. |
|
| Custom tag for container image being built. |
6.2.2.4. rm
Delete an entire Operator from an index.
Command syntax
$ opm index rm [<flags>]
| Flag | Description |
|---|---|
|
|
Container image for on-image |
|
|
Tool to build container images: |
|
|
Tool to interact with container images, such as for saving and building: |
|
| Previous index to delete from. |
|
| If enabled, only creates the Dockerfile and saves it to local disk. |
|
| Comma-separated list of Operators to delete. |
|
| Optional: If generating the Dockerfile, specify a file name. |
|
| Comma-separated list of packages to keep. |
|
| Allow registry load errors. |
|
|
Tool to pull container images: |
|
| Custom tag for container image being built. |
6.2.3. init
Generate an olm.package declarative config blob.
Command syntax
$ opm init <package_name> [<flags>]
| Flag | Description |
|---|---|
|
| The channel that subscriptions will default to if unspecified. |
|
|
Path to the Operator’s |
|
| Path to package’s icon. |
|
|
Output format: |
6.2.4. migrate
Migrate a SQLite database format index image or database file to a file-based catalog.
The SQLite-based catalog format, including the related CLI commands, is a deprecated feature. Deprecated functionality is still included in OpenShift Container Platform and continues to be supported; however, it will be removed in a future release of this product and is not recommended for new deployments.
For the most recent list of major functionality that has been deprecated or removed within OpenShift Container Platform, refer to the Deprecated and removed features section of the OpenShift Container Platform release notes.
Command syntax
$ opm migrate <index_ref> <output_dir> [<flags>]
| Flag | Description |
|---|---|
|
|
Output format: |
6.2.5. render
Generate a declarative config blob from the provided index images, bundle images, and SQLite database files.
Command syntax
$ opm render <index_image | bundle_image | sqlite_file> [<flags>]
| Flag | Description |
|---|---|
|
|
Output format: |
6.2.6. serve
Serve declarative configs via a GRPC server.
The declarative config directory is loaded by the serve command at startup. Changes made to the declarative config after this command starts are not reflected in the served content.
Command syntax
$ opm serve <source_path> [<flags>]
| Flag | Description |
|---|---|
|
| Enable debug logging. |
|
|
Port number to serve on. Default: |
|
|
Path to a container termination log file. Default: |
6.2.7. validate
Validate the declarative config JSON file(s) in a given directory.
Command syntax
$ opm validate <directory> [<flags>]
