9 "github.com/go-logr/logr"
10 "github.com/operator-framework/operator-sdk/pkg/predicate"
12 onapv1alpha1 "collectd-operator/pkg/apis/onap/v1alpha1"
13 collectdutils "collectd-operator/pkg/controller/utils"
15 appsv1 "k8s.io/api/apps/v1"
16 corev1 "k8s.io/api/core/v1"
17 extensionsv1beta1 "k8s.io/api/extensions/v1beta1"
18 "k8s.io/apimachinery/pkg/api/errors"
19 "k8s.io/apimachinery/pkg/runtime"
20 "k8s.io/client-go/util/retry"
21 "sigs.k8s.io/controller-runtime/pkg/client"
22 "sigs.k8s.io/controller-runtime/pkg/controller"
23 "sigs.k8s.io/controller-runtime/pkg/handler"
24 "sigs.k8s.io/controller-runtime/pkg/manager"
25 "sigs.k8s.io/controller-runtime/pkg/reconcile"
26 logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
27 "sigs.k8s.io/controller-runtime/pkg/source"
30 var log = logf.Log.WithName("controller_collectdplugin")
32 // Add creates a new CollectdPlugin Controller and adds it to the Manager. The Manager will set fields on the Controller
33 // and Start it when the Manager is Started.
34 func Add(mgr manager.Manager) error {
35 return add(mgr, newReconciler(mgr))
38 // newReconciler returns a new reconcile.Reconciler
39 func newReconciler(mgr manager.Manager) reconcile.Reconciler {
40 return &ReconcileCollectdPlugin{client: mgr.GetClient(), scheme: mgr.GetScheme()}
43 // add adds a new Controller to mgr with r as the reconcile.Reconciler
44 func add(mgr manager.Manager, r reconcile.Reconciler) error {
45 // Create a new controller
46 log.V(1).Info("Creating a new controller for CollectdPlugin")
47 c, err := controller.New("collectdplugin-controller", mgr, controller.Options{Reconciler: r})
52 // Watch for changes to primary resource CollectdPlugin
53 log.V(1).Info("Add watcher for primary resource CollectdPlugin")
54 err = c.Watch(&source.Kind{Type: &onapv1alpha1.CollectdPlugin{}}, &handler.EnqueueRequestForObject{}, predicate.GenerationChangedPredicate{})
59 log.V(1).Info("Add watcher for secondary resource Collectd Daemonset")
61 &source.Kind{Type: &appsv1.DaemonSet{}},
62 &handler.EnqueueRequestsFromMapFunc{
63 ToRequests: handler.ToRequestsFunc(func(a handler.MapObject) []reconcile.Request {
64 labelSelector, err := collectdutils.GetWatchLabels()
65 labels := strings.Split(labelSelector, "=")
67 log.Error(err, "Failed to get watch labels, continuing with default label")
69 rcp := r.(*ReconcileCollectdPlugin)
70 // Select the Daemonset with labelSelector (Defautl is app=collectd)
71 if a.Meta.GetLabels()[labels[0]] == labels[1] {
72 var requests []reconcile.Request
73 cpList, err := collectdutils.GetCollectdPluginList(rcp.client, a.Meta.GetNamespace())
77 for _, cp := range cpList.Items {
78 requests = append(requests, reconcile.Request{
79 NamespacedName: client.ObjectKey{Namespace: cp.Namespace, Name: cp.Name}})
93 // blank assignment to verify that ReconcileCollectdPlugin implements reconcile.Reconciler
94 var _ reconcile.Reconciler = &ReconcileCollectdPlugin{}
96 // ReconcileCollectdPlugin reconciles a CollectdPlugin object
97 type ReconcileCollectdPlugin 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 CollectdPlugin object and makes changes based on the state read
105 // and what is in the CollectdPlugin.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 *ReconcileCollectdPlugin) Reconcile(request reconcile.Request) (reconcile.Result, error) {
112 reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
113 reqLogger.Info("Reconciling CollectdPlugin")
115 // Fetch the CollectdPlugin instance
116 instance := &onapv1alpha1.CollectdPlugin{}
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("CollectdPlugin object Not found")
124 return reconcile.Result{}, nil
126 // Error reading the object - requeue the request.
127 reqLogger.V(1).Info("Error reading the CollectdPlugin 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 CollectdPlugin.
145 // At this stage the Status of the CollectdPlugin should NOT be ""
146 err = r.handleCollectdPlugin(reqLogger, instance, false)
147 return reconcile.Result{}, err
150 // handleCollectdPlugin regenerates the collectd conf on CR Create, Update, Delete events
151 func (r *ReconcileCollectdPlugin) handleCollectdPlugin(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin, isDelete bool) error {
153 rmap, err := collectdutils.FindResourceMapForCR(r.client, reqLogger, cr.Namespace)
155 reqLogger.Error(err, "Skip reconcile: Resources not found")
160 reqLogger.V(1).Info("Found ResourceMap")
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, cr.Spec.PluginName)
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
175 // Update the ConfigMap with new Spec and reload DaemonSets
176 reqLogger.Info("Updating the ConfigMap", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
177 log.V(1).Info("ConfigMap Data", "Map: ", cm.Data)
178 err = r.client.Update(context.TODO(), cm)
180 reqLogger.Error(err, "Update the ConfigMap failed", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
184 retryErr := retry.RetryOnConflict(retry.DefaultRetry, func() error {
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 := &extensionsv1beta1.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 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 *ReconcileCollectdPlugin) handleDelete(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) (bool, error) {
230 // Check if the CollectdPlugin 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 collectdPluginFinalizer. 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.finalizeCollectdPlugin(reqLogger, cr); err != nil {
244 return isMarkedToBeDeleted, err
247 // Remove collectdPluginFinalizer. 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 *ReconcileCollectdPlugin) updateStatus(cr *onapv1alpha1.CollectdPlugin) 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 *ReconcileCollectdPlugin) finalizeCollectdPlugin(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
280 // Cleanup by regenerating new collectd conf and rolling update of DaemonSet
281 if err := r.handleCollectdPlugin(reqLogger, cr, true); err != nil {
282 reqLogger.Error(err, "Finalize CollectdPlugin failed!!")
285 reqLogger.Info("Successfully finalized CollectdPlugin!!")
289 func (r *ReconcileCollectdPlugin) addFinalizer(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
290 reqLogger.Info("Adding Finalizer for the CollectdPlugin")
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 CollectdPlugin with finalizer")