Add initial version with help and admission controller (#1)

- It adds a helm chart that will be hosted in the Github pages URL of this repository
- an admission controller operator 
- Basic documentation for installing the operator, configuring CRDs and example pod configuration
This commit is contained in:
M. Essam
2025-01-29 22:44:09 +01:00
committed by GitHub
parent 50aa9ada37
commit 64091a6439
45 changed files with 4638 additions and 9 deletions
@@ -0,0 +1,156 @@
/*
Copyright 2025.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package controller
import (
"context"
"fmt"
"github.com/google/uuid"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
netbirdiov1 "github.com/netbirdio/kubernetes-operator/api/v1"
)
// NBSetupKeyReconciler reconciles a NBSetupKey object
type NBSetupKeyReconciler struct {
client.Client
Scheme *runtime.Scheme
ReferencedSecrets map[string]types.NamespacedName
}
// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
func (r *NBSetupKeyReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
_ = log.FromContext(ctx)
nbSetupKey := netbirdiov1.NBSetupKey{}
err := r.Get(ctx, req.NamespacedName, &nbSetupKey)
if err != nil {
ctrl.Log.Error(fmt.Errorf("internalError"), "error getting NBSetupKey", "err", err, "namespace", req.Namespace, "name", req.Name)
return ctrl.Result{}, nil
}
if nbSetupKey.Spec.SecretKeyRef.Name == "" || nbSetupKey.Spec.SecretKeyRef.Key == "" {
ctrl.Log.Error(fmt.Errorf("invalid NBSetupKey"), "secretKeyRef must contain both secret name and secret key", "namespace", req.Namespace, "name", req.Name)
return ctrl.Result{}, r.setStatus(ctx, &nbSetupKey, netbirdiov1.NBSetupKeyStatus{
Conditions: []netbirdiov1.NBSetupKeyCondition{
{
Type: netbirdiov1.Ready,
Status: corev1.ConditionFalse,
LastProbeTime: v1.Now(),
Reason: "InvalidConfig",
Message: "secretKeyRef must contain both secret name and secret key.",
},
},
})
}
// Handle updated secret name
for k, v := range r.ReferencedSecrets {
if v == req.NamespacedName {
delete(r.ReferencedSecrets, k)
break
}
}
r.ReferencedSecrets[fmt.Sprintf("%s/%s", nbSetupKey.Namespace, nbSetupKey.Spec.SecretKeyRef.Name)] = req.NamespacedName
secret := corev1.Secret{}
err = r.Get(ctx, types.NamespacedName{Namespace: nbSetupKey.Namespace, Name: nbSetupKey.Spec.SecretKeyRef.Name}, &secret)
if err != nil {
if !errors.IsNotFound(err) {
ctrl.Log.Error(fmt.Errorf("internalError"), "error getting secret", "err", err, "namespace", req.Namespace, "name", req.Name)
return ctrl.Result{}, err
}
ctrl.Log.Error(fmt.Errorf("invalid NBSetupKey"), "secret referenced not found", "err", err, "namespace", req.Namespace, "name", req.Name)
return ctrl.Result{}, r.setStatus(ctx, &nbSetupKey, netbirdiov1.NBSetupKeyStatus{Conditions: []netbirdiov1.NBSetupKeyCondition{{
Type: netbirdiov1.Ready,
Status: corev1.ConditionFalse,
LastProbeTime: v1.Now(),
Reason: "SecretNotExists",
Message: "Referenced secret does not exist",
}}})
}
uuidBytes, ok := secret.Data[nbSetupKey.Spec.SecretKeyRef.Key]
if !ok {
ctrl.Log.Error(fmt.Errorf("invalid NBSetupKey"), "secret key referenced not found", "namespace", req.Namespace, "name", req.Name)
return ctrl.Result{}, r.setStatus(ctx, &nbSetupKey, netbirdiov1.NBSetupKeyStatus{Conditions: []netbirdiov1.NBSetupKeyCondition{{
Type: netbirdiov1.Ready,
Status: corev1.ConditionFalse,
LastProbeTime: v1.Now(),
Reason: "SecretKeyNotExists",
Message: "Referenced secret key does not exist",
}}})
}
_, err = uuid.Parse(string(uuidBytes))
if err != nil {
ctrl.Log.Error(fmt.Errorf("invalid NBSetupKey"), "setupKey is not a valid UUID", "err", err, "namespace", req.Namespace, "name", req.Name)
return ctrl.Result{}, r.setStatus(ctx, &nbSetupKey, netbirdiov1.NBSetupKeyStatus{Conditions: []netbirdiov1.NBSetupKeyCondition{{
Type: netbirdiov1.Ready,
Status: corev1.ConditionFalse,
LastProbeTime: v1.Now(),
Reason: "InvalidSetupKey",
Message: "Referenced secret is not a valid SetupKey",
}}})
}
return ctrl.Result{}, r.setStatus(ctx, &nbSetupKey, netbirdiov1.NBSetupKeyStatus{Conditions: []netbirdiov1.NBSetupKeyCondition{{
Type: netbirdiov1.Ready,
Status: corev1.ConditionTrue,
LastProbeTime: v1.Now(),
}}})
}
func (r *NBSetupKeyReconciler) setStatus(ctx context.Context, nbsetupkey *netbirdiov1.NBSetupKey, status netbirdiov1.NBSetupKeyStatus) error {
nbsetupkey.Status = status
err := r.Status().Update(ctx, nbsetupkey)
return err
}
// SetupWithManager sets up the controller with the Manager.
func (r *NBSetupKeyReconciler) SetupWithManager(mgr ctrl.Manager) error {
r.ReferencedSecrets = make(map[string]types.NamespacedName)
return ctrl.NewControllerManagedBy(mgr).
For(&netbirdiov1.NBSetupKey{}).
Named("nbsetupkey").
Watches(
&corev1.Secret{},
handler.EnqueueRequestsFromMapFunc(func(ctx context.Context, obj client.Object) []reconcile.Request {
if v, ok := r.ReferencedSecrets[fmt.Sprintf("%s/%s", obj.GetNamespace(), obj.GetName())]; ok {
return []reconcile.Request{
{
NamespacedName: v,
},
}
}
return nil
}),
). // Trigger reconciliation when the labeled Busybox resource changes
Complete(r)
}