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

doc "Managing custom catalogs" is not correct

XMLWordPrintable

    • Moderate
    • None
    • 2
    • OSDOCS Sprint 232, OSDOCS Sprint 233, OSDOCS Sprint 234, OSDOCS Sprint 235, OSDOCS Sprint 236
    • 5
    • Rejected
    • False
    • Hide

      None

      Show
      None

      Description of problem:

      doc "Managing custom catalogs" is not correct

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

      https://redhat:redhat@docs.openshift.com/container-platform/4.12/operators/admin/olm-managing-custom-catalogs.html

      How reproducible:

      always

      Steps to Reproduce:

      1.Create a Dockerfile that can build a catalog image
      should use bellow command
      opm generate dockerfile <operator_name>
      
      2. Example <operator_name>-index.Dockerfile is not correct, shuld be like bellow
      
      # The base image is expected to contain
      # /bin/opm (with a serve subcommand) and /bin/grpc_health_probe
      FROM quay.io/operator-framework/opm:latest
      
      
      # Configure the entrypoint and command
      ENTRYPOINT ["/bin/opm"]
      CMD ["serve", "/configs", "--cache-dir=/tmp/cache"]
      
      
      # Copy declarative config root into image at /configs and pre-populate serve cache
      ADD catalog /configs
      RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
      
      
      # Set DC-specific label for the location of the DC root directory
      # in the image
      LABEL operators.operatorframework.io.index.configs.v1=/configs
      
      

      Actual results:

      opm validate passes successfully, but the pod for the index fails with:
      
      Error: compute digest: compute hash: write tar: stat .: os: DirFS with empty root

      Expected results:

      Catalog is served successfully.

      Additional info:

      Acceptance criteria:
      
      The opm CLI generates a differently-formatted Dockerfile in OCP 4.12, per https://github.com/operator-framework/operator-registry/pull/1033. Previously, the docs were providing an example Dockerfile because the "generate dockerfile" command was still in alpha. However, the command was graduated out of alpha via https://github.com/operator-framework/operator-registry/pull/902, which made it downstream starting with OCP 4.11, so the procedure can switch to using that command instead.
      
      The CLI reference docs can also be updated for the now-GA "generate" subcommands: https://docs.openshift.com/container-platform/4.12/cli_reference/opm/cli-opm-ref.html
      
      Backport changes to 4.11, as well.

            rhn-support-adellape Alex Dellapenta
            rhn-support-xzha Xia Zhao
            Xia Zhao Xia Zhao
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: