operator-sdk pkgman-to-bundle

operator-sdk pkgman-to-bundle

Migrates packagemanifests to bundles

Synopsis

‘pkgman-to-bundle’ command helps in migrating OLM packagemanifests to bundles which is the preferred OLM packaging format. This command takes an input packagemanifest directory and generates bundles for each of the versions of manifests present in the input directory. Additionally, it also provides the flexibility to build bundle images for each of the generated bundles.

The generated bundles are always written on disk. Location for the generated bundles can be specified using ‘–output-dir’. If not specified, the default location would be ‘bundle/’ directory.

The base container image name for the bundles can be provided using ‘–image-tag-base’ flag. This should be provided without the tag, since the tag for the images would be the bundle version, (ie) image names will be in the format <base_image>:<bundle_version>.

Specify the build command for building container images using ‘–build-cmd’ flag. The default build command is ‘docker build’. The command will need to be in the ‘PATH’ or fully qualified path name should be provided.

  1. operator-sdk pkgman-to-bundle <packagemanifestdir> [flags]

Examples

  3. # Provide the packagemanifests directory as input to the command. Consider the packagemanifests directory to have the following
  4. # structure:
  6. $ tree packagemanifests/
  7. packagemanifests
  8. └── etcd
  9.     ├── 0.0.1
  10.     │   ├── etcdcluster.crd.yaml
  11.     │   └── etcdoperator.clusterserviceversion.yaml
  12.     ├── 0.0.2
  13.     │   ├── etcdbackup.crd.yaml
  14.     │   ├── etcdcluster.crd.yaml
  15.     │   ├── etcdoperator.v0.0.2.clusterserviceversion.yaml
  16.     │   └── etcdrestore.crd.yaml
  17.     └── etcd.package.yaml
  19. # Run the following command to generate bundles in the default 'bundle/' directory with the base-container image name
  20. # to be 'quay.io/example/etcd'
  21. $ operator-sdk pkgman-to-bundle packagemanifests --image-tag-base quay.io/example/etcd
  22. INFO[0000] Packagemanifests will be migrated to bundles in bundle directory
  23. INFO[0000] Creating bundle/bundle-0.0.1/bundle.Dockerfile
  24. INFO[0000] Creating bundle/bundle-0.0.1/metadata/annotations.yaml
  25. ...
  27. # After running the above command, the bundles will be generated in 'bundles/' directory.
  28. $ tree bundles/
  29. bundles/
  30. ├── bundle-0.0.1
  31. │   ├── bundle
  32. │   │   ├── manifests
  33. │   │   │   ├── etcdcluster.crd.yaml
  34. │   │   │   ├── etcdoperator.clusterserviceversion.yaml
  35. │   │   ├── metadata
  36. │   │   │   └── annotations.yaml
  37. │   │   └── tests
  38. │   │       └── scorecard
  39. │   │           └── config.yaml
  40. │   └── bundle.Dockerfile
  41. └── bundle-0.0.2
  42.     ├── bundle
  43.     │   ├── manifests
  44.     │   │   ├── etcdbackup.crd.yaml
  45.     │   │   ├── etcdcluster.crd.yaml
  46.     │   │   ├── etcdoperator.v0.0.2.clusterserviceversion.yaml
  47.     │   │   ├── etcdrestore.crd.yaml
  48.     │   └── metadata
  49.     │       └── annotations.yaml
  50.     └── bundle.Dockerfile
  52. A custom command to build bundle images can also be specified using the '--build-cmd' flag. For example,
  54. $ operator-sdk pkgman-to-bundle packagemanifests --image-tag-base quay.io/example/etcd --build-cmd "podman build -f bundle.Dockerfile . -t"
  56. Images for the both the bundles will be built with the following names: quay.io/example/etcd:0.0.1 and quay.io/example/etcd:0.0.2.

Options

  1.       --build-cmd string        Build command to be run for building images. By default 'docker build' is run.
  2.   -h, --help                    help for pkgman-to-bundle
  3.       --image-tag-base string   Base container image name for bundle image tags, ex. my.reg/foo/bar-operator-bundle will become my.reg/foo/bar-operator-bundle:${package-dir-name} for each child directory name in the packagemanifests directory
  4.       --output-dir string       Directory to write bundle to. (default "bundles")

Options inherited from parent commands

  1.       --plugins strings   plugin keys to be used for this subcommand execution
  2.       --verbose           Enable verbose logging

SEE ALSO

Last modified June 9, 2021: fix: build-cmd arg in pkgman-to-bundle (#4964) (375acc76)