Skip to content

Optimizations for controller memory usage #907

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

Merged
mergify merged 5 commits into from
Dec 2, 2025
Merged

Optimizations for controller memory usage #907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6a06f44
controller: move commonly used functions to utils package
black-dragon74 Nov 24, 2025
f69b130
controller: add a new PVC controller - used with storageclass precedence
black-dragon74 Nov 24, 2025
1ccf4c1
manager: Disable cache for Pods, NS and enabled new PVC controller
black-dragon74 Nov 24, 2025
b7d5de9
controller: watch for VAs silently to optimize lookups
black-dragon74 Nov 24, 2025
0b93f39
controller: add shim to garbage collect old resources
black-dragon74 Nov 25, 2025
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
43 changes: 35 additions & 8 deletions cmd/manager/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,13 @@ import (

"github.com/kubernetes-csi/csi-lib-utils/standardflags"
"go.uber.org/zap/zapcore"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/runtime"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/client-go/kubernetes"
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/healthz"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
Expand Down Expand Up @@ -178,6 +180,19 @@ func main() {
Port: 9443,
TLSOpts: tlsOpts,
}),
Client: client.Options{
Cache: &client.CacheOptions{
DisableFor: []client.Object{
// Pods are fetched by the CSIAddonsNode controller
// Since we do not do this frequently the cache for it can be disabled
// This benefits us a lot as there can be a large number of pods that are present in the cache
&corev1.Pod{},
// Namespaces are fetched by the old PVC reconciler
// TODO: Remove this when the reconciler is phased out
Comment thread
black-dragon74 marked this conversation as resolved.
&corev1.Namespace{},
},
},
},
})
if err != nil {
setupLog.Error(err, "unable to start manager")
Expand Down Expand Up @@ -223,14 +238,26 @@ func main() {
setupLog.Error(err, "unable to create controller", "controller", "ReclaimSpaceCronJob")
os.Exit(1)
}
if err = (&controllers.PersistentVolumeClaimReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
ConnPool: connPool,
SchedulePrecedence: cfg.SchedulePrecedence,
}).SetupWithManager(mgr, ctrlOptions); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "PersistentVolumeClaim")
os.Exit(1)
if cfg.SchedulePrecedence == util.ScheduleSC {
setupLog.Info("Using new PVC controller for precedence", "schedulePrecedence", cfg.SchedulePrecedence)
if err = (&controllers.PVCReconiler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
ConnPool: connPool,
}).SetupWithManager(mgr, ctrlOptions); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "PersistentVolumeClaim")
os.Exit(1)
}
} else {
if err = (&controllers.PersistentVolumeClaimReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
ConnPool: connPool,
SchedulePrecedence: cfg.SchedulePrecedence,
}).SetupWithManager(mgr, ctrlOptions); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "PersistentVolumeClaim")
os.Exit(1)
}
}
if err = (&replicationController.VolumeReplicationReconciler{
Client: mgr.GetClient(),
Expand Down
9 changes: 5 additions & 4 deletions internal/controller/csiaddons/encryptionkeyrotationcronjob_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"time"

csiaddonsv1alpha1 "github.com/csi-addons/kubernetes-csi-addons/api/csiaddons/v1alpha1"
"github.com/csi-addons/kubernetes-csi-addons/internal/controller/utils"

"github.com/go-logr/logr"
"github.com/robfig/cron/v3"
Expand Down Expand Up @@ -72,14 +73,14 @@ func (r *EncryptionKeyRotationCronJobReconciler) Reconcile(ctx context.Context,

// Set default values for the optionals
if krcJob.Spec.FailedJobsHistoryLimit == nil {
*krcJob.Spec.FailedJobsHistoryLimit = defaultFailedJobsHistoryLimit
*krcJob.Spec.FailedJobsHistoryLimit = utils.DefaultFailedJobsHistoryLimit
}
if krcJob.Spec.SuccessfulJobsHistoryLimit == nil {
*krcJob.Spec.SuccessfulJobsHistoryLimit = defaultSuccessfulJobsHistoryLimit
*krcJob.Spec.SuccessfulJobsHistoryLimit = utils.DefaultSuccessfulJobsHistoryLimit
}

var childJobs csiaddonsv1alpha1.EncryptionKeyRotationJobList
err = r.List(ctx, &childJobs, client.InNamespace(req.Namespace), client.MatchingFields{jobOwnerKey: req.Name})
err = r.List(ctx, &childJobs, client.InNamespace(req.Namespace), client.MatchingFields{utils.JobOwnerKey: req.Name})
if err != nil {
logger.Error(err, "failed to fetch list of encryptionkeyrotationjob")
return ctrl.Result{}, err
Expand Down Expand Up @@ -367,7 +368,7 @@ func (r *EncryptionKeyRotationCronJobReconciler) constructEncryptionKeyRotationJ

// SetupWithManager sets up the controller with the Manager.
func (r *EncryptionKeyRotationCronJobReconciler) SetupWithManager(mgr ctrl.Manager, ctrlOptions controller.Options) error {
if err := mgr.GetFieldIndexer().IndexField(context.Background(), &csiaddonsv1alpha1.EncryptionKeyRotationJob{}, jobOwnerKey, func(rawObj client.Object) []string {
if err := mgr.GetFieldIndexer().IndexField(context.Background(), &csiaddonsv1alpha1.EncryptionKeyRotationJob{}, utils.JobOwnerKey, func(rawObj client.Object) []string {
job, ok := rawObj.(*csiaddonsv1alpha1.EncryptionKeyRotationJob)
if !ok {
return nil
Expand Down
9 changes: 9 additions & 0 deletions internal/controller/csiaddons/encryptionkeyrotationjob_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (

csiaddonsv1alpha1 "github.com/csi-addons/kubernetes-csi-addons/api/csiaddons/v1alpha1"
"github.com/csi-addons/kubernetes-csi-addons/internal/connection"
"github.com/csi-addons/kubernetes-csi-addons/internal/controller/utils"
"github.com/csi-addons/kubernetes-csi-addons/internal/proto"
"github.com/csi-addons/kubernetes-csi-addons/internal/util"
"github.com/csi-addons/spec/lib/go/identity"
Expand All @@ -38,8 +39,10 @@ import (
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/predicate"
)
Expand Down Expand Up @@ -333,6 +336,12 @@ func (r *EncryptionKeyRotationJobReconciler) SetupWithManager(mgr ctrl.Manager,
return ctrl.NewControllerManagedBy(mgr).
For(&csiaddonsv1alpha1.EncryptionKeyRotationJob{}).
WithEventFilter(predicate.GenerationChangedPredicate{}).
// This is to avoid "stop-the-world" events and wait for cache sync when we list VA
Watches(
&scv1.VolumeAttachment{},
&handler.EnqueueRequestForObject{},
builder.WithPredicates(utils.SilentPredicate()),
).
WithOptions(ctrlOptions).
Complete(r)
}
Loading