9 "github.com/go-logr/logr"
11 onapv1alpha1 "demo/vnfs/DAaaS/microservices/collectd-operator/pkg/apis/onap/v1alpha1"
12 collectdutils "demo/vnfs/DAaaS/microservices/collectd-operator/pkg/controller/utils"
14 appsv1 "k8s.io/api/apps/v1"
15 corev1 "k8s.io/api/core/v1"
16 extensionsv1beta1 "k8s.io/api/extensions/v1beta1"
17 "k8s.io/apimachinery/pkg/api/errors"
18 "k8s.io/apimachinery/pkg/runtime"
19 "k8s.io/client-go/util/retry"
20 "sigs.k8s.io/controller-runtime/pkg/client"
21 "sigs.k8s.io/controller-runtime/pkg/controller"
22 "sigs.k8s.io/controller-runtime/pkg/handler"
23 "sigs.k8s.io/controller-runtime/pkg/manager"
24 "sigs.k8s.io/controller-runtime/pkg/reconcile"
25 logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
26 "sigs.k8s.io/controller-runtime/pkg/source"
29 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{})
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}})
94 // blank assignment to verify that ReconcileCollectdPlugin implements reconcile.Reconciler
95 var _ reconcile.Reconciler = &ReconcileCollectdPlugin{}
97 // ReconcileCollectdPlugin reconciles a CollectdPlugin object
98 type ReconcileCollectdPlugin struct {
99 // This client, initialized using mgr.Client() above, is a split client
100 // that reads objects from the cache and writes to the apiserver
102 scheme *runtime.Scheme
106 // Reconcile reads that state of the cluster for a CollectdPlugin object and makes changes based on the state read
107 // and what is in the CollectdPlugin.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 *ReconcileCollectdPlugin) Reconcile(request reconcile.Request) (reconcile.Result, error) {
114 reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
115 reqLogger.Info("Reconciling CollectdPlugin")
117 // Fetch the CollectdPlugin instance
118 instance := &onapv1alpha1.CollectdPlugin{}
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("CollectdPlugin object Not found")
126 return reconcile.Result{}, nil
128 // Error reading the object - requeue the request.
129 reqLogger.V(1).Info("Error reading the CollectdPlugin 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 CollectdPlugin.
147 // At this stage the Status of the CollectdPlugin should NOT be ""
148 err = r.handleCollectdPlugin(reqLogger, instance, false)
149 return reconcile.Result{}, err
152 // handleCollectdPlugin regenerates the collectd conf on CR Create, Update, Delete events
153 func (r *ReconcileCollectdPlugin) handleCollectdPlugin(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin, isDelete bool) error {
155 rmap, err := collectdutils.FindResourceMapForCR(r.client, reqLogger, cr.Namespace)
157 reqLogger.Error(err, "Skip reconcile: Resources not found")
162 reqLogger.V(1).Info("Found ResourceMap")
163 reqLogger.V(1).Info(":::: ConfigMap Info ::::", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
165 collectdConf, err := collectdutils.RebuildCollectdConf(r.client, cr.Namespace, isDelete, cr.Spec.PluginName)
167 reqLogger.Error(err, "Skip reconcile: Rebuild conf failed")
171 cm.SetAnnotations(map[string]string{
172 "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
175 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 log.V(1).Info("ConfigMap Data", "Map: ", cm.Data)
180 err = r.client.Update(context.TODO(), cm)
182 reqLogger.Error(err, "Update the ConfigMap failed", "ConfigMap.Namespace", cm.Namespace, "ConfigMap.Name", cm.Name)
186 retryErr := retry.RetryOnConflict(retry.DefaultRetry, func() error {
187 // Retrieve the latest version of Daemonset before attempting update
188 // RetryOnConflict uses exponential backoff to avoid exhausting the apiserver
189 // Select DaemonSets with label
190 dsList := &extensionsv1beta1.DaemonSetList{}
191 opts := &client.ListOptions{}
192 labelSelector, err := collectdutils.GetWatchLabels()
194 reqLogger.Error(err, "Failed to get watch labels, continuing with default label")
196 opts.SetLabelSelector(labelSelector)
197 opts.InNamespace(cr.Namespace)
198 err = r.client.List(context.TODO(), opts, dsList)
200 panic(fmt.Errorf("Failed to get latest version of DaemonSet: %v", err))
203 if dsList.Items == nil || len(dsList.Items) == 0 {
204 return errors.NewNotFound(corev1.Resource("daemonset"), "DaemonSet")
206 ds := &dsList.Items[0]
207 //Restart Collectd Pods
208 reqLogger.Info("Reloading the Daemonset", "DaemonSet.Namespace", ds.Namespace, "DaemonSet.Name", ds.Name)
209 //Restart only if hash of conf has changed.
210 ds.Spec.Template.SetAnnotations(map[string]string{
211 "daaas-random": collectdutils.ComputeSHA256([]byte(collectdConf)),
213 updateErr := r.client.Update(context.TODO(), ds)
217 panic(fmt.Errorf("Update failed: %v", retryErr))
220 err = r.updateStatus(cr)
222 reqLogger.Error(err, "Unable to update status")
226 reqLogger.Info("Reconcile success!!")
230 // Handle Delete CR event for additional cleanup
231 func (r *ReconcileCollectdPlugin) handleDelete(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) (bool, error) {
232 // Check if the CollectdPlugin instance is marked to be deleted, which is
233 // indicated by the deletion timestamp being set.
234 isMarkedToBeDeleted := cr.GetDeletionTimestamp() != nil
235 if isMarkedToBeDeleted {
236 // Update status to Deleting state
237 cr.Status.Status = onapv1alpha1.Deleting
238 cr.Status.CollectdAgents = nil
239 _ = r.client.Status().Update(context.TODO(), cr)
241 if collectdutils.Contains(cr.GetFinalizers(), collectdutils.CollectdFinalizer) {
242 // Run finalization logic for collectdPluginFinalizer. If the
243 // finalization logic fails, don't remove the finalizer so
244 // that we can retry during the next reconciliation.
245 if err := r.finalizeCollectdPlugin(reqLogger, cr); err != nil {
246 return isMarkedToBeDeleted, err
249 // Remove collectdPluginFinalizer. Once all finalizers have been
250 // removed, the object will be deleted.
251 cr.SetFinalizers(collectdutils.Remove(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
252 err := r.client.Update(context.TODO(), cr)
254 return isMarkedToBeDeleted, err
258 return isMarkedToBeDeleted, nil
261 func (r *ReconcileCollectdPlugin) updateStatus(cr *onapv1alpha1.CollectdPlugin) error {
262 switch cr.Status.Status {
263 case onapv1alpha1.Initial:
264 cr.Status.Status = onapv1alpha1.Created
265 case onapv1alpha1.Created, onapv1alpha1.Enabled:
266 pods, err := collectdutils.GetPodList(r.client, cr.Namespace)
270 if !reflect.DeepEqual(pods, cr.Status.CollectdAgents) {
271 cr.Status.CollectdAgents = pods
272 cr.Status.Status = onapv1alpha1.Enabled
274 case onapv1alpha1.Deleting, onapv1alpha1.Deprecated:
277 err := r.client.Status().Update(context.TODO(), cr)
281 func (r *ReconcileCollectdPlugin) finalizeCollectdPlugin(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
282 // Cleanup by regenerating new collectd conf and rolling update of DaemonSet
283 if err := r.handleCollectdPlugin(reqLogger, cr, true); err != nil {
284 reqLogger.Error(err, "Finalize CollectdPlugin failed!!")
287 reqLogger.Info("Successfully finalized CollectdPlugin!!")
291 func (r *ReconcileCollectdPlugin) addFinalizer(reqLogger logr.Logger, cr *onapv1alpha1.CollectdPlugin) error {
292 reqLogger.Info("Adding Finalizer for the CollectdPlugin")
293 cr.SetFinalizers(append(cr.GetFinalizers(), collectdutils.CollectdFinalizer))
294 // Update status from Initial to Created
295 // Since addFinalizer will be executed only once,
296 // the status will be changed from Initial state to Created
297 updateErr := r.updateStatus(cr)
298 if updateErr != nil {
299 reqLogger.Error(updateErr, "Failed to update status from Initial state")
302 err := r.client.Update(context.TODO(), cr)
304 reqLogger.Error(err, "Failed to update CollectdPlugin with finalizer")