Skip to content

Clarify default channel behavior when no channels field is specified in ImageSetConfiguration #114629

Description

@redhat-chai-bot

Summary

The documentation for oc-mirror v2 operator catalog filtering (module oc-mirror-operator-catalog-filtering.adoc) does not explicitly state that when no channels: field is specified for an operator package in the ImageSetConfiguration, all channels of that package are included in the mirroring set.

Current wording (Scenario 3)

The current text reads:

"One bundle, corresponding to the head version for each channel of that package."

While this is technically accurate, the phrase "each channel" only implies that all channels are included. Users have to read carefully to understand this — it is easy to misinterpret as meaning only the default channel is mirrored.

Suggested improvement

Add an explicit clarification, for example:

"When no channels field is specified for a package, oc-mirror includes all channels of that package and mirrors the head bundle from each one. To mirror only specific channels, add a channels block listing the desired channel names."

This would help users understand the potentially large scope of an unfiltered package specification and make an informed decision about whether to add explicit channel filters.

Context

This came up during a support discussion where the behavior was initially misunderstood. The oc-mirror team confirmed that the default is to mirror all channels when no channels: field is specified.

Activity

  1. Khushboo1206 commented on Aug 12, 2026

    @Khushboo1206

    Hi, I'd like to work on this issue and submit a PR to clarify the default channel behavior in Scenario 3. Is it okay if I take this one?

  2. added a commit that references this issue on Aug 17, 2026
    88678aa
  3. openshift-ci commented on Nov 11, 2026

    @openshift-ci

    Issues go stale after 90d of inactivity.

    Mark the issue as fresh by commenting /remove-lifecycle stale.
    Stale issues rot after an additional 30d of inactivity and eventually close.
    Exclude this issue from closing by commenting /lifecycle frozen.

    If this issue is safe to close now please do so with /close.

    /lifecycle stale

  4. added
    lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.
    on Nov 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions