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