Merge pull request #12 from akartsky/namespace_scope

Namespace scope service controllers

Author: jaypipes

pkg/config/config.go

@@ -33,6 +33,7 @@ const (
 	flagAWSEndpointURL       = "aws-endpoint-url"
 	flagLogLevel             = "log-level"
 	flagResourceTags         = "resource-tags"
+	flagWatchNamespace       = "watch-namespace"
 )
 
 // Config contains configuration otpions for ACK service controllers
@@ -46,6 +47,7 @@ type Config struct {
 	EndpointURL              string
 	LogLevel                 string
 	ResourceTags             []string
+	WatchNamespace           string
 }
 
 // BindFlags defines CLI/runtime configuration options
@@ -99,6 +101,12 @@ func (cfg *Config) BindFlags() {
 		[]string{},
 		"Configures the ACK service controller to always set key/value pairs tags on resources that it manages.",
 	)
+	flag.StringVar(
+		&cfg.WatchNamespace , flagWatchNamespace,
+		"",
+		"Specific namespace the service controller will watch for object creation from CRD. "+ 
+			" By default it will listen to all namespaces",
+	)
 }
 
 // SetupLogger initializes the logger used in the service controller

pkg/runtime/adoption_reconciler.go

@@ -58,7 +58,7 @@ func (r *adoptionReconciler) BindControllerManager(mgr ctrlrt.Manager) error {
 		return err
 	}
 	r.kc = mgr.GetClient()
-	r.cache = ackrtcache.New(clientset, r.log)
+	r.cache = ackrtcache.New(clientset, r.log, r.cfg.WatchNamespace)
 	r.cache.Run()
 	return ctrlrt.NewControllerManagedBy(
 		mgr,

pkg/runtime/cache/cache.go

@@ -58,10 +58,10 @@ type Caches struct {
 
 // New creates a new Caches object from a kubernetes.Interface and
 // a logr.Logger
-func New(clientset kubernetes.Interface, log logr.Logger) Caches {
+func New(clientset kubernetes.Interface, log logr.Logger, watchNamespace  string) Caches {
 	return Caches{
 		Accounts:   NewAccountCache(clientset, log),
-		Namespaces: NewNamespaceCache(clientset, log),
+		Namespaces: NewNamespaceCache(clientset, log, watchNamespace),
 	}
 }
 

pkg/runtime/cache/namespace.go

@@ -55,6 +55,10 @@ type NamespaceCache struct {
 	sync.RWMutex
 
 	log logr.Logger
+	// Provide a namespace specifically to listen to. 
+	// Provide empty string to listen to all namespaces except kube-system and kube-public.
+	watchNamespace  string
+
 	// Namespace informer
 	informer k8scache.SharedInformer
 	// namespaceInfos maps namespaces names to their known namespaceInfo
@@ -63,7 +67,7 @@ type NamespaceCache struct {
 
 // NewNamespaceCache makes a new NamespaceCache from a
 // kubernetes.Interface and a logr.Logger
-func NewNamespaceCache(clientset kubernetes.Interface, log logr.Logger) *NamespaceCache {
+func NewNamespaceCache(clientset kubernetes.Interface, log logr.Logger, watchNamespace string) *NamespaceCache {
 	sharedInformer := informersv1.NewNamespaceInformer(
 		clientset,
 		informerResyncPeriod,
@@ -72,40 +76,44 @@ func NewNamespaceCache(clientset kubernetes.Interface, log logr.Logger) *Namespa
 	return &NamespaceCache{
 		informer:       sharedInformer,
 		log:            log.WithName("cache.namespace"),
+		watchNamespace: watchNamespace,
 		namespaceInfos: make(map[string]*namespaceInfo),
 	}
 }
 
-// isIgnoredNamespace returns true if an object is of type corev1.Namespace
-// and it metadata name is one of 'ack-system', 'kube-system' or 'kube-public'
-func isIgnoredNamespace(raw interface{}) bool {
+// Check if the provided namespace should be listened to or not 
+func isWatchNamespace(raw interface{}, watchNamespace string) bool {
 	object, ok := raw.(*corev1.Namespace)
-	return ok &&
-		(object.ObjectMeta.Name == "ack-system" ||
-			object.ObjectMeta.Name == "kube-system" ||
-			object.ObjectMeta.Name == "kube-public")
+	if !ok {
+		return false
+	} 
+
+	if watchNamespace != "" {
+		return watchNamespace == object.ObjectMeta.Name
+	}
+	return object.ObjectMeta.Name != "kube-system" && object.ObjectMeta.Name != "kube-public"
 }
 
 // Run adds event handler functions to the SharedInformer and
 // runs the informer to begin processing items.
 func (c *NamespaceCache) Run(stopCh <-chan struct{}) {
 	c.informer.AddEventHandler(k8scache.ResourceEventHandlerFuncs{
 		AddFunc: func(obj interface{}) {
-			if !isIgnoredNamespace(obj) {
+			if isWatchNamespace(obj, c.watchNamespace) {
 				ns := obj.(*corev1.Namespace)
 				c.setNamespaceInfoFromK8sObject(ns)
 				c.log.V(1).Info("created namespace", "name", ns.ObjectMeta.Name)
 			}
 		},
 		UpdateFunc: func(orig, desired interface{}) {
-			if !isIgnoredNamespace(desired) {
+			if isWatchNamespace(desired, c.watchNamespace) {
 				ns := desired.(*corev1.Namespace)
 				c.setNamespaceInfoFromK8sObject(ns)
 				c.log.V(1).Info("updated namespace", "name", ns.ObjectMeta.Name)
 			}
 		},
 		DeleteFunc: func(obj interface{}) {
-			if !isIgnoredNamespace(obj) {
+			if isWatchNamespace(obj, c.watchNamespace) {
 				ns := obj.(*corev1.Namespace)
 				c.deleteNamespaceInfo(ns.ObjectMeta.Name)
 				c.log.V(1).Info("deleted namespace", "name", ns.ObjectMeta.Name)

pkg/runtime/cache/namespace_test.go

@@ -49,7 +49,7 @@ func TestNamespaceCache(t *testing.T) {
 	fakeLogger := ctrlrtzap.New(ctrlrtzap.UseFlagOptions(&zapOptions))
 
 	// initlizing account cache
-	namespaceCache := ackrtcache.NewNamespaceCache(k8sClient, fakeLogger)
+	namespaceCache := ackrtcache.NewNamespaceCache(k8sClient, fakeLogger, "")
 	stopCh := make(chan struct{})
 
 	namespaceCache.Run(stopCh)

pkg/runtime/reconciler.go

@@ -79,7 +79,7 @@ func (r *resourceReconciler) BindControllerManager(mgr ctrlrt.Manager) error {
 		return err
 	}
 	r.kc = mgr.GetClient()
-	r.cache = ackrtcache.New(clientset, r.log)
+	r.cache = ackrtcache.New(clientset, r.log, r.cfg.WatchNamespace)
 	r.cache.Run()
 	rd := r.rmf.ResourceDescriptor()
 	return ctrlrt.NewControllerManagedBy(