metrics: also create an ClusterRole for rbac aggregation

Author: chrischdi

pkg/metrics/generator.go

@@ -21,14 +21,19 @@ package metrics
 import (
 	"fmt"
 	"sort"
+	"strings"
+
+	"github.com/gobuffalo/flect"
+	rbacv1 "k8s.io/api/rbac/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	"sigs.k8s.io/controller-tools/pkg/crd"
 	"sigs.k8s.io/controller-tools/pkg/genall"
 	"sigs.k8s.io/controller-tools/pkg/loader"
 	ctrlmarkers "sigs.k8s.io/controller-tools/pkg/markers"
-
-	customresourcestate "sigs.k8s.io/controller-tools/pkg/metrics/internal/config"
+	"sigs.k8s.io/controller-tools/pkg/metrics/internal/config"
 	"sigs.k8s.io/controller-tools/pkg/metrics/markers"
+	"sigs.k8s.io/controller-tools/pkg/rbac"
 )
 
 // Generator generates kube-state-metrics custom resource configuration files.
@@ -89,12 +94,14 @@ func (g Generator) Generate(ctx *genall.GenerationContext) error {
 
 	// Initialize empty customresourcestate configuration file and fill it with the
 	// customresourcestate.Resource objects from the parser.
-	metrics := customresourcestate.Metrics{
-		Spec: customresourcestate.MetricsSpec{
-			Resources: []customresourcestate.Resource{},
+	metrics := config.Metrics{
+		Spec: config.MetricsSpec{
+			Resources: []config.Resource{},
 		},
 	}
 
+	rules := []*rbac.Rule{}
+
 	for _, resource := range parser.CustomResourceStates {
 		if resource == nil {
 			continue
@@ -106,6 +113,12 @@ func (g Generator) Generate(ctx *genall.GenerationContext) error {
 			})
 
 			metrics.Spec.Resources = append(metrics.Spec.Resources, *resource)
+
+			rules = append(rules, &rbac.Rule{
+				Groups:    []string{resource.GroupVersionKind.Group},
+				Resources: []string{strings.ToLower(flect.Pluralize(resource.GroupVersionKind.Kind))},
+				Verbs:     []string{"get", "list", "watch"},
+			})
 		}
 	}
 
@@ -122,6 +135,25 @@ func (g Generator) Generate(ctx *genall.GenerationContext) error {
 		return fmt.Errorf("WriteYAML to %s: %w", virtualFilePath, err)
 	}
 
+	clusterRole := rbacv1.ClusterRole{
+		TypeMeta: metav1.TypeMeta{
+			Kind:       "ClusterRole",
+			APIVersion: rbacv1.SchemeGroupVersion.String(),
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "manager-metrics-role",
+			Labels: map[string]string{
+				"kube-state-metrics/aggregate-to-manager": "true",
+			},
+		},
+		Rules: rbac.NormalizeRules(rules),
+	}
+
+	virtualFilePath = "rbac.yaml"
+	if err := ctx.WriteYAML(virtualFilePath, "", []interface{}{clusterRole}, genall.WithTransform(genall.TransformRemoveCreationTimestamp)); err != nil {
+		return fmt.Errorf("WriteYAML to %s: %w", virtualFilePath, err)
+	}
+
 	return nil
 }
 

pkg/metrics/parser.go

@@ -26,20 +26,20 @@ import (
 	"sigs.k8s.io/controller-tools/pkg/loader"
 	ctrlmarkers "sigs.k8s.io/controller-tools/pkg/markers"
 
-	customresourcestate "sigs.k8s.io/controller-tools/pkg/metrics/internal/config"
+	"sigs.k8s.io/controller-tools/pkg/metrics/internal/config"
 	"sigs.k8s.io/controller-tools/pkg/metrics/markers"
 )
 
 type parser struct {
 	*crd.Parser
 
-	CustomResourceStates map[crd.TypeIdent]*customresourcestate.Resource
+	CustomResourceStates map[crd.TypeIdent]*config.Resource
 }
 
 func newParser(p *crd.Parser) *parser {
 	return &parser{
 		Parser:               p,
-		CustomResourceStates: make(map[crd.TypeIdent]*customresourcestate.Resource),
+		CustomResourceStates: make(map[crd.TypeIdent]*config.Resource),
 	}
 }
 
@@ -75,8 +75,8 @@ func (p *parser) NeedResourceFor(pkg *loader.Package, groupKind schema.GroupKind
 	}
 
 	// Initialize the Resource object.
-	resource := customresourcestate.Resource{
-		GroupVersionKind: customresourcestate.GroupVersionKind{
+	resource := config.Resource{
+		GroupVersionKind: config.GroupVersionKind{
 			Group:   groupKind.Group,
 			Kind:    groupKind.Kind,
 			Version: p.GroupVersions[pkg].Version,
@@ -101,7 +101,7 @@ func (p *parser) NeedResourceFor(pkg *loader.Package, groupKind schema.GroupKind
 }
 
 type generatorRequester interface {
-	NeedMetricsGeneratorFor(typ crd.TypeIdent) ([]customresourcestate.Generator, error)
+	NeedMetricsGeneratorFor(typ crd.TypeIdent) ([]config.Generator, error)
 }
 
 // generatorContext stores and provides information across a hierarchy of metric generators generation.
@@ -120,8 +120,8 @@ func newGeneratorContext(pkg *loader.Package, req generatorRequester) *generator
 	}
 }
 
-func generatorsFromMarkers(m ctrlmarkers.MarkerValues, basePath ...string) ([]customresourcestate.Generator, error) {
-	generators := []customresourcestate.Generator{}
+func generatorsFromMarkers(m ctrlmarkers.MarkerValues, basePath ...string) ([]config.Generator, error) {
+	generators := []config.Generator{}
 
 	for _, markerVals := range m {
 		for _, val := range markerVals {
@@ -142,7 +142,7 @@ func generatorsFromMarkers(m ctrlmarkers.MarkerValues, basePath ...string) ([]cu
 
 // NeedMetricsGeneratorFor creates the customresourcestate.Generator object for a
 // Custom Resource.
-func (p *parser) NeedMetricsGeneratorFor(typ crd.TypeIdent) ([]customresourcestate.Generator, error) {
+func (p *parser) NeedMetricsGeneratorFor(typ crd.TypeIdent) ([]config.Generator, error) {
 	info, gotInfo := p.Types[typ]
 	if !gotInfo {
 		return nil, fmt.Errorf("type info for %v does not exist", typ)
@@ -194,7 +194,7 @@ func (p *parser) NeedMetricsGeneratorFor(typ crd.TypeIdent) ([]customresourcesta
 // generatorsFor creates generators for the given AST type.
 // Note: Partially inspired by controller-tools.
 // xref: https://github.com/kubernetes-sigs/controller-tools/blob/d89d6ae3df218a85f7cd9e477157cace704b37d1/pkg/crd/schema.go#L167-L193
-func generatorsFor(ctx *generatorContext, rawType ast.Expr) ([]customresourcestate.Generator, error) {
+func generatorsFor(ctx *generatorContext, rawType ast.Expr) ([]config.Generator, error) {
 	switch expr := rawType.(type) {
 	case *ast.Ident:
 		return localNamedToGenerators(ctx, expr)
@@ -222,7 +222,7 @@ func generatorsFor(ctx *generatorContext, rawType ast.Expr) ([]customresourcesta
 
 // localNamedToGenerators recurses back to NeedMetricsGeneratorFor for the type to
 // get generators defined at the objects in a custom resource.
-func localNamedToGenerators(ctx *generatorContext, ident *ast.Ident) ([]customresourcestate.Generator, error) {
+func localNamedToGenerators(ctx *generatorContext, ident *ast.Ident) ([]config.Generator, error) {
 	typeInfo := ctx.pkg.TypesInfo.TypeOf(ident)
 	if typeInfo == types.Typ[types.Invalid] {
 		// It is expected to hit this error for types from not loaded transitive package dependencies.
@@ -249,7 +249,7 @@ func localNamedToGenerators(ctx *generatorContext, ident *ast.Ident) ([]customre
 
 // requestGenerator asks for the generator for a type in the package with the
 // given import path.
-func (c *generatorContext) requestGenerator(pkgPath, typeName string) ([]customresourcestate.Generator, error) {
+func (c *generatorContext) requestGenerator(pkgPath, typeName string) ([]config.Generator, error) {
 	pkg := c.pkg
 	if pkgPath != "" {
 		pkg = c.pkg.Imports()[pkgPath]
@@ -261,13 +261,13 @@ func (c *generatorContext) requestGenerator(pkgPath, typeName string) ([]customr
 }
 
 // addPathPrefixOnGenerator prefixes the path set at the generators MetricMeta object.
-func addPathPrefixOnGenerator(generator customresourcestate.Generator, pathPrefix string) customresourcestate.Generator {
+func addPathPrefixOnGenerator(generator config.Generator, pathPrefix string) config.Generator {
 	switch generator.Each.Type {
-	case customresourcestate.MetricTypeGauge:
+	case config.MetricTypeGauge:
 		generator.Each.Gauge.MetricMeta.Path = append([]string{pathPrefix}, generator.Each.Gauge.MetricMeta.Path...)
-	case customresourcestate.MetricTypeStateSet:
+	case config.MetricTypeStateSet:
 		generator.Each.StateSet.MetricMeta.Path = append([]string{pathPrefix}, generator.Each.StateSet.MetricMeta.Path...)
-	case customresourcestate.MetricTypeInfo:
+	case config.MetricTypeInfo:
 		generator.Each.Info.MetricMeta.Path = append([]string{pathPrefix}, generator.Each.Info.MetricMeta.Path...)
 	}