Add support for declaratively starting Kubernetes informers from the …

…controller
kubernetes-sigs · Mar 15, 2018 · a23c01e · a23c01e
1 parent 12ec8cf
commit a23c01e
Show file tree

Hide file tree

Showing 9 changed files with 126 additions and 45 deletions.
diff --git a/cmd/internal/codegen/parse/apis.go b/cmd/internal/codegen/parse/apis.go
@@ -38,6 +38,7 @@ func (b *APIs) parseAPIs() {
 		Package: b.APIsPkg,
 		Groups:  map[string]*codegen.APIGroup{},
 		Rules:   b.Rules,
+		Informers: b.Informers,
 	}
 
 	for group, versionMap := range b.ByGroupVersionKind {

diff --git a/cmd/internal/codegen/parse/parser.go b/cmd/internal/codegen/parse/parser.go
@@ -26,6 +26,7 @@ import (
 	"k8s.io/gengo/args"
 	"k8s.io/gengo/generator"
 	"k8s.io/gengo/types"
+    "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 type APIs struct {
@@ -46,6 +47,7 @@ type APIs struct {
 	SubByGroupVersionKind map[string]map[string]map[string]*types.Type
 	Groups                map[string]types.Package
 	Rules                 []rbacv1.PolicyRule
+	Informers             map[v1.GroupVersionKind]bool
 }
 
 func NewAPIs(context *generator.Context, arguments *args.GeneratorArgs) *APIs {
@@ -59,6 +61,7 @@ func NewAPIs(context *generator.Context, arguments *args.GeneratorArgs) *APIs {
 	b.parseIndex()
 	b.parseControllers()
 	b.parseRBAC()
+	b.parseInformers()
 	b.parseAPIs()
 	b.parseJSONSchemaProps()
 	return b

diff --git a/cmd/internal/codegen/parse/rbac.go b/cmd/internal/codegen/parse/rbac.go
@@ -23,6 +23,7 @@ import (
 
 	rbacv1 "k8s.io/api/rbac/v1"
 	"k8s.io/gengo/types"
+    "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 func (b *APIs) parseRBAC() {
@@ -36,39 +37,83 @@ func (b *APIs) parseRBAC() {
 }
 
 func (b *APIs) getRBACTag(c *types.Type) []string {
-	comments := Comments(c.CommentLines)
-	resource := comments.getTags("rbac", ":")
-	if len(resource) == 0 {
-		panic(fmt.Errorf("Must specify +rbac comment for type %v", c.Name))
-	}
-	return resource
+    comments := Comments(c.CommentLines)
+    resource := comments.getTags("rbac", ":")
+    if len(resource) == 0 {
+        panic(fmt.Errorf("Must specify +rbac comment for type %v", c.Name))
+    }
+    return resource
 }
 
 func parseRBACTag(tag string) rbacv1.PolicyRule {
-	result := rbacv1.PolicyRule{}
-	for _, elem := range strings.Split(tag, ",") {
-		kv := strings.Split(elem, "=")
-		if len(kv) != 2 {
-			log.Fatalf("// +rbac: tags must be key value pairs.  Expected "+
-				"keys [groups=<group1;group2>,resources=<resource1;resource2>,verbs=<verb1;verb2>] "+
-				"Got string: [%s]", tag)
-		}
-		value := kv[1]
-		values := []string{}
-		if strings.HasPrefix(value, "\"") && strings.HasSuffix(value, "\"") {
-			value = value[1 : len(value)-1]
-		}
-		values = strings.Split(value, ";")
-		switch kv[0] {
-		case "groups":
-			result.APIGroups = values
-		case "resources":
-			result.Resources = values
-		case "verbs":
-			result.Verbs = values
-		case "urls":
-			result.NonResourceURLs = values
-		}
-	}
-	return result
+    result := rbacv1.PolicyRule{}
+    for _, elem := range strings.Split(tag, ",") {
+        kv := strings.Split(elem, "=")
+        if len(kv) != 2 {
+            log.Fatalf("// +rbac: tags must be key value pairs.  Expected "+
+                "keys [groups=<group1;group2>,resources=<resource1;resource2>,verbs=<verb1;verb2>] "+
+                "Got string: [%s]", tag)
+        }
+        value := kv[1]
+        values := []string{}
+        if strings.HasPrefix(value, "\"") && strings.HasSuffix(value, "\"") {
+            value = value[1 : len(value)-1]
+        }
+        values = strings.Split(value, ";")
+        switch kv[0] {
+        case "groups":
+            result.APIGroups = values
+        case "resources":
+            result.Resources = values
+        case "verbs":
+            result.Verbs = values
+        case "urls":
+            result.NonResourceURLs = values
+        }
+    }
+    return result
 }
+
+func (b *APIs) parseInformers() {
+    for _, c := range b.context.Order {
+        if IsInformer(c) {
+            for _, tag := range b.getInformerTag(c) {
+                if b.Informers == nil {
+                    b.Informers = map[v1.GroupVersionKind]bool{}
+                }
+                b.Informers[parseInformerTag(tag)] = true
+            }
+        }
+    }
+}
+
+func (b *APIs) getInformerTag(c *types.Type) []string {
+    comments := Comments(c.CommentLines)
+    resource := comments.getTags("informers", ":")
+    if len(resource) == 0 {
+        panic(fmt.Errorf("Must specify +informers comment for type %v", c.Name))
+    }
+    return resource
+}
+
+func parseInformerTag(tag string) v1.GroupVersionKind {
+    result := v1.GroupVersionKind{}
+    for _, elem := range strings.Split(tag, ",") {
+        kv := strings.Split(elem, "=")
+        if len(kv) != 2 {
+            log.Fatalf("// +informers: tags must be key value pairs.  Expected "+
+                "keys [group=core,version=v1,kind=Pod] "+
+                "Got string: [%s]", tag)
+        }
+        value := kv[1]
+        switch kv[0] {
+        case "group":
+            result.Group = value
+        case "version":
+            result.Version = value
+        case "kind":
+            result.Kind = value
+        }
+    }
+    return result
+}
diff --git a/cmd/internal/codegen/parse/util.go b/cmd/internal/codegen/parse/util.go
@@ -75,6 +75,16 @@ func IsRBAC(t *types.Type) bool {
 	return false
 }
 
+func IsInformer(t *types.Type) bool {
+    for _, c := range t.CommentLines {
+        if strings.Contains(c, "+informers") {
+            return true
+        }
+    }
+    return false
+}
+
+
 // IsAPISubresource returns true if t has a +subresource-request comment tag
 func IsAPISubresource(t *types.Type) bool {
 	for _, c := range t.CommentLines {

diff --git a/cmd/internal/codegen/types.go b/cmd/internal/codegen/types.go
@@ -40,6 +40,8 @@ type APIs struct {
 	Groups map[string]*APIGroup
 
 	Rules []rbacv1.PolicyRule
+
+	Informers map[v1.GroupVersionKind]bool
 }
 
 func (apis *APIs) GetRules() []rbacv1.PolicyRule {

diff --git a/cmd/kubebuilder-gen/internal/controllergen/inject.go b/cmd/kubebuilder-gen/internal/controllergen/inject.go
@@ -50,7 +50,7 @@ func (d *injectGenerator) Imports(c *generator.Context) []string {
 		repo + "/pkg/controller/sharedinformers",
 		repo + "/pkg/client/informers_generated/externalversions",
 		repo + "/pkg/inject/args",
-		" rbacv1 \"k8s.io/api/rbac/v1\"",
+		"rbacv1 \"k8s.io/api/rbac/v1\"",
 		"k8s.io/apimachinery/pkg/runtime/schema",
 	}
 
@@ -63,6 +63,15 @@ func (d *injectGenerator) Imports(c *generator.Context) []string {
 		im = append(im, k)
 	}
 
+	libs := map[string]string{}
+	for i := range d.APIS.Informers {
+	    libs[i.Group + i.Version] = "k8s.io/api/" +i.Group + "/" + i.Version
+    }
+
+    for i, d := range libs {
+        im = append(im, fmt.Sprintf("%s \"%s\"", i, d))
+    }
+
 	// Import package for each API groupversion
 	gvk := map[string]string{}
 	for _, g := range d.APIS.Groups {
@@ -92,10 +101,15 @@ func (d *injectGenerator) Finalize(context *generator.Context, w io.Writer) erro
 var injectAPITemplate = `
 func init() {
     // Inject Informers
-    SetInformers = func(arguments args.InjectArgs, factory externalversions.SharedInformerFactory) {
+    SetInformers = func(arguments args.InjectArgs) {
         {{ range $group := .APIS.Groups }}{{ range $version := $group.Versions }}{{ range $res := $version.Resources -}}
-        arguments.ControllerManager.AddInformerProvider(&{{.Group}}{{.Version}}.{{.Kind}}{}, factory.{{title .Group}}().{{title .Version}}().{{plural .Kind}}())
-        {{ end }}{{ end }}{{ end -}}
+        arguments.ControllerManager.AddInformerProvider(&{{.Group}}{{.Version}}.{{.Kind}}{}, arguments.Informers.{{title .Group}}().{{title .Version}}().{{plural .Kind}}())
+        {{ end }}{{ end }}{{ end }}
+
+        // Add Kubernetes informers
+        {{ range $informer, $found := .APIS.Informers -}}
+        arguments.ControllerManager.AddInformerProvider(&{{$informer.Group}}{{$informer.Version}}.{{$informer.Kind}}{}, arguments.KubernetesInformers.{{title $informer.Group}}().{{title $informer.Version}}().{{plural $informer.Kind}}())
+        {{ end }}
     }
 
 

diff --git a/cmd/kubebuilder/initproject/inject.go b/cmd/kubebuilder/initproject/inject.go
@@ -39,17 +39,13 @@ var injectControllerTemplate = `{{.BoilerPlate}}
 package inject
 
 import (
-    "time"
-
     "github.com/kubernetes-sigs/kubebuilder/pkg/controller"
     "github.com/kubernetes-sigs/kubebuilder/pkg/inject/run"
     apiextensionsv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
     rbacv1 "k8s.io/api/rbac/v1"
     "k8s.io/apimachinery/pkg/runtime/schema"
 
     "{{.Repo}}/pkg/inject/args"
-    "{{.Repo}}/pkg/client/informers_generated/externalversions"
-
 )
 
 var (
@@ -68,7 +64,7 @@ var (
 
     // SetInformers adds the informers for the apis defined in this project.
     // Should be set by code generation in this package.
-    SetInformers func(args.InjectArgs, externalversions.SharedInformerFactory)
+    SetInformers func(args.InjectArgs)
 
     // Inject may be set by generated code 
     Inject func(args.InjectArgs) error
@@ -85,8 +81,7 @@ func RunAll(options run.RunArguments, arguments args.InjectArgs) error {
         }
     }
     if SetInformers != nil {
-        factory := externalversions.NewSharedInformerFactory(arguments.Clientset, time.Minute * 5)
-        SetInformers(arguments, factory)
+        SetInformers(arguments)
     }
     for _, fn := range Controllers {
         if c, err := fn(arguments); err != nil {
@@ -129,25 +124,31 @@ var argsControllerTemplate = `{{.BoilerPlate}}
 package args
 
 import (
+    "time"
+
 	"github.com/kubernetes-sigs/kubebuilder/pkg/inject/args"
     "k8s.io/client-go/rest"
 
     "{{.Repo}}/pkg/client/clientset_generated/clientset"
+    "{{.Repo}}/pkg/client/informers_generated/externalversions"
 )
 
 // InjectArgs are the arguments need to initialize controllers
 type InjectArgs struct {
     args.InjectArgs
 
     Clientset *clientset.Clientset
+    Informers externalversions.SharedInformerFactory
 }
 
 
 // CreateInjectArgs returns new controller args
 func CreateInjectArgs(config *rest.Config) InjectArgs {
+    cs := clientset.NewForConfigOrDie(config)
     return InjectArgs{
         InjectArgs: args.CreateInjectArgs(config),
-        Clientset: clientset.NewForConfigOrDie(config),
+        Clientset: cs,
+        Informers: externalversions.NewSharedInformerFactory(cs, 2 * time.Minute),
     }
 }
 `
diff --git a/pkg/gen/controller/doc.go b/pkg/gen/controller/doc.go
@@ -24,3 +24,6 @@ const Controller = "// +controller:group=,version=,kind=,resource="
 
 // RBAC annotates a controller struct as needing an RBAC rule to run
 const RBAC = "// +rbac:groups=<group1;group2>,resources=<resource1;resource2>,verbs=<verb1;verb2>"
+
+// Informers indicates that an informer must be started for this controller
+const Informers = "// +informers:group=core,version=v1,kind=Pod"
diff --git a/pkg/gen/controller/example_test.go b/pkg/gen/controller/example_test.go
@@ -19,6 +19,8 @@ package controller_test
 func Example() {}
 
 // +controller:group=foo,version=v1beta1,kind=Bar,resource=bars
-// +rbac:groups=extensions;apps,resources=deployments,verbs=get;list;watch;create;update;patch;delete
+// +rbac:groups=apps,resources=deployments,verbs=get;list;watch;create;update;patch;delete
+// +informers:group=apps,version=v1,kind=Deployment
 // +rbac:groups="",resources=pods,verbs=get;watch;list
+// +informers:group=core,version=v1,kind=Pod
 type FooController struct{}