Uploaded image for project: 'OpenShift CFE'
  1. OpenShift CFE
  2. CFE-859

Improve user experience of oc-mirror by clarifying the flags used for oci local catalogs

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Undefined Undefined
    • openshift-4.14
    • None
    • None
    • None
    • Improvement
    • 8
    • False
    • None
    • False
    • Enhancement

      As IBM, I would like to replace flag  --use-oci-feature flag with --include-oci-local-catalogs 

      --use-oci-feature is implying to users that this might be about using oci format for images rather than docker-v2, and this might be hard to understand and generate questions, bugs, and new misunderstood requests.
      For clarity, and before this feature goes GA, this flag will be replaced by --include-local-oci-catalog in 4.14. The --use-oci-feature will be marked deprecated in 4.13, and completely removed in 4.14

       

      As an oc-mirror user I want a well documented and intuitive  process
      so that I can effectively and efficiently deliver image artifacts in both connected and disconnected installs with no impact on my current workflow

      Glossary:

      • OCI-FBC operator catalog: catalog image in oci format saved to disk, referenced with oci://path-to-image
      • registry based operator catalog: catalog image hosted on a container registry.

      References:

       

      Acceptance criteria:

      • No regression on oc-mirror use cases that are not using OCI-FBC feature
      • mirrorToMirror use case with oci feature flag should be successful when all operator catalogs in ImageSetConfig are OCI-FBC:
        • oc-mirror -c config.yaml docker://remote-registry --use-oci-feature succeeds
        • All release images, helm charts, additional images are mirrored to the remote-registry in an incremental manner (only new images are mirrored based on contents of the storageConfig)
        • All catalogs OCI-FBC, selected bundles and their related images are mirrored to the remote-registry and corresponding catalogSource and ImageSourceContentPolicy generated
        • All registry based catalogs, selected bundles and their related images are mirrored to the remote-registry and corresponding catalogSource and ImageSourceContentPolicy generated
      • mirrorToDisk use case with the oci feature flag is forbidden. The following command should fail:
        • oc-mirror --from=seq_xx_tar docker://remote-registry --use-oci-feature
      • diskToMirror use case with oci feature flag is forbidden. The following command should fail:

            skhoury@redhat.com Sherine Khoury
            skhoury@redhat.com Sherine Khoury
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: