operator-manifest-tools

operator-manifest-tools

Tooling that enables software release pipelines for operator manifests.

Installation

Binaries

Binaries are available for Linux (amd64, s390x, ppc64le, and arm64) and Darwin (amd64). This tool bundles the crane resolver and uses it by default. Use of alternate or even custom image resolvers is available; please see the sections below.

Docker

The docker images are build on top of the skopeo image available at quay.io/containers/skopeo:latest. This provides the latest skopeo in image for operator-manifest tools to use.

docker run quay.io/operator-framework/operator-manifest-tools:latest version

From source

Cloning the repo and running make should be all that is required to install the library from source.

make install

Commands

Command documentation: Operator Manifest Tools.

Usage:
  operator-manifest-tools [command]

Available Commands:
  completion  generate the autocompletion script for the specified shell
  help        Help about any command
  pinning     Operator manifest image pinning

Flags:
  -h, --help      help for operator-manifest-tools
  -v, --verbose   Print debug output of the command

Use "operator-manifest-tools [command] --help" for more information about a command.

Pinning

Usage

The pinning subcommands are meant to extract a ClusterServiceVersion yaml file in a directory, resolve the images tags to a digest, and replace the image references with tags to images with digests.

The 3 subcommands can be done at one time using the pin command. It is also possible to string the extract, resolve, and replace commands together using Unix/Linux pipes.

Example:

# pin a csv in a directory
operator-manifest-tools pinning pin $MANIFEST_DIR

# equalivent to pin; doesn't generate temporary files for the cmd though
operator-manifest-tools pinning extract $MANIFEST_DIR - | operator-manifest-tools pinning resolve - | operator-manifest-tools pinning replace $MANIFEST_DIR

Using alternate resolvers

If the built in crane resolver is causing issues, there is a built in alternate skopeo resolver. It requires the skopeo binary to be on the host machine. Just run the commands with the option --resolver skopeo

Custom Resolve Scripts

It's possible to replace skopeo with other resolve mechanisms (i.e. docker). The resolve and pin command can take parameters that will override the crane default with a script. Please see hack/resolvers/skopeo.sh for an example using skopeo.