controller_base.go

/*
Copyright 2019 The OpenEBS Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package cstorvolumeconfig

import (
	"fmt"
	"time"

	apis "github.com/openebs/api/pkg/apis/cstor/v1"
	clientset "github.com/openebs/api/pkg/client/clientset/versioned"
	openebsScheme "github.com/openebs/api/pkg/client/clientset/versioned/scheme"
	informers "github.com/openebs/api/pkg/client/informers/externalversions"
	listers "github.com/openebs/api/pkg/client/listers/cstor/v1"

	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/util/runtime"
	"k8s.io/apimachinery/pkg/util/wait"
	"k8s.io/client-go/kubernetes"
	"k8s.io/client-go/kubernetes/scheme"
	typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
	"k8s.io/client-go/tools/cache"
	"k8s.io/client-go/tools/record"
	"k8s.io/client-go/util/workqueue"
	"k8s.io/klog"
)

const controllerAgentName = "cstorvolumeclaim-controller"

// CVCController is the controller implementation for CVC resources
type CVCController struct {
	// kubeclientset is a standard kubernetes clientset
	kubeclientset kubernetes.Interface

	// clientset is a openebs custom resource package generated for custom API group.
	clientset clientset.Interface

	// ndmclientset is a ndm custom resource package generated for custom API group.
	//ndmclientset ndmclientset.Interface

	cvcLister listers.CStorVolumeConfigLister
	cvLister  listers.CStorVolumeLister

	cvrLister listers.CStorVolumeReplicaLister

	cvrSynced  cache.InformerSynced
	cspiLister listers.CStorPoolInstanceLister
	// cvcSynced is used for caches sync to get populated
	cvcSynced cache.InformerSynced

	// Store is a generic object storage interface. Reflector knows how to watch a server
	// and update a store. A generic store is provided, which allows Reflector to be used
	// as a local caching system, and an LRU store, which allows Reflector to work like a
	// queue of items yet to be processed.
	cvcStore cache.Store

	// workqueue is a rate limited work queue. This is used to queue work to be
	// processed instead of performing it as soon as a change happens. This
	// means we can ensure we only process a fixed amount of resources at a
	// time, and makes it easy to ensure we are never processing the same item
	// simultaneously in two different workers.
	workqueue workqueue.RateLimitingInterface

	// recorder is an event recorder for recording Event resources to the
	// Kubernetes API.
	recorder record.EventRecorder

	// used for unit testing
	enqueueCVCConfig func(cvc interface{})
}

// CVCControllerBuilder is the builder object for controller.
type CVCControllerBuilder struct {
	CVCController *CVCController
}

// NewCVCControllerBuilder returns an empty instance of controller builder.
func NewCVCControllerBuilder() *CVCControllerBuilder {
	return &CVCControllerBuilder{
		CVCController: &CVCController{},
	}
}

// withKubeClient fills kube client to controller object.
func (cb *CVCControllerBuilder) withKubeClient(ks kubernetes.Interface) *CVCControllerBuilder {
	cb.CVCController.kubeclientset = ks
	return cb
}

// withOpenEBSClient fills openebs client to controller object.
func (cb *CVCControllerBuilder) withOpenEBSClient(cs clientset.Interface) *CVCControllerBuilder {
	cb.CVCController.clientset = cs
	return cb
}

// withNDMClient fills ndm client to controller object.
//func (cb *CVCControllerBuilder) withNDMClient(ndmcs ndmclientset.Interface) *CVCControllerBuilder {
//	cb.CVCController.ndmclientset = ndmcs
//	return cb
//}

// withCVCLister fills cvc lister to controller object.
func (cb *CVCControllerBuilder) withCVCLister(sl informers.SharedInformerFactory) *CVCControllerBuilder {
	cvcInformer := sl.Cstor().V1().CStorVolumeConfigs()
	cb.CVCController.cvcLister = cvcInformer.Lister()
	return cb
}

// withCVLister fills cv lister to controller object.
func (cb *CVCControllerBuilder) withCVLister(sl informers.SharedInformerFactory) *CVCControllerBuilder {
	cvInformer := sl.Cstor().V1().CStorVolumes()
	cb.CVCController.cvLister = cvInformer.Lister()
	return cb
}

// withCVRLister fills cvr lister to controller object.
func (cb *CVCControllerBuilder) withCVRLister(sl informers.SharedInformerFactory) *CVCControllerBuilder {
	cvrInformer := sl.Cstor().V1().CStorVolumeReplicas()
	cb.CVCController.cvrLister = cvrInformer.Lister()
	return cb
}

// withCVRLister fills cvr lister to controller object.
func (cb *CVCControllerBuilder) withCVRInformerSync(sl informers.SharedInformerFactory) *CVCControllerBuilder {
	cvrInformer := sl.Cstor().V1().CStorVolumeReplicas()
	cb.CVCController.cvrSynced = cvrInformer.Informer().HasSynced
	return cb
}

// withCSPLister fills csp lister to controller object.
func (cb *CVCControllerBuilder) withCSPLister(sl informers.SharedInformerFactory) *CVCControllerBuilder {
	cspiInformer := sl.Cstor().V1().CStorPoolInstances()
	cb.CVCController.cspiLister = cspiInformer.Lister()
	return cb
}

// withCVCLister returns a Store implemented simply with a map and a lock.
func (cb *CVCControllerBuilder) withCVCStore() *CVCControllerBuilder {
	cb.CVCController.cvcStore = cache.NewStore(cache.DeletionHandlingMetaNamespaceKeyFunc)
	return cb
}

// withCVCSynced adds object sync information in cache to controller object.
func (cb *CVCControllerBuilder) withCVCSynced(sl informers.SharedInformerFactory) *CVCControllerBuilder {
	cvcInformer := sl.Cstor().V1().CStorVolumeConfigs()
	cb.CVCController.cvcSynced = cvcInformer.Informer().HasSynced
	return cb
}

// withWorkqueue adds workqueue to controller object.
func (cb *CVCControllerBuilder) withWorkqueueRateLimiting() *CVCControllerBuilder {
	cb.CVCController.workqueue = workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "CVC")
	return cb
}

// withRecorder adds recorder to controller object.
func (cb *CVCControllerBuilder) withRecorder(ks kubernetes.Interface) *CVCControllerBuilder {
	klog.V(4).Info("Creating event broadcaster")
	eventBroadcaster := record.NewBroadcaster()
	eventBroadcaster.StartLogging(klog.Infof)
	eventBroadcaster.StartRecordingToSink(&typedcorev1.EventSinkImpl{Interface: ks.CoreV1().Events("")})
	recorder := eventBroadcaster.NewRecorder(scheme.Scheme, corev1.EventSource{Component: controllerAgentName})
	cb.CVCController.recorder = recorder
	return cb
}

// withEventHandler adds event handlers controller object.
func (cb *CVCControllerBuilder) withEventHandler(cvcInformerFactory informers.SharedInformerFactory) *CVCControllerBuilder {
	cvcInformer := cvcInformerFactory.Cstor().V1().CStorVolumeConfigs()
	// Set up an event handler for when CVC resources change
	cvcInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
		AddFunc:    cb.CVCController.addCVC,
		UpdateFunc: cb.CVCController.updateCVC,
		DeleteFunc: cb.CVCController.deleteCVC,
	})
	return cb
}

// Build returns a controller instance.
func (cb *CVCControllerBuilder) Build() (*CVCController, error) {
	err := openebsScheme.AddToScheme(scheme.Scheme)
	if err != nil {
		return nil, err
	}
	return cb.CVCController, nil
}

// addCVC is the add event handler for CStorVolumeConfig
func (c *CVCController) addCVC(obj interface{}) {
	cvc, ok := obj.(*apis.CStorVolumeConfig)
	if !ok {
		runtime.HandleError(fmt.Errorf("Couldn't get cvc object %#v", obj))
		return
	}

	klog.V(4).Infof("Queuing CVC %s for add event", cvc.Name)
	c.enqueueCVC(cvc)
}

// updateCVC is the update event handler for CStorVolumeConfig
func (c *CVCController) updateCVC(oldObj, newObj interface{}) {

	newCVC, ok := newObj.(*apis.CStorVolumeConfig)
	if !ok {
		runtime.HandleError(fmt.Errorf("Couldn't get cvc object %#v", newCVC))
		return
	}

	c.enqueueCVC(newCVC)
}

// deleteCVC is the delete event handler for CStorVolumeConfig
func (c *CVCController) deleteCVC(obj interface{}) {
	cvc, ok := obj.(*apis.CStorVolumeConfig)
	if !ok {
		tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
		if !ok {
			runtime.HandleError(fmt.Errorf("Couldn't get object from tombstone %#v", obj))
			return
		}
		cvc, ok = tombstone.Obj.(*apis.CStorVolumeConfig)
		if !ok {
			runtime.HandleError(fmt.Errorf("Tombstone contained object that is not a cstorvolumeclaim %#v", obj))
			return
		}
	}
	klog.V(4).Infof("Deleting cstorvolumeclaim %s", cvc.Name)
	c.enqueueCVC(cvc)
}

// Run will set up the event handlers for types we are interested in, as well
// as syncing informer caches and starting workers. It will block until stopCh
// is closed, at which point it will shutdown the workqueue and wait for
// workers to finish processing their current work items.
func (c *CVCController) Run(threadiness int, stopCh <-chan struct{}) {
	defer runtime.HandleCrash()
	defer c.workqueue.ShutDown()

	// Start the informer factories to begin populating the informer caches
	klog.Info("Starting CstorVolumeConfig controller")

	// Wait for the k8s caches to be synced before starting workers
	klog.Info("Waiting for informer caches to sync")
	if ok := cache.WaitForCacheSync(stopCh, c.cvcSynced); !ok {
		klog.Errorf("failed to sync CStorVolumeConfig caches")
		return
	}
	klog.Info("Starting CStorVolumeConfig workers")
	// Launch worker to process CVC resources
	// Threadiness will decide the number of workers you want to launch to process work items from queue
	for i := 0; i < threadiness; i++ {
		go wait.Until(c.runWorker, time.Second, stopCh)
	}

	klog.Info("Started CStorVolumeConfig workers")
	<-stopCh
	klog.Info("Shutting down CStorVolumeConfig workers")
}

// runWorker is a long-running function that will continually call the
// processNextWorkItem function in order to read and process a message on the
// workqueue.
func (c *CVCController) runWorker() {
	for c.processNextWorkItem() {
	}
}

// processNextWorkItem will read a single work item off the workqueue and
// attempt to process it, by calling the syncHandler.
func (c *CVCController) processNextWorkItem() bool {
	obj, shutdown := c.workqueue.Get()

	if shutdown {
		return false
	}

	// We wrap this block in a func so we can defer c.workqueue.Done.
	err := func(obj interface{}) error {
		// We call Done here so the workqueue knows we have finished
		// processing this item. We also must remember to call Forget if we
		// do not want this work item being re-queued. For example, we do
		// not call Forget if a transient error occurs, instead the item is
		// put back on the workqueue and attempted again after a back-off
		// period.
		defer c.workqueue.Done(obj)
		var key string
		var ok bool
		// We expect strings to come off the workqueue. These are of the
		// form namespace/name. We do this as the delayed nature of the
		// workqueue means the items in the informer cache may actually be
		// more up to date that when the item was initially put onto the
		// workqueue.
		if key, ok = obj.(string); !ok {
			// As the item in the workqueue is actually invalid, we call
			// Forget here else we'd go into a loop of attempting to
			// process a work item that is invalid.
			c.workqueue.Forget(obj)
			runtime.HandleError(fmt.Errorf("expected string in workqueue but got %#v", obj))
			return nil
		}
		// Run the syncHandler, passing it the namespace/name string of the
		// CVC resource to be synced.
		if err := c.syncHandler(key); err != nil {
			// Put the item back on the workqueue to handle any transient errors.
			c.workqueue.AddRateLimited(key)
			return fmt.Errorf("error syncing '%s': %s, requeuing", key, err.Error())
		}
		// Finally, if no error occurs we Forget this item so it does not
		// get queued again until another change happens.
		c.workqueue.Forget(obj)
		klog.V(4).Infof("Successfully synced '%s'", key)
		return nil
	}(obj)

	if err != nil {
		runtime.HandleError(err)
		return true
	}

	return true
}