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

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