Skip to content

Filter what objects we cache from the API #1549

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.

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
merged 4 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 21 additions & 3 deletions controllers/rabbitmqcluster_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"golang.org/x/text/cases"
"golang.org/x/text/language"

"github.com/rabbitmq/cluster-operator/v2/internal/metadata"
"github.com/rabbitmq/cluster-operator/v2/internal/resource"
"github.com/rabbitmq/cluster-operator/v2/internal/status"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
Expand Down Expand Up @@ -59,6 +60,7 @@ const (
// RabbitmqClusterReconciler reconciles a RabbitmqCluster object
type RabbitmqClusterReconciler struct {
client.Client
APIReader client.Reader
Scheme *runtime.Scheme
Namespace string
Recorder record.EventRecorder
Expand Down Expand Up @@ -139,6 +141,17 @@ func (r *RabbitmqClusterReconciler) Reconcile(ctx context.Context, req ctrl.Requ
return ctrl.Result{}, tlsErr
}

// if the secret already exists, ensure it has the labels necessary for being in the controller's cache
// otherwise, our attempt to create it will fail (CreateOrUpdate only checks for the existence of the resource in the cache)
defaultUserSecret := &corev1.Secret{}
err = r.APIReader.Get(ctx, types.NamespacedName{Namespace: rabbitmqCluster.Namespace, Name: rabbitmqCluster.ChildResourceName("default-user")}, defaultUserSecret)
if err == nil {
if v, ok := defaultUserSecret.Labels["app.kubernetes.io/part-of"]; !ok || v != "rabbitmq" {
defaultUserSecret.Labels = metadata.GetLabels(rabbitmqCluster.Name, rabbitmqCluster.Labels)
r.Client.Update(ctx, defaultUserSecret)
}
}

sts, err := r.statefulSet(ctx, rabbitmqCluster)
// The StatefulSet may not have been created by this point, so ignore Not Found errors
if client.IgnoreNotFound(err) != nil {
Expand Down Expand Up @@ -262,9 +275,10 @@ func (r *RabbitmqClusterReconciler) logAndRecordOperationResult(logger logr.Logg
var operation string
if operationResult == controllerutil.OperationResultCreated {
operation = "create"
}
if operationResult == controllerutil.OperationResultUpdated {
} else if operationResult == controllerutil.OperationResultUpdated {
operation = "update"
} else {
operation = string(operationResult)
}

caser := cases.Title(language.English)
Expand All @@ -275,7 +289,11 @@ func (r *RabbitmqClusterReconciler) logAndRecordOperationResult(logger logr.Logg
}

if err != nil {
msg := fmt.Sprintf("failed to %s resource %s of Type %T", operation, resource.(metav1.Object).GetName(), resource.(metav1.Object))
var msg string
if operation != "unchanged" {
msg = fmt.Sprintf("failed to %s resource %s of Type %T: ", operation, resource.(metav1.Object).GetName(), resource.(metav1.Object))
}
msg = fmt.Sprintf("%s%s", msg, err)
logger.Error(err, msg)
r.Recorder.Event(rmq, corev1.EventTypeWarning, fmt.Sprintf("Failed%s", caser.String(operation)), msg)
}
Expand Down
7 changes: 4 additions & 3 deletions controllers/reconcile_tls.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,10 @@ func (r *RabbitmqClusterReconciler) checkTLSSecrets(ctx context.Context, rabbitm
secretName := rabbitmqCluster.Spec.TLS.SecretName
logger.V(1).Info("TLS enabled, looking for secret", "secret", secretName)

// check if secret exists
// check if secret exists - we need to use the APIReader because if the Secret doesn't have
// "app.kubernetes.io/part-of" label set to "rabbitmq", it's not cached by the controller
secret := &corev1.Secret{}
if err := r.Get(ctx, types.NamespacedName{Namespace: rabbitmqCluster.Namespace, Name: secretName}, secret); err != nil {
if err := r.APIReader.Get(ctx, types.NamespacedName{Namespace: rabbitmqCluster.Namespace, Name: secretName}, secret); err != nil {
r.Recorder.Event(rabbitmqCluster, corev1.EventTypeWarning, "TLSError",
fmt.Sprintf("Failed to get TLS secret %s in namespace %s: %v", secretName, rabbitmqCluster.Namespace, err.Error()))
logger.Error(err, "Error setting up TLS")
Expand All @@ -65,7 +66,7 @@ func (r *RabbitmqClusterReconciler) checkTLSSecrets(ctx context.Context, rabbitm

// check if secret exists
secret = &corev1.Secret{}
if err := r.Get(ctx, types.NamespacedName{Namespace: rabbitmqCluster.Namespace, Name: secretName}, secret); err != nil {
if err := r.APIReader.Get(ctx, types.NamespacedName{Namespace: rabbitmqCluster.Namespace, Name: secretName}, secret); err != nil {
r.Recorder.Event(rabbitmqCluster, corev1.EventTypeWarning, "TLSError",
fmt.Sprintf("Failed to get CA certificate secret %v in namespace %v: %v", secretName, rabbitmqCluster.Namespace, err.Error()))
logger.Error(err, "Error setting up TLS")
Expand Down
4 changes: 3 additions & 1 deletion controllers/suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@ package controllers_test
import (
"context"
"path/filepath"
"sigs.k8s.io/controller-runtime/pkg/metrics/server"
"testing"

"sigs.k8s.io/controller-runtime/pkg/metrics/server"

"k8s.io/client-go/util/retry"

. "github.com/onsi/ginkgo/v2"
Expand Down Expand Up @@ -95,6 +96,7 @@ var _ = BeforeSuite(func() {
fakeExecutor = &fakePodExecutor{}
err = (&controllers.RabbitmqClusterReconciler{
Client: mgr.GetClient(),
APIReader: mgr.GetAPIReader(),
Scheme: mgr.GetScheme(),
Recorder: mgr.GetEventRecorderFor(controllerName),
Namespace: "rabbitmq-system",
Expand Down
30 changes: 29 additions & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,28 @@ import (
"flag"
"fmt"
"os"
"sigs.k8s.io/controller-runtime/pkg/metrics/server"
"strconv"
"strings"
"time"

"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/metrics/server"

"github.com/rabbitmq/cluster-operator/v2/pkg/profiling"

appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"

"k8s.io/klog/v2"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client/config"

rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/v2/api/v1beta1"
"github.com/rabbitmq/cluster-operator/v2/controllers"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/selection"
"k8s.io/client-go/kubernetes"
defaultscheme "k8s.io/client-go/kubernetes/scheme"
_ "k8s.io/client-go/plugin/pkg/client/auth"
Expand Down Expand Up @@ -130,6 +138,25 @@ func main() {
}
}

rmqLabel, err := labels.NewRequirement("app.kubernetes.io/part-of", selection.Equals, []string{"rabbitmq"})
if err != nil {
log.Error(err, "unable to create a label filter")
os.Exit(1)
}
rmqSelector := labels.NewSelector().Add(*rmqLabel)

options.Cache.ByObject = map[client.Object]cache.ByObject{
&rabbitmqv1beta1.RabbitmqCluster{}: {},
&appsv1.StatefulSet{}: {Label: rmqSelector},
&corev1.Service{}: {Label: rmqSelector},
&corev1.ConfigMap{}: {Label: rmqSelector},
&corev1.Secret{}: {Label: rmqSelector},
&corev1.ServiceAccount{}: {Label: rmqSelector},
&corev1.Endpoints{}: {Label: rmqSelector},
&rbacv1.Role{}: {Label: rmqSelector},
&rbacv1.RoleBinding{}: {Label: rmqSelector},
}

if leaseDuration := getEnvInDuration("LEASE_DURATION"); leaseDuration != 0 {
log.Info("manager configured with lease duration", "seconds", int(leaseDuration.Seconds()))
options.LeaseDuration = &leaseDuration
Expand Down Expand Up @@ -167,6 +194,7 @@ func main() {

err = (&controllers.RabbitmqClusterReconciler{
Client: mgr.GetClient(),
APIReader: mgr.GetAPIReader(),
Scheme: mgr.GetScheme(),
Recorder: mgr.GetEventRecorderFor(controllerName),
Namespace: operatorNamespace,
Expand Down