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         "k8s.io/apimachinery/pkg/api/errors"
  18         "k8s.io/apimachinery/pkg/runtime"
  19         "k8s.io/client-go/util/retry"
  20         "sigs.k8s.io/controller-runtime/pkg/client"
  21         "sigs.k8s.io/controller-runtime/pkg/controller"
  22         "sigs.k8s.io/controller-runtime/pkg/handler"
  23         "sigs.k8s.io/controller-runtime/pkg/manager"
  24         "sigs.k8s.io/controller-runtime/pkg/reconcile"
  25         logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
  26         "sigs.k8s.io/controller-runtime/pkg/source"
  27 )
  28
  29 var log = logf.Log.WithName("controller_collectdplugin")
  30
  31 // Add creates a new CollectdPlugin Controller and adds it to the Manager. The Manager will set fields on the Controller
  32 // and Start it when the Manager is Started.
  33 func Add(mgr manager.Manager) error {
  34         return add(mgr, newReconciler(mgr))
  35 }
  36
  37 // newReconciler returns a new reconcile.Reconciler
  38 func newReconciler(mgr manager.Manager) reconcile.Reconciler {
  39         return &ReconcileCollectdPlugin{client: mgr.GetClient(), scheme: mgr.GetScheme()}
  40 }
  41
  42 // add adds a new Controller to mgr with r as the reconcile.Reconciler
  43 func add(mgr manager.Manager, r reconcile.Reconciler) error {
  44         // Create a new controller
  45         log.V(1).Info("Creating a new controller for CollectdPlugin")
  46         c, err := controller.New("collectdplugin-controller", mgr, controller.Options{Reconciler: r})
  47         if err != nil {
  48                 return err
  49         }
  50
  51         // Watch for changes to primary resource CollectdPlugin
  52         log.V(1).Info("Add watcher for primary resource CollectdPlugin")
  53         err = c.Watch(&source.Kind{Type: &onapv1alpha1.CollectdPlugin{}}, &handler.EnqueueRequestForObject{}, predicate.GenerationChangedPredicate{})
  54         if err != nil {
  55                 return err
  56         }
  57
  58         log.V(1).Info("Add watcher for secondary resource Collectd Daemonset")
  59         err = c.Watch(
  60                 &source.Kind{Type: &appsv1.DaemonSet{}},
  61                 &handler.EnqueueRequestsFromMapFunc{
  62                         ToRequests: handler.ToRequestsFunc(func(a handler.MapObject) []reconcile.Request {
  63                                 labelSelector, err := collectdutils.GetWatchLabels()
  64                                 labels := strings.Split(labelSelector, "=")
  65                                 if err != nil {
  66                                         log.Error(err, "Failed to get watch labels, continuing with default label")
  67                                 }
  68                                 rcp := r.(*ReconcileCollectdPlugin)
  69                                 // Select the Daemonset with labelSelector (Defautl  is app=collectd)
  70                                 if a.Meta.GetLabels()[labels[0]] == labels[1] {
  71                                         var requests []reconcile.Request
  72                                         cpList, err := collectdutils.GetCollectdPluginList(rcp.client, a.Meta.GetNamespace())
  73                                         if err != nil {
  74                                                 return nil
  75                                         }
  76                                         for _, cp := range cpList.Items {
  77                                                 requests = append(requests, reconcile.Request{
  78                                                         NamespacedName: client.ObjectKey{Namespace: cp.Namespace, Name: cp.Name}})
  79                                         }
  80                                         return requests
  81                                 }
  82                                 return nil
  83                         }),
  84                 })
  85         if err != nil {
  86                 return err
  87         }
  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
 152         rmap, err := collectdutils.FindResourceMapForCR(r.client, reqLogger, cr.Namespace)
 153         if err != nil {
 154                 reqLogger.Error(err, "Skip reconcile: Resources not found")
 155                 return err
 156         }
 157
 158         cm := rmap.ConfigMap
 159         reqLogger.V(1).Info("Found ResourceMap")
 160         reqLogger.V(1).Info(":::: ConfigMap Info ::::", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
 161
 162         collectdConf, err := collectdutils.RebuildCollectdConf(r.client, cr.Namespace, isDelete, cr.Spec.PluginName)
 163         if err != nil {
 164                 reqLogger.Error(err, "Skip reconcile: Rebuild conf failed")
 165                 return err
 166         }
 167
 168         cm.SetAnnotations(map[string]string{
 169                 "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
 170         })
 171
 172         cm.Data["collectd.conf"] = collectdConf
 173
 174         // Update the ConfigMap with new Spec and reload DaemonSets
 175         reqLogger.Info("Updating the ConfigMap", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
 176         log.V(1).Info("ConfigMap Data", "Map: ", cm.Data)
 177         err = r.client.Update(context.TODO(), cm)
 178         if err != nil {
 179                 reqLogger.Error(err, "Update the ConfigMap failed", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
 180                 return err
 181         }
 182
 183         retryErr := retry.RetryOnConflict(retry.DefaultRetry, func() error {
 184                 // Retrieve the latest version of Daemonset before attempting update
 185                 // RetryOnConflict uses exponential backoff to avoid exhausting the apiserver
 186                 // Select DaemonSets with label
 187                 dsList := &appsv1.DaemonSetList{}
 188                 opts := &client.ListOptions{}
 189                 labelSelector, err := collectdutils.GetWatchLabels()
 190                 if err != nil {
 191                         reqLogger.Error(err, "Failed to get watch labels, continuing with default label")
 192                 }
 193                 opts.SetLabelSelector(labelSelector)
 194                 opts.InNamespace(cr.Namespace)
 195                 err = r.client.List(context.TODO(), opts, dsList)
 196                 if err != nil {
 197                         panic(fmt.Errorf("Failed to get latest version of DaemonSet: %v", err))
 198                 }
 199
 200                 if dsList.Items == nil || len(dsList.Items) == 0 {
 201                         return errors.NewNotFound(corev1.Resource("daemonset"), "DaemonSet")
 202                 }
 203                 ds := &dsList.Items[0]
 204                 //Restart Collectd Pods
 205                 reqLogger.Info("Reloading the Daemonset", "DaemonSet.Namespace", ds.Namespace, "DaemonSet.Name", ds.Name)
 206                 //Restart only if hash of conf has changed.
 207                 ds.Spec.Template.SetAnnotations(map[string]string{
 208                         "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
 209                 })
 210                 updateErr := r.client.Update(context.TODO(), ds)
 211                 return updateErr
 212         })
 213         if retryErr != nil {
 214                 panic(fmt.Errorf("Update failed: %v", retryErr))
 215         }
 216
 217         err = r.updateStatus(cr)
 218         if err != nil {
 219                 reqLogger.Error(err, "Unable to update status")
 220                 return err
 221         }
 222         // Reconcile success
 223         reqLogger.Info("Reconcile success!!")
 224         return nil
 225 }
 226
 227 // Handle Delete CR event for additional cleanup
 228 func (r *ReconcileCollectdPlugin) handleDelete(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) (bool, error) {
 229         // Check if the CollectdPlugin instance is marked to be deleted, which is
 230         // indicated by the deletion timestamp being set.
 231         isMarkedToBeDeleted := cr.GetDeletionTimestamp() != nil
 232         if isMarkedToBeDeleted {
 233                 // Update status to Deleting state
 234                 cr.Status.Status = onapv1alpha1.Deleting
 235                 cr.Status.CollectdAgents = nil
 236                 _ = r.client.Status().Update(context.TODO(), cr)
 237
 238                 if collectdutils.Contains(cr.GetFinalizers(), collectdutils.CollectdFinalizer) {
 239                         // Run finalization logic for collectdPluginFinalizer. If the
 240                         // finalization logic fails, don't remove the finalizer so
 241                         // that we can retry during the next reconciliation.
 242                         if err := r.finalizeCollectdPlugin(reqLogger, cr); err != nil {
 243                                 return isMarkedToBeDeleted, err
 244                         }
 245
 246                         // Remove collectdPluginFinalizer. Once all finalizers have been
 247                         // removed, the object will be deleted.
 248                         cr.SetFinalizers(collectdutils.Remove(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
 249                         err := r.client.Update(context.TODO(), cr)
 250                         if err != nil {
 251                                 return isMarkedToBeDeleted, err
 252                         }
 253                 }
 254         }
 255         return isMarkedToBeDeleted, nil
 256 }
 257
 258 func (r *ReconcileCollectdPlugin) updateStatus(cr *onapv1alpha1.CollectdPlugin) error {
 259         switch cr.Status.Status {
 260         case onapv1alpha1.Initial:
 261                 cr.Status.Status = onapv1alpha1.Created
 262         case onapv1alpha1.Created, onapv1alpha1.Enabled:
 263                 pods, err := collectdutils.GetPodList(r.client, cr.Namespace)
 264                 if err != nil {
 265                         return err
 266                 }
 267                 if !reflect.DeepEqual(pods, cr.Status.CollectdAgents) {
 268                         cr.Status.CollectdAgents = pods
 269                         cr.Status.Status = onapv1alpha1.Enabled
 270                 }
 271         case onapv1alpha1.Deleting, onapv1alpha1.Deprecated:
 272                 return nil
 273         }
 274         err := r.client.Status().Update(context.TODO(), cr)
 275         return err
 276 }
 277
 278 func (r *ReconcileCollectdPlugin) finalizeCollectdPlugin(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
 279         // Cleanup by regenerating new collectd conf and rolling update of DaemonSet
 280         if err := r.handleCollectdPlugin(reqLogger, cr, true); err != nil {
 281                 reqLogger.Error(err, "Finalize CollectdPlugin failed!!")
 282                 return err
 283         }
 284         reqLogger.Info("Successfully finalized CollectdPlugin!!")
 285         return nil
 286 }
 287
 288 func (r *ReconcileCollectdPlugin) addFinalizer(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
 289         reqLogger.Info("Adding Finalizer for the CollectdPlugin")
 290         cr.SetFinalizers(append(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
 291         // Update status from Initial to Created
 292         // Since addFinalizer will be executed only once,
 293         // the status will be changed from Initial state to Created
 294         updateErr := r.updateStatus(cr)
 295         if updateErr != nil {
 296                 reqLogger.Error(updateErr, "Failed to update status from Initial state")
 297         }
 298         // Update CR
 299         err := r.client.Update(context.TODO(), cr)
 300         if err != nil {
 301                 reqLogger.Error(err, "Failed to update CollectdPlugin with finalizer")
 302                 return err
 303         }
 304         return nil
 305 }