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

The help message of "opm alpha render-graph" is not correct

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Normal Normal
    • None
    • 4.12
    • OLM
    • None
    • Moderate
    • [OLM-224] FBC/PSA - Pikachu
    • 1
    • False
    • Hide

      None

      Show
      None
    • NA
    • Done

      Description of problem:

      The help message of "opm alpha render-graph" is not correct, it generates mermaid-formatted view of upgrade graphs of operators in an index, not a bundle, so the input should be index-image or fbc-dir, not a bundle-image.

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

      testing PR: https://github.com/openshift/operator-framework-olm/pull/377
      
      zhaoxia@xzha-mac operator-framework-olm % opm version
      Version: version.Version{OpmVersion:"27e287d4b", GitCommit:"27e287d4bd160d0c8546f98a2288137e804d1ab6", BuildDate:"2022-09-06T07:10:09Z", GoOs:"darwin", GoArch:"amd64"}

      How reproducible:

      always

      Steps to Reproduce:

      1.opm alpha render-graph -h
      zhaoxia@xzha-mac operator-framework-olm % bin/opm alpha render-graph -h
      Generate mermaid-formatted view of upgrade graphs of operators in an index
      
      
      Usage:
        opm alpha render-graph [index-image | fbc-dir | bundle-image] [flags]
      
      
      Examples:
      
      
      #
      # Output channel graph of a catalog in mermaid format
      #
      $ opm alpha render-graph quay.io/operatorhubio/catalog:latest
      
      
      #
      # Output channel graph of a catalog and generate a scaled vector graphic (SVG) representation
      # Note:  this pipeline filters out the comments about lacking skipRange support
      #
      $ opm alpha render-graph quay.io/operatorhubio/catalog:latest | \
          grep -Ev '^<!--.*$' | \
          docker run --rm -i -v "$PWD":/data ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -o /data/operatorhubio-catalog.svg
      
      
      # Note:  mermaid has a default maxTextSize of 30 000 characters.  To override this, generate a JSON-formatted initialization file for
      # mermaid like this (using 300 000 for the limit):
      $ cat << EOF > ./mermaid.json
      { "maxTextSize": 300000 }
      EOF
      # and then pass the file for initialization configuration, via the '-c' option, like:
      $ opm alpha render-graph quay.io/operatorhubio/catalog:latest | \
          grep -Ev '^<!--.*$' | \
          docker run --rm -i -v "$PWD":/data ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -c /data/mermaid.json -o /data/operatorhubio-catalog.svg
      
      
      
      
      		
      
      
      Flags:
        -h, --help                  help for render-graph
            --minimum-edge string   the channel edge to be used as the lower bound of the set of edges composing the upgrade graph
      
      
      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.
      3.
      

      Actual results:

      Usage:   opm alpha render-graph [index-image | fbc-dir | bundle-image] [flags]

      Expected results:

      Usage:   opm alpha render-graph [index-image | fbc-dir] [flags]

      Additional info:

       

            rh-ee-jkeister Jordan Keister
            rhn-support-xzha Xia Zhao
            Xia Zhao Xia Zhao
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: