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
  15         appsv1 "k8s.io/api/apps/v1"
  16         corev1 "k8s.io/api/core/v1"
  17         extensionsv1beta1 "k8s.io/api/extensions/v1beta1"
  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
  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 (Defautl  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 {
  76                                                 return nil
  77                                         }
  78                                         for _, cp := range cpList.Items {
  79                                                 requests = append(requests, reconcile.Request{
  80                                                         NamespacedName: client.ObjectKey{Namespace: cp.Namespace, Name: cp.Name}})
  81                                         }
  82                                         return requests
  83                                 }
  84                                 return nil
  85                         }),
  86                 })
  87         if err != nil {
  88                 return err
  89         }
  90
  91         return nil
  92 }
  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
 107 // Reconcile reads that state of the cluster for a CollectdPlugin object and makes changes based on the state read
 108 // and what is in the CollectdPlugin.Spec
 109 // TODO(user): Modify this Reconcile function to implement your Controller logic.  This example creates
 110 // a Pod as an example
 111 // Note:
 112 // The Controller will requeue the Request to be processed again if the returned error is non-nil or
 113 // Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
 114 func (r *ReconcileCollectdPlugin) Reconcile(request reconcile.Request) (reconcile.Result, error) {
 115         reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
 116         reqLogger.Info("Reconciling CollectdPlugin")
 117
 118         // Fetch the CollectdPlugin instance
 119         instance := &onapv1alpha1.CollectdPlugin{}
 120         err := r.client.Get(context.TODO(), request.NamespacedName, instance)
 121         if err != nil {
 122                 if errors.IsNotFound(err) {
 123                         // Request object not found, could have been deleted after reconcile request.
 124                         // Owned objects are automatically garbage collected. For additional cleanup logic use finalizers.
 125                         // Return and don't requeue
 126                         reqLogger.V(1).Info("CollectdPlugin object Not found")
 127                         return reconcile.Result{}, nil
 128                 }
 129                 // Error reading the object - requeue the request.
 130                 reqLogger.V(1).Info("Error reading the CollectdPlugin object, Requeuing")
 131                 return reconcile.Result{}, err
 132         }
 133
 134         // Handle Delete CR for additional cleanup
 135         isDelete, err := r.handleDelete(reqLogger, instance)
 136         if isDelete {
 137                 return reconcile.Result{}, err
 138         }
 139
 140         // Add finalizer for this CR
 141         if !collectdutils.Contains(instance.GetFinalizers(), collectdutils.CollectdFinalizer) {
 142                 if err := r.addFinalizer(reqLogger, instance); err != nil {
 143                         return reconcile.Result{}, err
 144                 }
 145                 return reconcile.Result{}, nil
 146         }
 147         // Handle the reconciliation for CollectdPlugin.
 148         // At this stage the Status of the CollectdPlugin should NOT be ""
 149         err = r.handleCollectdPlugin(reqLogger, instance, false)
 150         return reconcile.Result{}, err
 151 }
 152
 153 // handleCollectdPlugin regenerates the collectd conf on CR Create, Update, Delete events
 154 func (r *ReconcileCollectdPlugin) handleCollectdPlugin(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin, isDelete bool) error {
 155
 156         rmap, err := collectdutils.FindResourceMapForCR(r.client, reqLogger, cr.Namespace)
 157         if err != nil {
 158                 reqLogger.Error(err, "Skip reconcile: Resources not found")
 159                 return err
 160         }
 161
 162         cm := rmap.ConfigMap
 163         reqLogger.V(1).Info("Found ResourceMap")
 164         reqLogger.V(1).Info(":::: ConfigMap Info ::::", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
 165
 166         collectdConf, err := collectdutils.RebuildCollectdConf(r.client, cr.Namespace, isDelete, cr.Spec.PluginName)
 167         if err != nil {
 168                 reqLogger.Error(err, "Skip reconcile: Rebuild conf failed")
 169                 return err
 170         }
 171
 172         cm.SetAnnotations(map[string]string{
 173                 "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
 174         })
 175
 176         cm.Data["collectd.conf"] = collectdConf
 177
 178         // Update the ConfigMap with new Spec and reload DaemonSets
 179         reqLogger.Info("Updating the ConfigMap", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
 180         log.V(1).Info("ConfigMap Data", "Map: ", cm.Data)
 181         err = r.client.Update(context.TODO(), cm)
 182         if err != nil {
 183                 reqLogger.Error(err, "Update the ConfigMap failed", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
 184                 return err
 185         }
 186
 187         retryErr := retry.RetryOnConflict(retry.DefaultRetry, func() error {
 188                 // Retrieve the latest version of Daemonset before attempting update
 189                 // RetryOnConflict uses exponential backoff to avoid exhausting the apiserver
 190                 // Select DaemonSets with label
 191                 dsList := &extensionsv1beta1.DaemonSetList{}
 192                 opts := &client.ListOptions{}
 193                 labelSelector, err := collectdutils.GetWatchLabels()
 194                 if err != nil {
 195                         reqLogger.Error(err, "Failed to get watch labels, continuing with default label")
 196                 }
 197                 opts.SetLabelSelector(labelSelector)
 198                 opts.InNamespace(cr.Namespace)
 199                 err = r.client.List(context.TODO(), opts, dsList)
 200                 if err != nil {
 201                         panic(fmt.Errorf("Failed to get latest version of DaemonSet: %v", err))
 202                 }
 203
 204                 if dsList.Items == nil || len(dsList.Items) == 0 {
 205                         return errors.NewNotFound(corev1.Resource("daemonset"), "DaemonSet")
 206                 }
 207                 ds := &dsList.Items[0]
 208                 //Restart Collectd Pods
 209                 reqLogger.Info("Reloading the Daemonset", "DaemonSet.Namespace", ds.Namespace, "DaemonSet.Name", ds.Name)
 210                 //Restart only if hash of conf has changed.
 211                 ds.Spec.Template.SetAnnotations(map[string]string{
 212                         "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
 213                 })
 214                 updateErr := r.client.Update(context.TODO(), ds)
 215                 return updateErr
 216         })
 217         if retryErr != nil {
 218                 panic(fmt.Errorf("Update failed: %v", retryErr))
 219         }
 220
 221         err = r.updateStatus(cr)
 222         if err != nil {
 223                 reqLogger.Error(err, "Unable to update status")
 224                 return err
 225         }
 226         // Reconcile success
 227         reqLogger.Info("Reconcile success!!")
 228         return nil
 229 }
 230
 231 // Handle Delete CR event for additional cleanup
 232 func (r *ReconcileCollectdPlugin) handleDelete(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) (bool, error) {
 233         // Check if the CollectdPlugin instance is marked to be deleted, which is
 234         // indicated by the deletion timestamp being set.
 235         isMarkedToBeDeleted := cr.GetDeletionTimestamp() != nil
 236         if isMarkedToBeDeleted {
 237                 // Update status to Deleting state
 238                 cr.Status.Status = onapv1alpha1.Deleting
 239                 cr.Status.CollectdAgents = nil
 240                 _ = r.client.Status().Update(context.TODO(), cr)
 241
 242                 if collectdutils.Contains(cr.GetFinalizers(), collectdutils.CollectdFinalizer) {
 243                         // Run finalization logic for collectdPluginFinalizer. If the
 244                         // finalization logic fails, don't remove the finalizer so
 245                         // that we can retry during the next reconciliation.
 246                         if err := r.finalizeCollectdPlugin(reqLogger, cr); err != nil {
 247                                 return isMarkedToBeDeleted, err
 248                         }
 249
 250                         // Remove collectdPluginFinalizer. Once all finalizers have been
 251                         // removed, the object will be deleted.
 252                         cr.SetFinalizers(collectdutils.Remove(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
 253                         err := r.client.Update(context.TODO(), cr)
 254                         if err != nil {
 255                                 return isMarkedToBeDeleted, err
 256                         }
 257                 }
 258         }
 259         return isMarkedToBeDeleted, nil
 260 }
 261
 262 func (r *ReconcileCollectdPlugin) updateStatus(cr *onapv1alpha1.CollectdPlugin) error {
 263         switch cr.Status.Status {
 264         case onapv1alpha1.Initial:
 265                 cr.Status.Status = onapv1alpha1.Created
 266         case onapv1alpha1.Created, onapv1alpha1.Enabled:
 267                 pods, err := collectdutils.GetPodList(r.client, cr.Namespace)
 268                 if err != nil {
 269                         return err
 270                 }
 271                 if !reflect.DeepEqual(pods, cr.Status.CollectdAgents) {
 272                         cr.Status.CollectdAgents = pods
 273                         cr.Status.Status = onapv1alpha1.Enabled
 274                 }
 275         case onapv1alpha1.Deleting, onapv1alpha1.Deprecated:
 276                 return nil
 277         }
 278         err := r.client.Status().Update(context.TODO(), cr)
 279         return err
 280 }
 281
 282 func (r *ReconcileCollectdPlugin) finalizeCollectdPlugin(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
 283         // Cleanup by regenerating new collectd conf and rolling update of DaemonSet
 284         if err := r.handleCollectdPlugin(reqLogger, cr, true); err != nil {
 285                 reqLogger.Error(err, "Finalize CollectdPlugin failed!!")
 286                 return err
 287         }
 288         reqLogger.Info("Successfully finalized CollectdPlugin!!")
 289         return nil
 290 }
 291
 292 func (r *ReconcileCollectdPlugin) addFinalizer(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
 293         reqLogger.Info("Adding Finalizer for the CollectdPlugin")
 294         cr.SetFinalizers(append(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
 295         // Update status from Initial to Created
 296         // Since addFinalizer will be executed only once,
 297         // the status will be changed from Initial state to Created
 298         updateErr := r.updateStatus(cr)
 299         if updateErr != nil {
 300                 reqLogger.Error(updateErr, "Failed to update status from Initial state")
 301         }
 302         // Update CR
 303         err := r.client.Update(context.TODO(), cr)
 304         if err != nil {
 305                 reqLogger.Error(err, "Failed to update CollectdPlugin with finalizer")
 306                 return err
 307         }
 308         return nil
 309 }