Skip to content

Improve must-gather image handling and annotation checks #2071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
midu16 wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Improve must-gather image handling and annotation checks #2071

Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8dde6cd
enhance must-gather image collection with CSV annotation warnings
midu16 Aug 7, 2025
4358b67
Merge branch 'openshift:main' into master
midu16 Sep 17, 2025
3845d4b
Fix compile error
midu16 Sep 17, 2025
1554bb5
Merge branch 'openshift:main' into master
midu16 Sep 17, 2025
e9f3105
Revert "Fix compile error"
midu16 Sep 17, 2025
8b0bde2
Merge branch 'openshift:main' into master
midu16 Sep 17, 2025
93561ce
Merge branch 'main' into master
midu16 Nov 26, 2025
4db2557
Merge branch 'openshift:main' into master
midu16 Feb 12, 2026
05dc42e
Fix undefined csvs in mustgather and add CSV annotation warning
midu16 Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions pkg/cli/admin/mustgather/mustgather.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ func (o *MustGatherOptions) completeImages(ctx context.Context) error {
return fmt.Errorf("unable to resolve image stream '%v': %v", imageStream, err)
}
}
// If no images or --all flag is set, use default must-gather image
if len(o.Images) == 0 || o.AllImages {
var image string
var err error
Expand All @@ -288,12 +289,20 @@ func (o *MustGatherOptions) completeImages(ctx context.Context) error {

pluginImages, err = o.annotatedCSVs(ctx)
if err != nil {
return err
return fmt.Errorf("failed to list CSVs: %v", err)
}
for _, csv := range csvs.Items {
ann := csv.GetAnnotations()
if v, ok := ann[mgAnnotation]; ok {
pluginImages[v] = struct{}{}
} else {
o.log("WARNING: CSV operator %s doesn't have the must-gather-image annotation.", csv.GetName())
}
}
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Compile error: csvs is undefined in this scope.

The annotatedCSVs function returns only (map[string]struct{}, error), but lines 294-300 reference csvs.Items which is undefined here. This matches the CI failure reported in PR comments.

To preserve the per-CSV warning behavior, move the warning logic into annotatedCSVs by passing the log function:

🐛 Proposed fix

Update the annotatedCSVs signature and implementation:

-func (o *MustGatherOptions) annotatedCSVs(ctx context.Context) (map[string]struct{}, error) {
+func (o *MustGatherOptions) annotatedCSVs(ctx context.Context, warnMissing bool) (map[string]struct{}, error) {
 	csvGVR := schema.GroupVersionResource{
 		Group:    "operators.coreos.com",
 		Version:  "v1alpha1",
 		Resource: "clusterserviceversions",
 	}
 	pluginImages := make(map[string]struct{})

 	csvs, err := o.DynamicClient.Resource(csvGVR).List(ctx, metav1.ListOptions{})
 	if err != nil {
 		return nil, err
 	}

 	for _, item := range csvs.Items {
 		ann := item.GetAnnotations()
 		if v, ok := ann[mgAnnotation]; ok {
 			pluginImages[v] = struct{}{}
+		} else if warnMissing {
+			o.log("WARNING: CSV operator %s doesn't have the must-gather-image annotation.", item.GetName())
 		}
 	}
 	return pluginImages, nil
 }

Then update the call site and remove the orphaned loop:

-		pluginImages, err = o.annotatedCSVs(ctx)
+		pluginImages, err = o.annotatedCSVs(ctx, true)
 		if err != nil {
 			return fmt.Errorf("failed to list CSVs: %v", err)
 		}
-		for _, csv := range csvs.Items {
-			ann := csv.GetAnnotations()
-			if v, ok := ann[mgAnnotation]; ok {
-				pluginImages[v] = struct{}{}
-			} else {
-				o.log("WARNING: CSV operator %s doesn't have the must-gather-image annotation.", csv.GetName())
-			}
-		}
🤖 Prompt for AI Agents 
In `@pkg/cli/admin/mustgather/mustgather.go` around lines 290 - 301, The undefined
`csvs` bug is caused by moving CSV iteration out of annotatedCSVs; restore
per-CSV warning logic by changing annotatedCSVs to accept the logger (e.g., add
a parameter for o.log or a func like logf) and move the loop that inspects
csvs.Items and emits warnings using mgAnnotation into annotatedCSVs; update
annotatedCSVs' signature (e.g., annotatedCSVs(ctx context.Context, logf
func(string, ...interface{})) (map[string]struct{}, error)), implement the
per-CSV warning there when an annotation is missing, and then call it from
mustgather.go as pluginImages, err = o.annotatedCSVs(ctx, o.log) and remove the
orphaned for-loop in mustgather.go; also update any other callers to match the
new signature.


cos, err := o.ConfigClient.ConfigV1().ClusterOperators().List(ctx, metav1.ListOptions{})
if err != nil {
return err
return fmt.Errorf("failed to list ClusterOperators: %v", err)
}
for _, item := range cos.Items {
ann := item.GetAnnotations()
Expand All @@ -308,7 +317,7 @@ func (o *MustGatherOptions) completeImages(ctx context.Context) error {
}
}
o.log("Using must-gather plug-in image: %s", strings.Join(o.Images, ", "))

return nil
}

Expand Down