vnfs/DAaaS/microservices/collectd-operator/pkg/controller/collectdplugin/collectdplugin_controller.go

   1 package collectdplugin
   2
   3 import (
   4         "context"
   5         "fmt"
   6         "reflect"
   7         "strings"
   8         "sync"
   9
  10         "github.com/go-logr/logr"
  11         "github.com/operator-framework/operator-sdk/pkg/predicate"
  12
  13         onapv1alpha1 "collectd-operator/pkg/apis/onap/v1alpha1"
  14         collectdutils "collectd-operator/pkg/controller/utils"
  15
  16         appsv1 "k8s.io/api/apps/v1"
  17         corev1 "k8s.io/api/core/v1"
  18         "k8s.io/apimachinery/pkg/api/errors"
  19         "k8s.io/apimachinery/pkg/runtime"
  20         "k8s.io/client-go/util/retry"
  21         "sigs.k8s.io/controller-runtime/pkg/client"
  22         "sigs.k8s.io/controller-runtime/pkg/controller"
  23         "sigs.k8s.io/controller-runtime/pkg/handler"
  24         "sigs.k8s.io/controller-runtime/pkg/manager"
  25         "sigs.k8s.io/controller-runtime/pkg/reconcile"
  26         logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
  27         "sigs.k8s.io/controller-runtime/pkg/source"
  28 )
  29
  30 var log = logf.Log.WithName("controller_collectdplugin")
  31
  32 var reconcileLock sync.Mutex
  33
  34 // Add creates a new CollectdPlugin Controller and adds it to the Manager. The Manager will set fields on the Controller
  35 // and Start it when the Manager is Started.
  36 func Add(mgr manager.Manager) error {
  37         return add(mgr, newReconciler(mgr))
  38 }
  39
  40 // newReconciler returns a new reconcile.Reconciler
  41 func newReconciler(mgr manager.Manager) reconcile.Reconciler {
  42         return &ReconcileCollectdPlugin{client: mgr.GetClient(), scheme: mgr.GetScheme()}
  43 }
  44
  45 // add adds a new Controller to mgr with r as the reconcile.Reconciler
  46 func add(mgr manager.Manager, r reconcile.Reconciler) error {
  47         // Create a new controller
  48         log.V(1).Info("Creating a new controller for CollectdPlugin")
  49         c, err := controller.New("collectdplugin-controller", mgr, controller.Options{Reconciler: r})
  50         if err != nil {
  51                 return err
  52         }
  53
  54         // Watch for changes to primary resource CollectdPlugin
  55         log.V(1).Info("Add watcher for primary resource CollectdPlugin")
  56         err = c.Watch(&source.Kind{Type: &onapv1alpha1.CollectdPlugin{}}, &handler.EnqueueRequestForObject{}, predicate.GenerationChangedPredicate{})
  57         if err != nil {
  58                 return err
  59         }
  60
  61         log.V(1).Info("Add watcher for secondary resource Collectd Daemonset")
  62         err = c.Watch(
  63                 &source.Kind{Type: &appsv1.DaemonSet{}},
  64                 &handler.EnqueueRequestsFromMapFunc{
  65                         ToRequests: handler.ToRequestsFunc(func(a handler.MapObject) []reconcile.Request {
  66                                 labelSelector, err := collectdutils.GetWatchLabels()
  67                                 labels := strings.Split(labelSelector, "=")
  68                                 if err != nil {
  69                                         log.Error(err, "Failed to get watch labels, continuing with default label")
  70                                 }
  71                                 rcp := r.(*ReconcileCollectdPlugin)
  72                                 // Select the Daemonset with labelSelector (Defautl  is app=collectd)
  73                                 if a.Meta.GetLabels()[labels[0]] == labels[1] {
  74                                         var requests []reconcile.Request
  75                                         cpList, err := collectdutils.GetCollectdPluginList(rcp.client, a.Meta.GetNamespace())
  76                                         if err != nil {
  77                                                 return nil
  78                                         }
  79                                         for _, cp := range cpList.Items {
  80                                                 requests = append(requests, reconcile.Request{
  81                                                         NamespacedName: client.ObjectKey{Namespace: cp.Namespace, Name: cp.Name}})
  82                                         }
  83                                         return requests
  84                                 }
  85                                 return nil
  86                         }),
  87                 })
  88         if err != nil {
  89                 return err
  90         }
  91
  92         return nil
  93 }
  94
  95 // blank assignment to verify that ReconcileCollectdPlugin implements reconcile.Reconciler
  96 var _ reconcile.Reconciler = &ReconcileCollectdPlugin{}
  97
  98 // ReconcileCollectdPlugin reconciles a CollectdPlugin object
  99 type ReconcileCollectdPlugin struct {
 100         // This client, initialized using mgr.Client() above, is a split client
 101         // that reads objects from the cache and writes to the apiserver
 102         client client.Client
 103         scheme *runtime.Scheme
 104 }
 105
 106 // Reconcile reads that state of the cluster for a CollectdPlugin object and makes changes based on the state read
 107 // and what is in the CollectdPlugin.Spec
 108 // TODO(user): Modify this Reconcile function to implement your Controller logic.  This example creates
 109 // a Pod as an example
 110 // Note:
 111 // The Controller will requeue the Request to be processed again if the returned error is non-nil or
 112 // Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
 113 func (r *ReconcileCollectdPlugin) Reconcile(request reconcile.Request) (reconcile.Result, error) {
 114         reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
 115         reqLogger.Info("Reconciling CollectdPlugin")
 116
 117         // Fetch the CollectdPlugin instance
 118         instance := &onapv1alpha1.CollectdPlugin{}
 119         err := r.client.Get(context.TODO(), request.NamespacedName, instance)
 120         if err != nil {
 121                 if errors.IsNotFound(err) {
 122                         // Request object not found, could have been deleted after reconcile request.
 123                         // Owned objects are automatically garbage collected. For additional cleanup logic use finalizers.
 124                         // Return and don't requeue
 125                         reqLogger.V(1).Info("CollectdPlugin object Not found")
 126                         return reconcile.Result{}, nil
 127                 }
 128                 // Error reading the object - requeue the request.
 129                 reqLogger.V(1).Info("Error reading the CollectdPlugin object, Requeuing")
 130                 return reconcile.Result{}, err
 131         }
 132
 133         // Handle Delete CR for additional cleanup
 134         isDelete, err := r.handleDelete(reqLogger, instance)
 135         if isDelete {
 136                 return reconcile.Result{}, err
 137         }
 138
 139         // Add finalizer for this CR
 140         if !collectdutils.Contains(instance.GetFinalizers(), collectdutils.CollectdFinalizer) {
 141                 if err := r.addFinalizer(reqLogger, instance); err != nil {
 142                         return reconcile.Result{}, err
 143                 }
 144                 return reconcile.Result{}, nil
 145         }
 146         // Handle the reconciliation for CollectdPlugin.
 147         // At this stage the Status of the CollectdPlugin should NOT be ""
 148         reconcileLock.Lock()
 149         err = r.handleCollectdPlugin(reqLogger, instance, false)
 150         reconcileLock.Unlock()
 151         return reconcile.Result{}, err
 152 }
 153
 154 // handleCollectdPlugin regenerates the collectd conf on CR Create, Update, Delete events
 155 func (r *ReconcileCollectdPlugin) handleCollectdPlugin(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin, isDelete bool) error {
 156         var collectdConf string
 157         retryErr := retry.RetryOnConflict(retry.DefaultRetry, func() error {
 158                 cm, err := collectdutils.GetConfigMap(r.client, reqLogger, cr.Namespace)
 159                 if err != nil {
 160                         reqLogger.Error(err, "Skip reconcile: ConfigMap not found")
 161                         return err
 162                 }
 163                 reqLogger.V(1).Info(":::: ConfigMap Info ::::", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
 164
 165                 collectdConf, err := collectdutils.RebuildCollectdConf(r.client, cr.Namespace, isDelete, cr.Spec.PluginName)
 166                 if err != nil {
 167                         reqLogger.Error(err, "Skip reconcile: Rebuild conf failed")
 168                         return err
 169                 }
 170
 171                 cm.SetAnnotations(map[string]string{
 172                         "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
 173                 })
 174                 cm.Data["collectd.conf"] = collectdConf
 175
 176                 // Update the ConfigMap with new Spec and reload DaemonSets
 177                 reqLogger.Info("Updating the ConfigMap", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
 178                 updateErr := r.client.Update(context.TODO(), cm)
 179                 return updateErr
 180         })
 181         if retryErr != nil {
 182                 panic(fmt.Errorf("Update failed: %v", retryErr))
 183         }
 184         retryErr = retry.RetryOnConflict(retry.DefaultRetry, func() error {
 185                 // Retrieve the latest version of Daemonset before attempting update
 186                 // RetryOnConflict uses exponential backoff to avoid exhausting the apiserver
 187                 // Select DaemonSets with label
 188                 dsList := &appsv1.DaemonSetList{}
 189                 opts := &client.ListOptions{}
 190                 labelSelector, err := collectdutils.GetWatchLabels()
 191                 if err != nil {
 192                         reqLogger.Error(err, "Failed to get watch labels, continuing with default label")
 193                 }
 194                 opts.SetLabelSelector(labelSelector)
 195                 opts.InNamespace(cr.Namespace)
 196                 err = r.client.List(context.TODO(), opts, dsList)
 197                 if err != nil {
 198                         panic(fmt.Errorf("Failed to get latest version of DaemonSet: %v", err))
 199                 }
 200
 201                 if dsList.Items == nil || len(dsList.Items) == 0 {
 202                         return errors.NewNotFound(corev1.Resource("daemonset"), "DaemonSet")
 203                 }
 204                 ds := &dsList.Items[0]
 205                 //Restart Collectd Pods
 206                 reqLogger.Info("Reloading the Daemonset", "DaemonSet.Namespace", ds.Namespace, "DaemonSet.Name", ds.Name)
 207                 //Restart only if hash of conf has changed.
 208                 ds.Spec.Template.SetAnnotations(map[string]string{
 209                         "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
 210                 })
 211                 updateErr := r.client.Update(context.TODO(), ds)
 212                 return updateErr
 213         })
 214         if retryErr != nil {
 215                 panic(fmt.Errorf("Update failed: %v", retryErr))
 216         }
 217
 218         err := r.updateStatus(cr)
 219         if err != nil {
 220                 reqLogger.Error(err, "Unable to update status")
 221                 return err
 222         }
 223         // Reconcile success
 224         reqLogger.Info("Reconcile success!!")
 225         return nil
 226 }
 227
 228 // Handle Delete CR event for additional cleanup
 229 func (r *ReconcileCollectdPlugin) handleDelete(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) (bool, error) {
 230         // Check if the CollectdPlugin instance is marked to be deleted, which is
 231         // indicated by the deletion timestamp being set.
 232         isMarkedToBeDeleted := cr.GetDeletionTimestamp() != nil
 233         if isMarkedToBeDeleted {
 234                 // Update status to Deleting state
 235                 cr.Status.Status = onapv1alpha1.Deleting
 236                 cr.Status.CollectdAgents = nil
 237                 _ = r.client.Status().Update(context.TODO(), cr)
 238
 239                 if collectdutils.Contains(cr.GetFinalizers(), collectdutils.CollectdFinalizer) {
 240                         // Run finalization logic for collectdPluginFinalizer. If the
 241                         // finalization logic fails, don't remove the finalizer so
 242                         // that we can retry during the next reconciliation.
 243                         if err := r.finalizeCollectdPlugin(reqLogger, cr); err != nil {
 244                                 return isMarkedToBeDeleted, err
 245                         }
 246
 247                         // Remove collectdPluginFinalizer. Once all finalizers have been
 248                         // removed, the object will be deleted.
 249                         cr.SetFinalizers(collectdutils.Remove(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
 250                         err := r.client.Update(context.TODO(), cr)
 251                         if err != nil {
 252                                 return isMarkedToBeDeleted, err
 253                         }
 254                 }
 255         }
 256         return isMarkedToBeDeleted, nil
 257 }
 258
 259 func (r *ReconcileCollectdPlugin) updateStatus(cr *onapv1alpha1.CollectdPlugin) error {
 260         switch cr.Status.Status {
 261         case onapv1alpha1.Initial:
 262                 cr.Status.Status = onapv1alpha1.Created
 263         case onapv1alpha1.Created, onapv1alpha1.Enabled:
 264                 pods, err := collectdutils.GetPodList(r.client, cr.Namespace)
 265                 if err != nil {
 266                         return err
 267                 }
 268                 if !reflect.DeepEqual(pods, cr.Status.CollectdAgents) {
 269                         cr.Status.CollectdAgents = pods
 270                         cr.Status.Status = onapv1alpha1.Enabled
 271                 }
 272         case onapv1alpha1.Deleting, onapv1alpha1.Deprecated:
 273                 return nil
 274         }
 275         err := r.client.Status().Update(context.TODO(), cr)
 276         return err
 277 }
 278
 279 func (r *ReconcileCollectdPlugin) finalizeCollectdPlugin(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
 280         // Cleanup by regenerating new collectd conf and rolling update of DaemonSet
 281         if err := r.handleCollectdPlugin(reqLogger, cr, true); err != nil {
 282                 reqLogger.Error(err, "Finalize CollectdPlugin failed!!")
 283                 return err
 284         }
 285         reqLogger.Info("Successfully finalized CollectdPlugin!!")
 286         return nil
 287 }
 288
 289 func (r *ReconcileCollectdPlugin) addFinalizer(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
 290         reqLogger.Info("Adding Finalizer for the CollectdPlugin")
 291         cr.SetFinalizers(append(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
 292         // Update status from Initial to Created
 293         // Since addFinalizer will be executed only once,
 294         // the status will be changed from Initial state to Created
 295         updateErr := r.updateStatus(cr)
 296         if updateErr != nil {
 297                 reqLogger.Error(updateErr, "Failed to update status from Initial state")
 298         }
 299         // Update CR
 300         err := r.client.Update(context.TODO(), cr)
 301         if err != nil {
 302                 reqLogger.Error(err, "Failed to update CollectdPlugin with finalizer")
 303                 return err
 304         }
 305         return nil
 306 }