vnfs/DAaaS/microservices/collectd-operator/pkg/controller/collectdglobal/collectdglobal_controller.go

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