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