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 dsutils "collectd-operator/pkg/controller/utils"
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"
32 var log = logf.Log.WithName("controller_collectdglobal")
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))
40 // newReconciler returns a new reconcile.Reconciler
41 func newReconciler(mgr manager.Manager) reconcile.Reconciler {
42 return &ReconcileCollectdGlobal{client: mgr.GetClient(), scheme: mgr.GetScheme()}
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})
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{})
61 log.V(1).Info("Add watcher for secondary resource Collectd Daemonset")
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, "=")
69 log.Error(err, "Failed to get watch labels, continuing with default label")
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 {
79 requests = append(requests, reconcile.Request{
80 NamespacedName: client.ObjectKey{Namespace: cg.Namespace, Name: cg.Name}})
93 // blank assignment to verify that ReconcileCollectdGlobal implements reconcile.Reconciler
94 var _ reconcile.Reconciler = &ReconcileCollectdGlobal{}
96 // ReconcileCollectdGlobal reconciles a CollectdGlobal object
97 type ReconcileCollectdGlobal struct {
98 // This client, initialized using mgr.Client() above, is a split client
99 // that reads objects from the cache and writes to the apiserver
101 scheme *runtime.Scheme
104 // Reconcile reads that state of the cluster for a CollectdGlobal object and makes changes based on the state read
105 // and what is in the CollectdGlobal.Spec
106 // TODO(user): Modify this Reconcile function to implement your Controller logic. This example creates
107 // a Pod as an example
109 // The Controller will requeue the Request to be processed again if the returned error is non-nil or
110 // Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
111 func (r *ReconcileCollectdGlobal) Reconcile(request reconcile.Request) (reconcile.Result, error) {
112 reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
113 reqLogger.Info("Reconciling CollectdGlobal")
115 // Fetch the CollectdGlobal instance
116 instance := &onapv1alpha1.CollectdGlobal{}
117 err := r.client.Get(context.TODO(), request.NamespacedName, instance)
119 if errors.IsNotFound(err) {
120 // Request object not found, could have been deleted after reconcile request.
121 // Owned objects are automatically garbage collected. For additional cleanup logic use finalizers.
122 // Return and don't requeue
123 reqLogger.V(1).Info("CollectdGlobal object Not found")
124 return reconcile.Result{}, nil
126 // Error reading the object - requeue the request.
127 reqLogger.V(1).Info("Error reading the CollectdGlobal object, Requeuing")
128 return reconcile.Result{}, err
131 // Handle Delete CR for additional cleanup
132 isDelete, err := r.handleDelete(reqLogger, instance)
134 return reconcile.Result{}, err
137 // Add finalizer for this CR
138 if !collectdutils.Contains(instance.GetFinalizers(), collectdutils.CollectdFinalizer) {
139 if err := r.addFinalizer(reqLogger, instance); err != nil {
140 return reconcile.Result{}, err
142 return reconcile.Result{}, nil
144 // Handle the reconciliation for CollectdGlobal.
145 // At this stage the Status of the CollectdGlobal should NOT be ""
146 err = r.handleCollectdGlobal(reqLogger, instance, false)
147 return reconcile.Result{}, err
150 // handleCollectdGlobal regenerates the collectd conf on CR Create, Update, Delete events
151 func (r *ReconcileCollectdGlobal) handleCollectdGlobal(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal, isDelete bool) error {
152 var collectdConf string
154 retryErr := retry.RetryOnConflict(retry.DefaultRetry, func() error {
155 cm, err := collectdutils.GetConfigMap(r.client, reqLogger, cr.Namespace)
157 reqLogger.Info(":::: Skip current reconcile:::: ConfigMap not found. Cache might be stale. Requeue")
161 reqLogger.V(1).Info(":::: ConfigMap Info ::::", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
163 collectdConf, err := collectdutils.RebuildCollectdConf(r.client, cr.Namespace, isDelete, "")
165 reqLogger.Error(err, "Skip reconcile: Rebuild conf failed")
169 cm.SetAnnotations(map[string]string{
170 "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
173 cm.Data["collectd.conf"] = collectdConf
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 updateErr := r.client.Update(context.TODO(), cm)
180 panic(fmt.Errorf("Update failed: %v", retryErr))
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()
191 reqLogger.Error(err, "Failed to get watch labels, continuing with default label")
193 opts.SetLabelSelector(labelSelector)
194 opts.InNamespace(cr.Namespace)
195 err = r.client.List(context.TODO(), opts, dsList)
197 panic(fmt.Errorf("Failed to get latest version of DaemonSet: %v", err))
200 if dsList.Items == nil || len(dsList.Items) == 0 {
201 return errors.NewNotFound(corev1.Resource("daemonset"), "DaemonSet")
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)),
210 r.handleTypesDB(reqLogger, cr, ds, isDelete)
211 updateErr := r.client.Update(context.TODO(), ds)
215 panic(fmt.Errorf("Update failed: %v", retryErr))
218 err := r.updateStatus(cr)
220 reqLogger.Error(err, "Unable to update status")
224 reqLogger.Info("Reconcile success!!")
228 // Handle Delete CR event for additional cleanup
229 func (r *ReconcileCollectdGlobal) handleDelete(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal) (bool, error) {
230 // Check if the CollectdGlobal instance is marked to be deleted, which is
231 // indicated by the deletion timestamp being set.
232 isMarkedToBeDeleted := cr.GetDeletionTimestamp() != nil
233 if isMarkedToBeDeleted {
234 // Update status to Deleting state
235 cr.Status.Status = onapv1alpha1.Deleting
236 cr.Status.CollectdAgents = nil
237 _ = r.client.Status().Update(context.TODO(), cr)
239 if collectdutils.Contains(cr.GetFinalizers(), collectdutils.CollectdFinalizer) {
240 // Run finalization logic for CollectdFinalizer. If the
241 // finalization logic fails, don't remove the finalizer so
242 // that we can retry during the next reconciliation.
243 if err := r.finalizeCollectdGlobal(reqLogger, cr); err != nil {
244 return isMarkedToBeDeleted, err
247 // Remove CollectdFinalizer. Once all finalizers have been
248 // removed, the object will be deleted.
249 cr.SetFinalizers(collectdutils.Remove(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
250 err := r.client.Update(context.TODO(), cr)
252 return isMarkedToBeDeleted, err
256 return isMarkedToBeDeleted, nil
259 func (r *ReconcileCollectdGlobal) updateStatus(cr *onapv1alpha1.CollectdGlobal) error {
260 switch cr.Status.Status {
261 case onapv1alpha1.Initial:
262 cr.Status.Status = onapv1alpha1.Created
263 case onapv1alpha1.Created, onapv1alpha1.Enabled:
264 pods, err := collectdutils.GetPodList(r.client, cr.Namespace)
268 if !reflect.DeepEqual(pods, cr.Status.CollectdAgents) {
269 cr.Status.CollectdAgents = pods
270 cr.Status.Status = onapv1alpha1.Enabled
272 case onapv1alpha1.Deleting, onapv1alpha1.Deprecated:
275 err := r.client.Status().Update(context.TODO(), cr)
279 func (r *ReconcileCollectdGlobal) finalizeCollectdGlobal(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal) error {
280 // Cleanup by regenerating new collectd conf and rolling update of DaemonSet
281 if err := r.handleCollectdGlobal(reqLogger, cr, true); err != nil {
282 reqLogger.Error(err, "Finalize CollectdGlobal failed!!")
285 reqLogger.Info("Successfully finalized CollectdGlobal!!")
289 func (r *ReconcileCollectdGlobal) addFinalizer(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal) error {
290 reqLogger.Info("Adding Finalizer for the CollectdGlobal")
291 cr.SetFinalizers(append(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
292 // Update status from Initial to Created
293 // Since addFinalizer will be executed only once,
294 // the status will be changed from Initial state to Created
295 updateErr := r.updateStatus(cr)
296 if updateErr != nil {
297 reqLogger.Error(updateErr, "Failed to update status from Initial state")
300 err := r.client.Update(context.TODO(), cr)
302 reqLogger.Error(err, "Failed to update CollectdGlobal with finalizer")
308 func (r *ReconcileCollectdGlobal) handleTypesDB(reqLogger logr.Logger, cr *onapv1alpha1.CollectdGlobal, ds *appsv1.DaemonSet, isDelete bool) error {
309 if isDelete || cr.Spec.ConfigMap == "" {
310 dsutils.RemoveTypesDB(ds)
314 cm := &corev1.ConfigMap{}
315 key := types.NamespacedName{Namespace: cr.Namespace, Name: cr.Spec.ConfigMap}
316 err := r.client.Get(context.TODO(), key, cm)
318 reqLogger.Info("Error getting TypesDB")
321 dsutils.UpsertTypesDB(ds, cm, cr)