OCPBUGS-17157: *: filter informers when preconditions are met #3021
+201
−51
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| package labeller | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
| "sync" | ||
|
|
||
| "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/reconciler" | ||
| "github.com/sirupsen/logrus" | ||
| "golang.org/x/sync/errgroup" | ||
| appsv1 "k8s.io/api/apps/v1" | ||
| batchv1 "k8s.io/api/batch/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| rbacv1 "k8s.io/api/rbac/v1" | ||
| apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime/schema" | ||
| "k8s.io/client-go/metadata" | ||
|
|
||
| "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/internal/alongside" | ||
| ) | ||
|
|
||
| func Filter(gvr schema.GroupVersionResource) func(metav1.Object) bool { | ||
| if f, ok := filters[gvr]; ok { | ||
| return f | ||
| } | ||
| return func(object metav1.Object) bool { | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| func JobFilter(getConfigMap func(namespace, name string) (metav1.Object, error)) func(object metav1.Object) bool { | ||
| return func(object metav1.Object) bool { | ||
| for _, ownerRef := range object.GetOwnerReferences() { | ||
| if ownerRef.APIVersion == corev1.SchemeGroupVersion.String() && ownerRef.Kind == "ConfigMap" { | ||
| cm, err := getConfigMap(object.GetNamespace(), ownerRef.Name) | ||
| if err != nil { | ||
| return false | ||
| } | ||
| return HasOLMOwnerRef(cm) | ||
| } | ||
| } | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| var filters = map[schema.GroupVersionResource]func(metav1.Object) bool{ | ||
| corev1.SchemeGroupVersion.WithResource("services"): HasOLMOwnerRef, | ||
| corev1.SchemeGroupVersion.WithResource("pods"): func(object metav1.Object) bool { | ||
| _, ok := object.GetLabels()[reconciler.CatalogSourceLabelKey] | ||
| return ok | ||
| }, | ||
| corev1.SchemeGroupVersion.WithResource("serviceaccounts"): func(object metav1.Object) bool { | ||
| return HasOLMOwnerRef(object) || HasOLMLabel(object) | ||
| }, | ||
| appsv1.SchemeGroupVersion.WithResource("deployments"): HasOLMOwnerRef, | ||
| rbacv1.SchemeGroupVersion.WithResource("roles"): HasOLMOwnerRef, | ||
| rbacv1.SchemeGroupVersion.WithResource("rolebindings"): HasOLMOwnerRef, | ||
| rbacv1.SchemeGroupVersion.WithResource("clusterroles"): HasOLMOwnerRef, | ||
| rbacv1.SchemeGroupVersion.WithResource("clusterrolebindings"): HasOLMOwnerRef, | ||
| apiextensionsv1.SchemeGroupVersion.WithResource("customresourcedefinitions"): func(object metav1.Object) bool { | ||
| for key := range object.GetAnnotations() { | ||
| if strings.HasPrefix(key, alongside.AnnotationPrefix) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| }, | ||
| } | ||
|
|
||
| func Validate(ctx context.Context, logger *logrus.Logger, metadataClient metadata.Interface) (bool, error) { | ||
|
There was a problem hiding this comment. Will it be safe to remove this check at some point, e.g. after we know everything has been labeled? There was a problem hiding this comment. Yes, whenever we are at a version where all upgrade paths have gone through some state that has the labeling controller in, we can remove this precondition, the label controllers, etc, and just filter by default. There was a problem hiding this comment. Would it be useful to place a sentinel ConfigMap somewhere that indicates 100% labeling, and check for that, so we don't have to list all the things each time we startup? There was a problem hiding this comment. There's no capital C consistent way to ensure that is always correct, since storage can be sharded by resource. We're only doing partial object metadata lists here, so I think it should be ok? There was a problem hiding this comment. Actually ... for Jobs we need the spec 🤦 There was a problem hiding this comment. Found a workaround for jobs that does not need the spec. |
||
| okLock := sync.Mutex{} | ||
| var ok bool | ||
| g, ctx := errgroup.WithContext(ctx) | ||
| allFilters := map[schema.GroupVersionResource]func(metav1.Object) bool{} | ||
| for gvr, filter := range filters { | ||
| allFilters[gvr] = filter | ||
| } | ||
| allFilters[batchv1.SchemeGroupVersion.WithResource("jobs")] = JobFilter(func(namespace, name string) (metav1.Object, error) { | ||
| return metadataClient.Resource(corev1.SchemeGroupVersion.WithResource("configmaps")).Namespace(namespace).Get(ctx, name, metav1.GetOptions{}) | ||
| }) | ||
| for gvr, filter := range allFilters { | ||
| gvr, filter := gvr, filter | ||
| g.Go(func() error { | ||
| list, err := metadataClient.Resource(gvr).List(ctx, metav1.ListOptions{}) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to list %s: %w", gvr.String(), err) | ||
| } | ||
| var count int | ||
| for _, item := range list.Items { | ||
| if filter(&item) && !hasLabel(&item) { | ||
| count++ | ||
| } | ||
| } | ||
| if count > 0 { | ||
| logger.WithFields(logrus.Fields{ | ||
| "gvr": gvr.String(), | ||
| "nonconforming": count, | ||
| }).Info("found nonconforming items") | ||
| } | ||
| okLock.Lock() | ||
| ok = ok && count == 0 | ||
| okLock.Unlock() | ||
| return nil | ||
| }) | ||
| } | ||
| if err := g.Wait(); err != nil { | ||
| return false, err | ||
| } | ||
| return ok, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we add some unit tests around this package?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What would you like to see? I held off since most of the logic in here is very thin implementation on top of client calls and seemed like it could be validated by inspection.