rbac

Documentation

Overview

Package rbac contain libraries for generating RBAC manifests from RBAC markers in Go source files.

The markers take the form:

+kubebuilder:rbac:groups=<groups>,resources=<resources>,verbs=<verbs>,urls=<non resource urls>

Index

• Variables
• type Generator
  • func (g Generator) Generate(ctx *genall.GenerationContext) error
  • func (Generator) RegisterMarkers(into *markers.Registry) error
• type Rule
  • func (r Rule) ToRule() rbacv1.PolicyRule

Variables

var (
	// RuleDefinition is a marker for defining RBAC rules.
	// Call ToRule on the value to get a Kubernetes RBAC policy rule.
	RuleDefinition = markers.Must(markers.MakeDefinition("kubebuilder:rbac", markers.DescribesPackage, Rule{}))
)

Types

type Generator

type Generator struct {
	RoleName string
}

Generator is a genall.Generator that generated RBAC manifests..

func (Generator) Generate

func (g Generator) Generate(ctx *genall.GenerationContext) error

func (Generator) RegisterMarkers

func (Generator) RegisterMarkers(into *markers.Registry) error

type Rule

type Rule struct {
	Groups    []string `marker:",optional"`
	Resources []string `marker:",optional"`
	Verbs     []string
	URLs      []string `marker:"urls,optional"`
}

Rule is a marker value that describes a kubernetes RBAC rule.

func (Rule) ToRule

func (r Rule) ToRule() rbacv1.PolicyRule

ToRule converts this rule to its Kubernetes API form.