Skip to content

Config follow-up: Implement Server-Side Apply #472

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Config follow-up: Implement Server-Side Apply #472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
73 changes: 47 additions & 26 deletions controllers/bpfman-operator/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,15 @@ func (r *BpfmanConfigReconciler) Reconcile(ctx context.Context, req ctrl.Request
}

func (r *BpfmanConfigReconciler) reconcileCM(ctx context.Context, bpfmanConfig *v1alpha1.Config) error {
cm := &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{
Name: internal.BpfmanCmName,
Namespace: bpfmanConfig.Spec.Namespace},
cm := &corev1.ConfigMap{
TypeMeta: metav1.TypeMeta{
Kind: "ConfigMap",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: internal.BpfmanCmName,
Namespace: bpfmanConfig.Spec.Namespace,
},
Data: map[string]string{
internal.BpfmanTOML: bpfmanConfig.Spec.Configuration,
internal.BpfmanAgentLogLevel: bpfmanConfig.Spec.Agent.LogLevel,
Expand All @@ -164,7 +170,13 @@ func (r *BpfmanConfigReconciler) reconcileCM(ctx context.Context, bpfmanConfig *
}

func (r *BpfmanConfigReconciler) reconcileCSIDriver(ctx context.Context, bpfmanConfig *v1alpha1.Config) error {
csiDriver := &storagev1.CSIDriver{ObjectMeta: metav1.ObjectMeta{Name: internal.BpfmanCsiDriverName}}
csiDriver := &storagev1.CSIDriver{
TypeMeta: metav1.TypeMeta{
Kind: "CSIDriver",
APIVersion: "storage.k8s.io/v1",
},
ObjectMeta: metav1.ObjectMeta{Name: internal.BpfmanCsiDriverName},
}
r.Logger.Info("Loading object", "object", csiDriver.Name, "path", r.CsiDriverDS)
csiDriver, err := load(csiDriver, r.CsiDriverDS, csiDriver.Name)
if err != nil {
Expand All @@ -178,6 +190,10 @@ func (r *BpfmanConfigReconciler) reconcileCSIDriver(ctx context.Context, bpfmanC
func (r *BpfmanConfigReconciler) reconcileSCC(ctx context.Context, bpfmanConfig *v1alpha1.Config) error {
if r.IsOpenshift {
bpfmanRestrictedSCC := &osv1.SecurityContextConstraints{
TypeMeta: metav1.TypeMeta{
Kind: "SecurityContextConstraints",
APIVersion: "security.openshift.io/v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: internal.BpfmanRestrictedSccName,
},
Expand All @@ -190,16 +206,22 @@ func (r *BpfmanConfigReconciler) reconcileSCC(ctx context.Context, bpfmanConfig
return assureResource(ctx, r, bpfmanConfig, bpfmanRestrictedSCC, func(existing, desired *osv1.SecurityContextConstraints) bool {
existingCopy := existing.DeepCopy()
desiredCopy := desired.DeepCopy()
existingCopy.ObjectMeta = metav1.ObjectMeta{}
desiredCopy.ObjectMeta = metav1.ObjectMeta{}
existingCopy.TypeMeta = desired.TypeMeta
existingCopy.ObjectMeta = desired.ObjectMeta
return !equality.Semantic.DeepEqual(existingCopy, desiredCopy)
})
}
return nil
}

func (r *BpfmanConfigReconciler) reconcileStandardDS(ctx context.Context, bpfmanConfig *v1alpha1.Config) error {
bpfmanDS := &appsv1.DaemonSet{ObjectMeta: metav1.ObjectMeta{Name: internal.BpfmanDsName}}
bpfmanDS := &appsv1.DaemonSet{
TypeMeta: metav1.TypeMeta{
Kind: "DaemonSet",
APIVersion: "apps/v1",
},
ObjectMeta: metav1.ObjectMeta{Name: internal.BpfmanDsName},
}
r.Logger.Info("Loading object", "object", bpfmanDS.Name, "path", r.BpfmanStandardDS)
bpfmanDS, err := load(bpfmanDS, r.BpfmanStandardDS, bpfmanDS.Name)
if err != nil {
Expand All @@ -213,7 +235,13 @@ func (r *BpfmanConfigReconciler) reconcileStandardDS(ctx context.Context, bpfman

func (r *BpfmanConfigReconciler) reconcileMetricsProxyDS(ctx context.Context, bpfmanConfig *v1alpha1.Config) error {
// Reconcile metrics-proxy daemonset
metricsProxyDS := &appsv1.DaemonSet{ObjectMeta: metav1.ObjectMeta{Name: internal.BpfmanMetricsProxyDsName}}
metricsProxyDS := &appsv1.DaemonSet{
TypeMeta: metav1.TypeMeta{
Kind: "DaemonSet",
APIVersion: "apps/v1",
},
ObjectMeta: metav1.ObjectMeta{Name: internal.BpfmanMetricsProxyDsName},
}
r.Logger.Info("Loading object", "object", metricsProxyDS.Name, "path", r.BpfmanMetricsProxyDS)
metricsProxyDS, err := load(metricsProxyDS, r.BpfmanMetricsProxyDS, metricsProxyDS.Name)
if err != nil {
Expand Down Expand Up @@ -370,39 +398,32 @@ func load[T client.Object](t T, path, name string) (T, error) {
}

// assureResource ensures a Kubernetes resource exists and is up to date.
// Creates the resource if it doesn't exist, otherwise updates it to match the desired state.
// SSA patch creates the resource if it doesn't exist, otherwise updates it to match the desired state.
func assureResource[T client.Object](ctx context.Context, r *BpfmanConfigReconciler,
bpfmanConfig *v1alpha1.Config, resource T, needsUpdate func(existing T, desired T) bool) error {
if err := ctrl.SetControllerReference(bpfmanConfig, resource, r.Scheme); err != nil {
return err
}

objectKey := types.NamespacedName{Namespace: resource.GetNamespace(), Name: resource.GetName()}
r.Logger.Info("Getting object",
"type", resource.GetObjectKind(), "namespace", resource.GetNamespace(), "name", resource.GetName())
objectKey := types.NamespacedName{Namespace: resource.GetNamespace(), Name: resource.GetName()}
existingResource := resource.DeepCopyObject().(T)
found := true
if err := r.Get(ctx, objectKey, existingResource); err != nil {
if errors.IsNotFound(err) {
r.Logger.Info("Creating object",
if !errors.IsNotFound(err) {
r.Logger.Error(err, "Failed to get object",
"type", resource.GetObjectKind(), "namespace", resource.GetNamespace(), "name", resource.GetName())
if err := r.Create(ctx, resource); err != nil {
r.Logger.Error(err, "Failed to create object",
"type", resource.GetObjectKind(), "namespace", resource.GetNamespace(), "name", resource.GetName())
return err
}
return nil
return err
}
r.Logger.Error(err, "Failed to get object",
"type", resource.GetObjectKind(), "namespace", resource.GetNamespace(), "name", resource.GetName())
return err
found = false
}

if needsUpdate(existingResource, resource) {
r.Logger.Info("Updating object",
if !found || needsUpdate(existingResource, resource) {
r.Logger.Info("Patching object",
"type", resource.GetObjectKind(), "namespace", resource.GetNamespace(), "name", resource.GetName())
resource.SetResourceVersion(existingResource.GetResourceVersion())
if err := r.Update(ctx, resource); err != nil {
r.Logger.Error(err, "Failed updating object",
if err := r.Patch(ctx, resource, client.Apply, client.ForceOwnership, client.FieldOwner(bpfmanConfig.Name)); err != nil {
r.Logger.Error(err, "Failed patching object",
"type", resource.GetObjectKind(), "namespace", resource.GetNamespace(), "name", resource.GetName())
return err
}
Expand Down
32 changes: 29 additions & 3 deletions controllers/bpfman-operator/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,15 @@ import (
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
storagev1 "k8s.io/api/storage/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/utils/ptr"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
"sigs.k8s.io/controller-runtime/pkg/client/interceptor"
logf "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
Expand Down Expand Up @@ -207,12 +209,36 @@ func setupTestEnvironment(isOpenShift bool) (*BpfmanConfigReconciler, *v1alpha1.
s.AddKnownTypes(storagev1.SchemeGroupVersion, &storagev1.CSIDriver{})
s.AddKnownTypes(osv1.GroupVersion, &osv1.SecurityContextConstraints{})

// Create a fake client to mock API calls.
cl := fake.NewClientBuilder().WithRuntimeObjects(objs...).Build()

// Set development Logger so we can see all logs in tests.
logf.SetLogger(zap.New(zap.UseFlagOptions(&zap.Options{Development: true})))

// Create an interceptor that fakes Server-Side Apply Patch calls.
// This is needed until the upgrade to a version of sigs.k8s.io/controller-runtime/pkg/client/fake that fully
// supports r.Patch(..., client.Apply, ...) and/or r.Apply().
// See: https://github.com/kubernetes-sigs/controller-runtime/issues/2341#issuecomment-1560118000
// https://github.com/kubernetes/kubernetes/issues/115598
fns := interceptor.Funcs{
Patch: func(ctx context.Context, c client.WithWatch, obj client.Object, patch client.Patch, opts ...client.PatchOption) error {
if patch.Type() != types.ApplyPatchType {
return c.Patch(ctx, obj, patch, opts...)
}
existing, ok := obj.DeepCopyObject().(client.Object)
if !ok {
return fmt.Errorf("could not check for object in fake client")
}
if err := c.Get(ctx, client.ObjectKeyFromObject(obj), existing); errors.IsNotFound(err) {
if err := c.Create(ctx, existing); err != nil {
return fmt.Errorf("could not create object: %w", err)
}
}
obj.SetResourceVersion(existing.GetResourceVersion())
return c.Update(ctx, obj)
},
}

// Create a fake client to mock API calls.
cl := fake.NewClientBuilder().WithRuntimeObjects(objs...).WithInterceptorFuncs(fns).Build()

rc := ReconcilerCommon[v1alpha1.ClusterBpfApplicationState, v1alpha1.ClusterBpfApplicationStateList]{
Client: cl,
Scheme: s,
Expand Down
Loading