Skip to content
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

Jump to bottom

OCPBUGS-17157: improve watching semantics around CSVs #3003

Merged
merged 2 commits into from
Aug 4, 2023
Merged

OCPBUGS-17157: improve watching semantics around CSVs #3003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
210a137
operators/catalog: don't watch copied CSVs
stevekuznetsov Aug 3, 2023
fc29ea1
operators/olm: use a partial object metadata watch for copied CSVs
stevekuznetsov Aug 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions cmd/olm/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/sirupsen/logrus"
"github.com/spf13/pflag"
corev1 "k8s.io/api/core/v1"
"k8s.io/client-go/metadata"
"k8s.io/klog"
ctrl "sigs.k8s.io/controller-runtime"

Expand Down Expand Up @@ -154,6 +155,10 @@ func main() {
if err != nil {
logger.WithError(err).Fatal("error configuring custom resource client")
}
metadataClient, err := metadata.NewForConfig(config)
if err != nil {
logger.WithError(err).Fatal("error configuring metadata client")
}

// Create a new instance of the operator.
op, err := olm.NewOperator(
Expand All @@ -162,6 +167,7 @@ func main() {
olm.WithWatchedNamespaces(namespaces...),
olm.WithResyncPeriod(queueinformer.ResyncWithJitter(*wakeupInterval, 0.2)),
olm.WithExternalClient(crClient),
olm.WithMetadataClient(metadataClient),
olm.WithOperatorClient(opClient),
olm.WithRestConfig(config),
olm.WithConfigClient(versionedConfigClient),
Expand Down
46 changes: 25 additions & 21 deletions pkg/controller/operators/catalog/operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,27 +204,31 @@ func NewOperator(ctx context.Context, kubeconfigPath string, clock utilclock.Clo
// Fields are pruned from local copies of the objects managed
// by this informer in order to reduce cached size.
prunedCSVInformer := cache.NewSharedIndexInformer(
pruning.NewListerWatcher(op.client, metav1.NamespaceAll, func(*metav1.ListOptions) {}, pruning.PrunerFunc(func(csv *v1alpha1.ClusterServiceVersion) {
*csv = v1alpha1.ClusterServiceVersion{
TypeMeta: csv.TypeMeta,
ObjectMeta: metav1.ObjectMeta{
Name: csv.Name,
Namespace: csv.Namespace,
Labels: csv.Labels,
Annotations: csv.Annotations,
},
Spec: v1alpha1.ClusterServiceVersionSpec{
CustomResourceDefinitions: csv.Spec.CustomResourceDefinitions,
APIServiceDefinitions: csv.Spec.APIServiceDefinitions,
Replaces: csv.Spec.Replaces,
Version: csv.Spec.Version,
},
Status: v1alpha1.ClusterServiceVersionStatus{
Phase: csv.Status.Phase,
Reason: csv.Status.Reason,
},
}
})),
pruning.NewListerWatcher(op.client, metav1.NamespaceAll,
func(options *metav1.ListOptions) {
options.LabelSelector = fmt.Sprintf("!%s", v1alpha1.CopiedLabelKey)
},
pruning.PrunerFunc(func(csv *v1alpha1.ClusterServiceVersion) {
*csv = v1alpha1.ClusterServiceVersion{
TypeMeta: csv.TypeMeta,
ObjectMeta: metav1.ObjectMeta{
Name: csv.Name,
Namespace: csv.Namespace,
Labels: csv.Labels,
Annotations: csv.Annotations,
},
Spec: v1alpha1.ClusterServiceVersionSpec{
CustomResourceDefinitions: csv.Spec.CustomResourceDefinitions,
APIServiceDefinitions: csv.Spec.APIServiceDefinitions,
Replaces: csv.Spec.Replaces,
Version: csv.Spec.Version,
},
Status: v1alpha1.ClusterServiceVersionStatus{
Phase: csv.Status.Phase,
Reason: csv.Status.Reason,
},
}
})),
&v1alpha1.ClusterServiceVersion{},
resyncPeriod(),
cache.Indexers{
Expand Down
8 changes: 8 additions & 0 deletions pkg/controller/operators/olm/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"time"

"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/queueinformer"
"k8s.io/client-go/metadata"

"github.com/pkg/errors"
"github.com/sirupsen/logrus"
Expand All @@ -29,6 +30,7 @@ type operatorConfig struct {
clock utilclock.Clock
logger *logrus.Logger
operatorClient operatorclient.ClientInterface
metadataClient metadata.Interface
externalClient versioned.Interface
strategyResolver install.StrategyResolverInterface
apiReconciler APIIntersectionReconciler
Expand Down Expand Up @@ -159,6 +161,12 @@ func WithOperatorClient(operatorClient operatorclient.ClientInterface) OperatorO
}
}

func WithMetadataClient(metadataClient metadata.Interface) OperatorOption {
return func(config *operatorConfig) {
config.metadataClient = metadataClient
}
}

func WithExternalClient(externalClient versioned.Interface) OperatorOption {
return func(config *operatorConfig) {
config.externalClient = externalClient
Expand Down
68 changes: 23 additions & 45 deletions pkg/controller/operators/olm/operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ import (
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/client-go/informers"
k8sscheme "k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/metadata/metadatainformer"
"k8s.io/client-go/metadata/metadatalister"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/workqueue"
Expand All @@ -35,12 +37,10 @@ import (
"github.com/operator-framework/api/pkg/operators/v1alpha1"
"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/informers/externalversions"
operatorsv1alpha1listers "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/listers/operators/v1alpha1"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/certs"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/internal/pruning"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/olm/overrides"
resolver "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/clients"
csvutility "github.com/operator-framework/operator-lifecycle-manager/pkg/lib/csv"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/event"
Expand Down Expand Up @@ -75,7 +75,7 @@ type Operator struct {
client versioned.Interface
lister operatorlister.OperatorLister
protectedCopiedCSVNamespaces map[string]struct{}
copiedCSVLister operatorsv1alpha1listers.ClusterServiceVersionLister
copiedCSVLister metadatalister.Lister
ogQueueSet *queueinformer.ResourceQueueSet
csvQueueSet *queueinformer.ResourceQueueSet
olmConfigQueue workqueue.RateLimitingInterface
Expand Down Expand Up @@ -127,6 +127,9 @@ func newOperatorWithConfig(ctx context.Context, config *operatorConfig) (*Operat
if err := k8sscheme.AddToScheme(scheme); err != nil {
return nil, err
}
if err := metav1.AddMetaToScheme(scheme); err != nil {
return nil, err
}

op := &Operator{
Operator: queueOperator,
Expand Down Expand Up @@ -208,44 +211,20 @@ func newOperatorWithConfig(ctx context.Context, config *operatorConfig) (*Operat
return nil, err
}

// A separate informer solely for CSV copies. Fields
// are pruned from local copies of the objects managed
// A separate informer solely for CSV copies. Object metadata requests are used
// by this informer in order to reduce cached size.
copiedCSVInformer := cache.NewSharedIndexInformer(
pruning.NewListerWatcher(
op.client,
namespace,
func(opts *metav1.ListOptions) {
opts.LabelSelector = v1alpha1.CopiedLabelKey
},
pruning.PrunerFunc(func(csv *v1alpha1.ClusterServiceVersion) {
nonstatus, status := copyableCSVHash(csv)
*csv = v1alpha1.ClusterServiceVersion{
TypeMeta: csv.TypeMeta,
ObjectMeta: csv.ObjectMeta,
Status: v1alpha1.ClusterServiceVersionStatus{
Phase: csv.Status.Phase,
Reason: csv.Status.Reason,
},
}
if csv.Annotations == nil {
csv.Annotations = make(map[string]string, 2)
}
// These annotation keys are
// intentionally invalid -- all writes
// to copied CSVs are regenerated from
// the corresponding non-copied CSV,
// so it should never be transmitted
// back to the API server.
csv.Annotations["$copyhash-nonstatus"] = nonstatus
csv.Annotations["$copyhash-status"] = status
}),
),
&v1alpha1.ClusterServiceVersion{},
gvr := v1alpha1.SchemeGroupVersion.WithResource("clusterserviceversions")
copiedCSVInformer := metadatainformer.NewFilteredMetadataInformer(
config.metadataClient,
gvr,
namespace,
config.resyncPeriod(),
cache.Indexers{cache.NamespaceIndex: cache.MetaNamespaceIndexFunc},
)
op.copiedCSVLister = operatorsv1alpha1listers.NewClusterServiceVersionLister(copiedCSVInformer.GetIndexer())
func(options *metav1.ListOptions) {
options.LabelSelector = v1alpha1.CopiedLabelKey
},
).Informer()
op.copiedCSVLister = metadatalister.New(copiedCSVInformer.GetIndexer(), gvr)

// Register separate queue for gcing copied csvs
copiedCSVGCQueue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), fmt.Sprintf("%s/csv-gc", namespace))
Expand Down Expand Up @@ -1195,17 +1174,16 @@ func (a *Operator) handleClusterServiceVersionDeletion(obj interface{}) {
}
}

func (a *Operator) removeDanglingChildCSVs(csv *v1alpha1.ClusterServiceVersion) error {
func (a *Operator) removeDanglingChildCSVs(csv *metav1.PartialObjectMetadata) error {
logger := a.logger.WithFields(logrus.Fields{
"id": queueinformer.NewLoopID(),
"csv": csv.GetName(),
"namespace": csv.GetNamespace(),
"phase": csv.Status.Phase,
"labels": csv.GetLabels(),
"annotations": csv.GetAnnotations(),
})

if !csv.IsCopied() {
if !v1alpha1.IsCopied(csv) {
logger.Warning("removeDanglingChild called on a parent. this is a no-op but should be avoided.")
return nil
}
Expand Down Expand Up @@ -1244,7 +1222,7 @@ func (a *Operator) removeDanglingChildCSVs(csv *v1alpha1.ClusterServiceVersion)
return nil
}

func (a *Operator) deleteChild(csv *v1alpha1.ClusterServiceVersion, logger *logrus.Entry) error {
func (a *Operator) deleteChild(csv *metav1.PartialObjectMetadata, logger *logrus.Entry) error {
logger.Debug("gcing csv")
return a.client.OperatorsV1alpha1().ClusterServiceVersions(csv.GetNamespace()).Delete(context.TODO(), csv.GetName(), metav1.DeleteOptions{})
}
Expand Down Expand Up @@ -1683,12 +1661,12 @@ func (a *Operator) createCSVCopyingDisabledEvent(csv *v1alpha1.ClusterServiceVer
}

func (a *Operator) syncGcCsv(obj interface{}) (syncError error) {
clusterServiceVersion, ok := obj.(*v1alpha1.ClusterServiceVersion)
clusterServiceVersion, ok := obj.(*metav1.PartialObjectMetadata)
if !ok {
a.logger.Debugf("wrong type: %#v", obj)
return fmt.Errorf("casting ClusterServiceVersion failed")
}
if clusterServiceVersion.IsCopied() {
if v1alpha1.IsCopied(clusterServiceVersion) {
syncError = a.removeDanglingChildCSVs(clusterServiceVersion)
return
}
Expand Down