10 "github.com/go-logr/logr"
11 "github.com/operator-framework/operator-sdk/pkg/predicate"
13 onapv1alpha1 "collectd-operator/pkg/apis/onap/v1alpha1"
14 collectdutils "collectd-operator/pkg/controller/utils"
15 dspredicate "collectd-operator/pkg/controller/utils"
16 dsutils "collectd-operator/pkg/controller/utils"
18 appsv1 "k8s.io/api/apps/v1"
19 corev1 "k8s.io/api/core/v1"
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"
33 var log = logf.Log.WithName("controller_collectdglobal")
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))
41 // newReconciler returns a new reconcile.Reconciler
42 func newReconciler(mgr manager.Manager) reconcile.Reconciler {
43 return &ReconcileCollectdGlobal{client: mgr.GetClient(), scheme: mgr.GetScheme()}
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})
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{})
62 log.V(1).Info("Add watcher for secondary resource Collectd Daemonset")
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, "=")
70 log.Error(err, "Failed to get watch labels, continuing with default label")
72 rcp := r.(*ReconcileCollectdGlobal)
73 // Select the Daemonset with labelSelector (Default 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 log.V(1).Info("No CollectdGlobal CR instance Exist")
81 requests = append(requests, reconcile.Request{
82 NamespacedName: client.ObjectKey{Namespace: cg.Namespace, Name: cg.Name}})
87 }, dspredicate.DaemonSetStatusChangedPredicate{})
95 // blank assignment to verify that ReconcileCollectdGlobal implements reconcile.Reconciler
96 var _ reconcile.Reconciler = &ReconcileCollectdGlobal{}
98 // ReconcileCollectdGlobal reconciles a CollectdGlobal object
99 type ReconcileCollectdGlobal 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
103 scheme *runtime.Scheme
106 // Reconcile reads that state of the cluster for a CollectdGlobal object and makes changes based on the state read
107 // and what is in the CollectdGlobal.Spec
108 // TODO(user): Modify this Reconcile function to implement your Controller logic. This example creates
109 // a Pod as an example
111 // The Controller will requeue the Request to be processed again if the returned error is non-nil or
112 // Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
113 func (r *ReconcileCollectdGlobal) Reconcile(request reconcile.Request) (reconcile.Result, error) {
114 reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
115 reqLogger.Info("Reconciling CollectdGlobal")
117 // Fetch the CollectdGlobal instance
118 instance := &onapv1alpha1.CollectdGlobal{}
119 err := r.client.Get(context.TODO(), request.NamespacedName, instance)
121 if errors.IsNotFound(err) {
122 // Request object not found, could have been deleted after reconcile request.
123 // Owned objects are automatically garbage collected. For additional cleanup logic use finalizers.
124 // Return and don't requeue
125 reqLogger.V(1).Info("CollectdGlobal object Not found")
126 return reconcile.Result{}, nil
128 // Error reading the object - requeue the request.
129 reqLogger.V(1).Info("Error reading the CollectdGlobal object, Requeuing")
130 return reconcile.Result{}, err
133 // Handle Delete CR for additional cleanup
134 isDelete, err := r.handleDelete(reqLogger, instance)
136 return reconcile.Result{}, err
139 // Add finalizer for this CR
140 if !collectdutils.Contains(instance.GetFinalizers(), collectdutils.CollectdFinalizer) {
141 if err := r.addFinalizer(reqLogger, instance); err != nil {
142 return reconcile.Result{}, err
144 //return reconcile.Result{}, nil
146 // Handle the reconciliation for CollectdGlobal.
147 // At this stage the Status of the CollectdGlobal should NOT be ""
148 err = r.handleCollectdGlobal(reqLogger, instance, false)
149 return reconcile.Result{}, err
152 // handleCollectdGlobal regenerates the collectd conf on CR Create, Update, Delete events
153 func (r *ReconcileCollectdGlobal) handleCollectdGlobal(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal, isDelete bool) error {
154 collectdutils.ReconcileLock.Lock()
155 defer collectdutils.ReconcileLock.Unlock()
157 retryErr := retry.RetryOnConflict(retry.DefaultRetry, func() error {
158 cm, err := collectdutils.GetConfigMap(r.client, reqLogger, cr.Namespace)
160 reqLogger.Info(":::: Skip current reconcile:::: ConfigMap not found. Cache might be stale. Requeue")
164 reqLogger.V(1).Info(":::: ConfigMap Info ::::", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
166 collectdConf, err := collectdutils.RebuildCollectdConf(r.client, cr.Namespace, isDelete, "")
168 reqLogger.Error(err, "Skip reconcile: Rebuild conf failed")
172 cm.SetAnnotations(map[string]string{
173 "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
176 cm.Data["collectd.conf"] = collectdConf
177 // Update the ConfigMap with new Spec and reload DaemonSets
178 reqLogger.Info("Updating the ConfigMap", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
179 updateErr := r.client.Update(context.TODO(), cm)
180 if updateErr != nil {
181 reqLogger.Error(updateErr, "Update ConfigMap failed")
185 // Retrieve the latest version of Daemonset before attempting update
186 // RetryOnConflict uses exponential backoff to avoid exhausting the apiserver
187 // Select DaemonSets with label
188 dsList := &appsv1.DaemonSetList{}
189 opts := &client.ListOptions{}
190 labelSelector, err := collectdutils.GetWatchLabels()
192 reqLogger.Error(err, "Failed to get watch labels, continuing with default label")
194 opts.SetLabelSelector(labelSelector)
195 opts.InNamespace(cr.Namespace)
196 err = r.client.List(context.TODO(), opts, dsList)
198 panic(fmt.Errorf("Failed to get latest version of DaemonSet: %v", err))
201 if dsList.Items == nil || len(dsList.Items) == 0 {
202 return errors.NewNotFound(corev1.Resource("daemonset"), "DaemonSet")
204 ds := &dsList.Items[0]
205 //Restart Collectd Pods
206 reqLogger.Info("Reloading the Daemonset", "DaemonSet.Namespace", ds.Namespace, "DaemonSet.Name", ds.Name)
207 //Restart only if hash of conf has changed.
208 ds.Spec.Template.SetAnnotations(map[string]string{
209 "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
211 r.handleTypesDB(reqLogger, cr, ds, isDelete)
212 updateErr = r.client.Update(context.TODO(), ds)
216 panic(fmt.Errorf("Update failed: %v", retryErr))
219 retryErr = retry.RetryOnConflict(retry.DefaultRetry, func() error {
220 err := r.updateStatus(cr)
225 panic(fmt.Errorf("Update failed: %v", retryErr))
228 reqLogger.Info("Reconcile success!!")
232 // Handle Delete CR event for additional cleanup
233 func (r *ReconcileCollectdGlobal) handleDelete(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal) (bool, error) {
234 // Check if the CollectdGlobal instance is marked to be deleted, which is
235 // indicated by the deletion timestamp being set.
236 isMarkedToBeDeleted := cr.GetDeletionTimestamp() != nil
237 if isMarkedToBeDeleted {
238 // Update status to Deleting state
239 cr.Status.Status = onapv1alpha1.Deleting
240 cr.Status.CollectdAgents = nil
241 _ = r.client.Status().Update(context.TODO(), cr)
243 if collectdutils.Contains(cr.GetFinalizers(), collectdutils.CollectdFinalizer) {
244 // Run finalization logic for CollectdFinalizer. If the
245 // finalization logic fails, don't remove the finalizer so
246 // that we can retry during the next reconciliation.
247 if err := r.finalizeCollectdGlobal(reqLogger, cr); err != nil {
248 return isMarkedToBeDeleted, err
251 // Remove CollectdFinalizer. Once all finalizers have been
252 // removed, the object will be deleted.
253 cr.SetFinalizers(collectdutils.Remove(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
254 err := r.client.Update(context.TODO(), cr)
256 return isMarkedToBeDeleted, err
260 return isMarkedToBeDeleted, nil
263 func (r *ReconcileCollectdGlobal) updateStatus(cr *onapv1alpha1.CollectdGlobal) error {
264 // Fetch the CollectdGlobal instance
265 instance := &onapv1alpha1.CollectdGlobal{}
266 key := types.NamespacedName{Namespace: cr.Namespace, Name: cr.Name}
267 err := r.client.Get(context.TODO(), key, instance)
271 switch instance.Status.Status {
272 case onapv1alpha1.Initial:
273 instance.Status.Status = onapv1alpha1.Created
274 case onapv1alpha1.Created, onapv1alpha1.Enabled:
275 pods, err := collectdutils.GetPodList(r.client, instance.Namespace)
279 if !reflect.DeepEqual(pods, instance.Status.CollectdAgents) {
280 instance.Status.CollectdAgents = pods
281 instance.Status.Status = onapv1alpha1.Enabled
283 case onapv1alpha1.Deleting, onapv1alpha1.Deprecated:
286 err = r.client.Status().Update(context.TODO(), instance)
290 func (r *ReconcileCollectdGlobal) finalizeCollectdGlobal(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal) error {
291 // Cleanup by regenerating new collectd conf and rolling update of DaemonSet
292 if err := r.handleCollectdGlobal(reqLogger, cr, true); err != nil {
293 reqLogger.Error(err, "Finalize CollectdGlobal failed!!")
296 reqLogger.Info("Successfully finalized CollectdGlobal!!")
300 func (r *ReconcileCollectdGlobal) addFinalizer(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal) error {
301 reqLogger.Info("Adding Finalizer for the CollectdGlobal")
302 cr.SetFinalizers(append(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
303 // Update status from Initial to Created
304 // Since addFinalizer will be executed only once,
305 // the status will be changed from Initial state to Created
306 // updateErr := r.updateStatus(cr)
307 // if updateErr != nil {
308 // reqLogger.Error(updateErr, "Failed to update status from Initial state")
311 cr.Status.Status = onapv1alpha1.Created
312 err := r.client.Update(context.TODO(), cr)
314 reqLogger.Error(err, "Failed to update CollectdGlobal with finalizer")
320 func (r *ReconcileCollectdGlobal) handleTypesDB(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal, ds *appsv1.DaemonSet, isDelete bool) error {
321 if isDelete || cr.Spec.ConfigMap == "" {
322 dsutils.RemoveTypesDB(ds)
326 cm := &corev1.ConfigMap{}
327 key := types.NamespacedName{Namespace: cr.Namespace, Name: cr.Spec.ConfigMap}
328 err := r.client.Get(context.TODO(), key, cm)
330 reqLogger.Info("Error getting TypesDB")
333 dsutils.UpsertTypesDB(ds, cm, cr)