-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: introduce basic reconciliation for KongPluginInstallation CRD (#…
…424) Co-authored-by: Mattia Lavacca <[email protected]> Co-authored-by: Grzegorz Burzyński <[email protected]>
- Loading branch information
3 people
authored
Aug 9, 2024
1 parent
ec80e42
commit cdfb65a
Showing
24 changed files
with
809 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,223 @@ | ||
| package kongplugininstallation | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
|
|
||
| "github.com/samber/lo" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "oras.land/oras-go/v2/registry/remote/credentials" | ||
| 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/event" | ||
| "sigs.k8s.io/controller-runtime/pkg/handler" | ||
| k8slog "sigs.k8s.io/controller-runtime/pkg/log" | ||
| "sigs.k8s.io/controller-runtime/pkg/predicate" | ||
| "sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
|
|
||
| "github.com/kong/gateway-operator/api/v1alpha1" | ||
| "github.com/kong/gateway-operator/controller/kongplugininstallation/image" | ||
| "github.com/kong/gateway-operator/controller/pkg/log" | ||
| "github.com/kong/gateway-operator/pkg/utils/kubernetes" | ||
| ) | ||
|
|
||
| // Reconciler reconciles a KongPluginInstallation object. | ||
| type Reconciler struct { | ||
| client.Client | ||
| Scheme *runtime.Scheme | ||
| DevelopmentMode bool | ||
| } | ||
|
|
||
| // SetupWithManager sets up the controller with the Manager. | ||
| func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error { | ||
| return ctrl.NewControllerManagedBy(mgr). | ||
| For(&v1alpha1.KongPluginInstallation{}). | ||
| WithEventFilter(predicate.GenerationChangedPredicate{}). | ||
| Owns(&corev1.ConfigMap{}, builder.WithPredicates( | ||
| predicate.Funcs{ | ||
| DeleteFunc: func(e event.DeleteEvent) bool { | ||
| return true | ||
| }, | ||
| CreateFunc: func(e event.CreateEvent) bool { | ||
| return false | ||
| }, | ||
| UpdateFunc: func(e event.UpdateEvent) bool { | ||
| return true | ||
| }, | ||
| }, | ||
| )). | ||
| Watches( | ||
| &corev1.Secret{}, | ||
| handler.EnqueueRequestsFromMapFunc(r.listKongPluginInstallationsForSecret), | ||
| builder.WithPredicates( | ||
| predicate.NewPredicateFuncs(func(obj client.Object) bool { | ||
| secret, ok := obj.(*corev1.Secret) | ||
| if !ok { | ||
| return false | ||
| } | ||
| return secret.Type == corev1.SecretTypeDockerConfigJson | ||
| }), | ||
| ), | ||
| ). | ||
| Complete(r) | ||
| } | ||
|
|
||
| // Reconcile moves the current state of an object to the intended state. | ||
| func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) { | ||
| logger := log.GetLogger(ctx, "kongplugininstallation", r.DevelopmentMode) | ||
|
|
||
| log.Trace(logger, "reconciling KongPluginInstallation resource", req) | ||
| var kpi v1alpha1.KongPluginInstallation | ||
| if err := r.Client.Get(ctx, req.NamespacedName, &kpi); err != nil { | ||
| return ctrl.Result{}, client.IgnoreNotFound(err) | ||
| } | ||
|
|
||
| log.Trace(logger, "managing KongPluginInstallation resource", kpi) | ||
| var credentialsStore credentials.Store | ||
| if kpi.Spec.ImagePullSecretRef != nil { | ||
| log.Trace(logger, "getting secret for KongPluginInstallation resource", kpi) | ||
| secretNN := client.ObjectKey{ | ||
| Namespace: kpi.Spec.ImagePullSecretRef.Namespace, | ||
| Name: kpi.Spec.ImagePullSecretRef.Name, | ||
| } | ||
| if secretNN.Namespace == "" { | ||
| secretNN.Namespace = req.Namespace | ||
| } | ||
|
|
||
| var secret corev1.Secret | ||
| if err := r.Client.Get( | ||
| ctx, | ||
| secretNN, | ||
| &secret, | ||
| ); err != nil { | ||
| return ctrl.Result{}, setStatusConditionFailedForKongPluginInstallation(ctx, r.Client, &kpi, fmt.Sprintf("cannot retrieve secret %q, because: %s", secretNN, err)) | ||
| } | ||
|
|
||
| const requiredKey = ".dockerconfigjson" | ||
| secretData, ok := secret.Data[requiredKey] | ||
| if !ok { | ||
| return ctrl.Result{}, setStatusConditionFailedForKongPluginInstallation( | ||
| ctx, r.Client, &kpi, fmt.Sprintf("can't parse secret %q - unexpected type, it should follow 'kubernetes.io/dockerconfigjson'", secretNN), | ||
| ) | ||
| } | ||
| var err error | ||
| credentialsStore, err = image.CredentialsStoreFromString(string(secretData)) | ||
| if err != nil { | ||
| return ctrl.Result{}, setStatusConditionFailedForKongPluginInstallation(ctx, r.Client, &kpi, fmt.Sprintf("can't parse secret: %q data: %s", secretNN, err)) | ||
| } | ||
| } | ||
|
|
||
| log.Trace(logger, "fetch plugin for KongPluginInstallation resource", kpi) | ||
| plugin, err := image.FetchPluginContent(ctx, kpi.Spec.Image, credentialsStore) | ||
| if err != nil { | ||
| return ctrl.Result{}, setStatusConditionFailedForKongPluginInstallation(ctx, r.Client, &kpi, fmt.Sprintf("problem with the image: %q error: %s", kpi.Spec.Image, err)) | ||
| } | ||
|
|
||
| cms, err := kubernetes.ListConfigMapsForOwner(ctx, r.Client, kpi.GetUID()) | ||
| if err != nil { | ||
| return ctrl.Result{}, err | ||
| } | ||
| var cm corev1.ConfigMap | ||
| switch len(cms) { | ||
| case 0: | ||
| if cmName := kpi.Status.UnderlyingConfigMapName; cmName != "" { | ||
| cm.Name = cmName | ||
| } else { | ||
| cm.GenerateName = kpi.Name | ||
| } | ||
| cm.Namespace = kpi.Namespace | ||
| cm.Data = map[string]string{ | ||
| fmt.Sprintf("%s.lua", kpi.Name): string(plugin), | ||
| } | ||
| if err := ctrl.SetControllerReference(&kpi, &cm, r.Scheme); err != nil { | ||
| return ctrl.Result{}, err | ||
| } | ||
| if err := r.Client.Create(ctx, &cm); err != nil { | ||
| return ctrl.Result{}, err | ||
| } | ||
| kpi.Status.UnderlyingConfigMapName = cm.Name | ||
| case 1: | ||
| cm = cms[0] | ||
| cm.Data = map[string]string{ | ||
| fmt.Sprintf("%s.lua", kpi.Name): string(plugin), | ||
| } | ||
| if err := r.Client.Update(ctx, &cm); err != nil { | ||
| return ctrl.Result{}, err | ||
| } | ||
| default: | ||
| // It should never happen. | ||
| return ctrl.Result{}, errors.New("unexpected error happened - more than one ConfigMap found") | ||
| } | ||
|
|
||
| return ctrl.Result{}, setStatusConditionForKongPluginInstallation( | ||
| ctx, r.Client, &kpi, metav1.ConditionTrue, v1alpha1.KongPluginInstallationReasonReady, "plugin successfully saved in cluster as ConfigMap", | ||
| ) | ||
| } | ||
|
|
||
| func (r *Reconciler) listKongPluginInstallationsForSecret(ctx context.Context, obj client.Object) []reconcile.Request { | ||
| name, namespace := obj.GetName(), obj.GetNamespace() | ||
|
|
||
| var kpiList v1alpha1.KongPluginInstallationList | ||
| if err := r.List(ctx, &kpiList); err != nil { | ||
| k8slog.FromContext(ctx).Error( | ||
| err, | ||
| "failed to run map funcs for secrets", | ||
| ) | ||
| return nil | ||
| } | ||
|
|
||
| var recs []reconcile.Request | ||
| for _, kpi := range kpiList.Items { | ||
| if kpi.Spec.ImagePullSecretRef == nil { | ||
| continue | ||
| } | ||
| if kpi.Spec.ImagePullSecretRef.Namespace == "" { | ||
| kpi.Spec.ImagePullSecretRef.Namespace = kpi.Namespace | ||
| } | ||
| if kpi.Spec.ImagePullSecretRef.Namespace == namespace && kpi.Spec.ImagePullSecretRef.Name == name { | ||
| recs = append(recs, reconcile.Request{ | ||
| NamespacedName: client.ObjectKey{ | ||
| Name: kpi.Name, | ||
| Namespace: kpi.Namespace, | ||
| }, | ||
| }) | ||
| } | ||
| } | ||
| return recs | ||
| } | ||
|
|
||
| func setStatusConditionFailedForKongPluginInstallation( | ||
| ctx context.Context, client client.Client, kpi *v1alpha1.KongPluginInstallation, msg string, | ||
| ) error { | ||
| return setStatusConditionForKongPluginInstallation(ctx, client, kpi, metav1.ConditionFalse, v1alpha1.KongPluginInstallationReasonFailed, msg) | ||
| } | ||
|
|
||
| func setStatusConditionForKongPluginInstallation( | ||
| ctx context.Context, client client.Client, kpi *v1alpha1.KongPluginInstallation, conditionStatus metav1.ConditionStatus, reason v1alpha1.KongPluginInstallationConditionReason, msg string, | ||
| ) error { | ||
| status := metav1.Condition{ | ||
| Type: string(v1alpha1.KongPluginInstallationConditionStatusAccepted), | ||
| Status: conditionStatus, | ||
| ObservedGeneration: kpi.Generation, | ||
| LastTransitionTime: metav1.Now(), | ||
| Reason: string(reason), | ||
| Message: msg, | ||
| } | ||
| _, index, found := lo.FindIndexOf(kpi.Status.Conditions, func(c metav1.Condition) bool { | ||
| return c.Type == string(v1alpha1.KongPluginInstallationConditionStatusAccepted) | ||
| }) | ||
| if found { | ||
| // Nothing changed, condition doesn't need to be updated. | ||
| if c := kpi.Status.Conditions[index]; c.Status == status.Status && c.Reason == status.Reason && c.Message == status.Message { | ||
| return nil | ||
| } | ||
| kpi.Status.Conditions[index] = status | ||
| } else { | ||
| kpi.Status.Conditions = append(kpi.Status.Conditions, status) | ||
| } | ||
| return client.Status().Update(ctx, kpi) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| package kongplugininstallation | ||
|
|
||
| //+kubebuilder:rbac:groups=gateway-operator.konghq.com,resources=kongplugininstallations,verbs=get;list;watch;update;patch | ||
| //+kubebuilder:rbac:groups=gateway-operator.konghq.com,resources=kongplugininstallations/status,verbs=get;update;patch | ||
| //+kubebuilder:rbac:groups=core,resources=configmaps,verbs=get;list;watch;create;update;patch;delete | ||
| //+kubebuilder:rbac:groups=core,resources=secrets,verbs=get; | ||
| //+kubebuilder:rbac:groups=core,resources=configmaps/status,verbs=get |
Oops, something went wrong.