search

kubernetes-sigs / controller-runtime

Repo for the controller-runtime subproject of kubebuilder (sig-apimachinery)
Apache License 2.0
2.39k stars 1.11k forks source link

Add "controllerutil" helpers for applyconfigurations (SSA) #2674

Open erikgb opened 5 months ago

erikgb commented 5 months ago

We are making extensive use of the helpers defined in https://github.com/kubernetes-sigs/controller-runtime/blob/main/pkg/controller/controllerutil/controllerutil.go, and while migrating our controllers to SSA we had to create our own modified copies based on corev1/metav1 applyconfigurations.

I think it could make sense adding a SSA-flavoured edition of these simple (but useful) helpers to controller-runtime. And I would be happy to submit a PR if you agree. The most challenging is probably to decide the package name/location. WDYT @alvaroaleman @vincepri @sbueringer?

troy0820 commented 5 months ago

/kind support feature

troy0820 commented 4 months ago

The tricky part here is the applyconfigurations that are not available for custom resources. (Should we deal with controller-tools to have that be created when you scaffold kubebuilder?)

Do we only plan to support this for corev1 and the like? I think server side apply was looking to be done on the client.Client interface as well. Doing this in controllerutils may help migrate that to the interface. I'm interested in this as well.

erikgb commented 4 months ago

I just want to add the same helper as we have for the normal types. Here is an example from the modified helper we are using now:

import (
    "fmt"

    metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    "k8s.io/apimachinery/pkg/runtime"
    metav1ac "k8s.io/client-go/applyconfigurations/meta/v1"
    "k8s.io/utils/ptr"
    "sigs.k8s.io/controller-runtime/pkg/client/apiutil"
)

// SetControllerReference sets owner as a Controller OwnerReference on controlled.
// This is used for garbage collection of the controlled object and for
// reconciling the owner object on changes to controlled (with a Watch + EnqueueRequestForOwner).
func SetControllerReference(owner metav1.Object, controlled *metav1ac.ObjectMetaApplyConfiguration, scheme *runtime.Scheme) error {
    // Validate the owner.
    ro, ok := owner.(runtime.Object)
    if !ok {
        return fmt.Errorf("%T is not a runtime.Object, cannot call SetControllerReference", owner)
    }
    if err := validateOwner(owner, controlled); err != nil {
        return err
    }

    gvk, err := apiutil.GVKForObject(ro, scheme)
    if err != nil {
        return err
    }
    controlled.WithOwnerReferences(
        metav1ac.OwnerReference().
            WithAPIVersion(gvk.GroupVersion().String()).
            WithKind(gvk.Kind).
            WithName(owner.GetName()).
            WithUID(owner.GetUID()).
            WithBlockOwnerDeletion(true).
            WithController(true),
    )
    return nil
}
erikgb commented 4 months ago

This might be possible to solve with generics also. I can look into a generics solution, as it will probably make the code more compact with less duplication.

k8s-triage-robot commented 1 month ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

erikgb commented 1 month ago

/remove-lifecycle stale

Still wanted/needed, but we'll probably have to wait for https://github.com/kubernetes/kubernetes/issues/118138.

erikgb commented 3 weeks ago

/remove-kind support

I think this is a valid feature request that will benefit the community. But we probably have to wait for 1. class SSA support in c/r before adding it.