Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-20216

[doc] opm CLI reference

XMLWordPrintable

    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • None
    • Low
    • No
    • None
    • None
    • None
    • None
    • None
    • Release Note Not Required
    • N/A
    • None
    • None
    • None
    • None

      Description of problem:

      https://docs.openshift.com/container-platform/4.14/cli_reference/opm/cli-opm-ref.html#opm-cli-ref-index_cli-opm-ref

      1, lack of "export" subcommand.

      MacBook-Pro:must-gather jianzhang$ opm index 
      generate operator index container images from preexisting operator bundles
      DEPRECATION NOTICE:
      Sqlite-based catalogs and their related subcommands are deprecated. Support for
      them will be removed in a future release. Please migrate your catalog workflows
      to the new file-based catalog format.
      
      
      Usage:
        opm index [command]
      
      Available Commands:
        add               Add operator bundles to an index.
        export            Export an operator from an index into the appregistry format
        prune             prune an index of all but specified packages
        prune-stranded    prune an index of stranded bundles
        rm                delete an entire operator from an index
      
      Flags:
        -h, --help   help for index
      
      Global Flags:
            --skip-tls-verify   skip TLS certificate verification for container image registries while pulling bundles
            --use-http          use plain HTTP for container image registries while pulling bundles
      
      
      MacBook-Pro:must-gather jianzhang$  opm index export 
      WARN[0000] DEPRECATION NOTICE:
      Sqlite-based catalogs and their related subcommands are deprecated. Support for
      them will be removed in a future release. Please migrate your catalog workflows
      to the new file-based catalog format. 
      Error: required flag(s) "index" not set
      Usage:
        opm index export [flags]
      
      
      Flags:
        -c, --container-tool string    tool to interact with container images (save, build, etc.). One of: [none, docker, podman] (default "none")
        -f, --download-folder string   directory where downloaded operator bundle(s) will be stored (default "downloaded")
        -h, --help                     help for export
        -i, --index string             index to get package from
        -p, --package strings          comma separated list of packages to export
      
      
      Global Flags:
            --skip-tls-verify   skip TLS certificate verification for container image registries while pulling bundles
            --use-http          use plain HTTP for container image registries while pulling bundles
      
      

      2, https://docs.openshift.com/container-platform/4.14/cli_reference/opm/cli-opm-ref.html#opm-cli-ref-index-prune-stranded_cli-opm-ref 

      Should remove "–packages" and "–permissive" flags for the `prune-stranded` subcommand.

      MacBook-Pro:must-gather jianzhang$ opm index prune-stranded --help
      prune an index of stranded bundles - bundles that are not associated with a particular package
      
      
      DEPRECATION NOTICE:
      Sqlite-based catalogs and their related subcommands are deprecated. Support for
      them will be removed in a future release. Please migrate your catalog workflows
      to the new file-based catalog format.
      
      
      Usage:
        opm index prune-stranded [flags]
      
      
      Flags:
        -i, --binary-image opm        container image for on-image opm command
        -c, --container-tool string   tool to interact with container images (save, build, etc.). One of: [docker, podman] (default "podman")
        -f, --from-index string       index to prune
            --generate                if enabled, just creates the dockerfile and saves it to local disk
        -h, --help                    help for prune-stranded
        -d, --out-dockerfile string   if generating the dockerfile, this flag is used to (optionally) specify a dockerfile name
        -t, --tag string              custom tag for container image being built
      
      
      Global Flags:
            --skip-tls-verify   skip TLS certificate verification for container image registries while pulling bundles
            --use-http          use plain HTTP for container image registries while pulling bundles 

      3, https://docs.openshift.com/container-platform/4.14/cli_reference/opm/cli-opm-ref.html#opm-cli-ref-index-rm_cli-opm-ref 

      Should remove "-p, --packages" for the `rm` subcommand.

      MacBook-Pro:must-gather jianzhang$  opm index rm --packages
      Error: unknown flag: --packages
      Usage:
        opm index rm [flags]
      
      
      Flags:
        -i, --binary-image opm        container image for on-image opm command
        -u, --build-tool string       tool to build container images. One of: [docker, podman]. Defaults to podman. Overrides part of container-tool.
        -c, --container-tool string   tool to interact with container images (save, build, etc.). One of: [none, docker, podman]
        -f, --from-index string       previous index to delete from
            --generate                if enabled, just creates the dockerfile and saves it to local disk
        -h, --help                    help for rm
        -o, --operators strings       comma separated list of operators to delete
        -d, --out-dockerfile string   if generating the dockerfile, this flag is used to (optionally) specify a dockerfile name
            --permissive              allow registry load errors
        -p, --pull-tool string        tool to pull container images. One of: [none, docker, podman]. Defaults to none. Overrides part of container-tool.
        -t, --tag string              custom tag for container image being built
      
      
      Global Flags:
            --skip-tls-verify   skip TLS certificate verification for container image registries while pulling bundles
            --use-http          use plain HTTP for container image registries while pulling bundles 

      4, https://docs.openshift.com/container-platform/4.14/cli_reference/opm/cli-opm-ref.html#opm-cli-ref-server_cli-opm-ref 

      Should add `--pprof-capture-profiles` flag for the `serve` subcommand.

      MacBook-Pro:must-gather jianzhang$ opm serve --help
      This command serves declarative configs via a GRPC server.
      
      
      NOTE: The declarative config directory is loaded by the serve command at
      startup. Changes made to the declarative config after the this command starts
      will not be reflected in the served content.
      
      
      Usage:
        opm serve <source_path> [flags]
      
      
      Flags:
            --cache-dir string          if set, sync and persist server cache directory
            --cache-enforce-integrity   exit with error if cache is not present or has been invalidated. (default: true when --cache-dir is set and --cache-only is false, false otherwise), 
            --cache-only                sync the serve cache and exit without serving
            --debug                     enable debug logging
        -h, --help                      help for serve
        -p, --port string               port number to serve on (default "50051")
            --pprof-addr string         address of startup profiling endpoint (addr:port format) (default "localhost:6060")
            --pprof-capture-profiles    capture pprof CPU profiles
        -t, --termination-log string    path to a container termination log file (default "/dev/termination-log")
      
      
      Global Flags:
            --skip-tls-verify   skip TLS certificate verification for container image registries while pulling bundles
            --use-http          use plain HTTP for container image registries while pulling bundles 

      5, should also add descriptions for the `completion` and `registry` subcommands.

      MacBook-Pro:must-gather jianzhang$ opm --help
      CLI to interact with operator-registry and build indexes of operator content
      
      
      Usage:
        opm [flags]
        opm [command]
      
      
      Available Commands:
        completion  Generate the autocompletion script for the specified shell
        generate    Generate various artifacts for declarative config indexes
        help        Help about any command
        index       generate operator index container images
        init        Generate an olm.package declarative config blob
        migrate     Migrate a sqlite-based index image or database file to a file-based catalog
        registry    interact with operator-registry database
        render      Generate a stream of file-based catalog objects from catalogs and bundles
        serve       serve declarative configs
        validate    Validate the declarative index config
        version     Print the opm version
      
      MacBook-Pro:must-gather jianzhang$ opm registry --help
      interact with operator-registry database building, modifying and/or serving the operator-registry database
      
      
      DEPRECATION NOTICE:
      Sqlite-based catalogs and their related subcommands are deprecated. Support for
      them will be removed in a future release. Please migrate your catalog workflows
      to the new file-based catalog format.
      
      
      Usage:
        opm registry [command]
      
      
      Available Commands:
        add               add operator bundle to operator registry DB
        prune             prune an operator registry DB of all but specified packages
        prune-stranded    prune an operator registry DB of stranded bundles
        rm                remove operator from operator registry DB
        serve             serve an operator-registry database
      
      
      Flags:
        -h, --help   help for registry
      
      
      Global Flags:
            --skip-tls-verify   skip TLS certificate verification for container image registries while pulling bundles
            --use-http          use plain HTTP for container image registries while pulling bundles
      
      
      Use "opm registry [command] --help" for more information about a command.
      MacBook-Pro:must-gather jianzhang$ opm completion --help
      Generate the autocompletion script for opm for the specified shell.
      See each sub-command's help for details on how to use the generated script.
      
      
      Usage:
        opm completion [command]
      
      
      Available Commands:
        bash        Generate the autocompletion script for bash
        fish        Generate the autocompletion script for fish
        powershell  Generate the autocompletion script for powershell
        zsh         Generate the autocompletion script for zsh
      
      
      Flags:
        -h, --help   help for completion
      
      
      Global Flags:
            --skip-tls-verify   skip TLS certificate verification for container image registries while pulling bundles
            --use-http          use plain HTTP for container image registries while pulling bundles
      
      
      Use "opm completion [command] --help" for more information about a command. 

       

      cc rhn-support-xzha correct me if I'm wrong, thanks!

      Version-Release number of selected component (if applicable):

       

      How reproducible:

      always

      Steps to Reproduce:

      1.
      2.
      3.
      

      Actual results:

       

      Expected results:

       

      Additional info:

       

              rhn-support-mipeter Michael Peter
              rhn-support-jiazha Jian Zhang
              None
              None
              Jian Zhang Jian Zhang
              None
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: