Schema: Add schema for role+access policies (#68047)

2023-05-24 10:31:57 -07:00
parent 3af95bebe1
commit e7da2a179e
34 changed files with 1863 additions and 4 deletions
@@ -0,0 +1,40 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     kinds/gen.go
+// Using jennies:
+//     GoTypesJenny
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+package rolebinding
+
+import (
+	"github.com/grafana/grafana/pkg/kinds"
+)
+
+// Resource is the kubernetes style representation of RoleBinding. (TODO be better)
+type K8sResource = kinds.GrafanaResource[Spec, Status]
+
+// NewResource creates a new instance of the resource with a given name (UID)
+func NewK8sResource(name string, s *Spec) K8sResource {
+	return K8sResource{
+		Kind:       "RoleBinding",
+		APIVersion: "v0.0-alpha",
+		Metadata: kinds.GrafanaResourceMetadata{
+			Name:        name,
+			Annotations: make(map[string]string),
+			Labels:      make(map[string]string),
+		},
+		Spec: s,
+	}
+}
+
+
+// Resource is the wire representation of RoleBinding.
+// It currently will soon be merged into the k8s flavor (TODO be better)
+type Resource struct {
+	Metadata Metadata `json:"metadata"`
+	Spec Spec `json:"spec"`
+	Status Status `json:"status"`
+}
@@ -0,0 +1,79 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     kinds/gen.go
+// Using jennies:
+//     CoreKindJenny
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+package rolebinding
+
+import (
+	"github.com/grafana/kindsys"
+	"github.com/grafana/thema"
+	"github.com/grafana/thema/vmux"
+
+	"github.com/grafana/grafana/pkg/cuectx"
+)
+
+// rootrel is the relative path from the grafana repository root to the
+// directory containing the .cue files in which this kind is defined. Necessary
+// for runtime errors related to the definition and/or lineage to provide
+// a real path to the correct .cue file.
+const rootrel string = "kinds/rolebinding"
+
+// TODO standard generated docs
+type Kind struct {
+	kindsys.Core
+	lin    thema.ConvergentLineage[*Resource]
+	jcodec vmux.Codec
+	valmux vmux.ValueMux[*Resource]
+}
+
+// type guard - ensure generated Kind type satisfies the kindsys.Core interface
+var _ kindsys.Core = &Kind{}
+
+// TODO standard generated docs
+func NewKind(rt *thema.Runtime, opts ...thema.BindOption) (*Kind, error) {
+	def, err := cuectx.LoadCoreKindDef(rootrel, rt.Context(), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	k := &Kind{}
+	k.Core, err = kindsys.BindCore(rt, def, opts...)
+	if err != nil {
+		return nil, err
+	}
+	// Get the thema.Schema that the meta says is in the current version (which
+	// codegen ensures is always the latest)
+	cursch := thema.SchemaP(k.Core.Lineage(), def.Properties.CurrentVersion)
+	tsch, err := thema.BindType(cursch, &Resource{})
+	if err != nil {
+		// Should be unreachable, modulo bugs in the Thema->Go code generator
+		return nil, err
+	}
+
+	k.jcodec = vmux.NewJSONCodec("rolebinding.json")
+	k.lin = tsch.ConvergentLineage()
+	k.valmux = vmux.NewValueMux(k.lin.TypedSchema(), k.jcodec)
+	return k, nil
+}
+
+// ConvergentLineage returns the same [thema.Lineage] as Lineage, but bound (see [thema.BindType])
+// to the the RoleBinding [Resource] type generated from the current schema, v0.0.
+func (k *Kind) ConvergentLineage() thema.ConvergentLineage[*Resource] {
+	return k.lin
+}
+
+// JSONValueMux is a version multiplexer that maps a []byte containing JSON data
+// at any schematized dashboard version to an instance of RoleBinding [Resource].
+//
+// Validation and translation errors emitted from this func will identify the
+// input bytes as "dashboard.json".
+//
+// This is a thin wrapper around Thema's [vmux.ValueMux].
+func (k *Kind) JSONValueMux(b []byte) (*Resource, thema.TranslationLacunas, error) {
+	return k.valmux(b)
+}
@@ -0,0 +1,42 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     kinds/gen.go
+// Using jennies:
+//     GoResourceTypes
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+package rolebinding
+
+import (
+	"time"
+)
+
+// Metadata defines model for Metadata.
+type Metadata struct {
+	CreatedBy         string     `json:"createdBy"`
+	CreationTimestamp time.Time  `json:"creationTimestamp"`
+	DeletionTimestamp *time.Time `json:"deletionTimestamp,omitempty"`
+
+	// extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
+	ExtraFields     map[string]interface{} `json:"extraFields"`
+	Finalizers      []string               `json:"finalizers"`
+	Labels          map[string]string      `json:"labels"`
+	ResourceVersion string                 `json:"resourceVersion"`
+	Uid             string                 `json:"uid"`
+	UpdateTimestamp time.Time              `json:"updateTimestamp"`
+	UpdatedBy       string                 `json:"updatedBy"`
+}
+
+// _kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
+// It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
+// As it is also intended to be generic enough to function with any API Server.
+type KubeObjectMetadata struct {
+	CreationTimestamp time.Time         `json:"creationTimestamp"`
+	DeletionTimestamp *time.Time        `json:"deletionTimestamp,omitempty"`
+	Finalizers        []string          `json:"finalizers"`
+	Labels            map[string]string `json:"labels"`
+	ResourceVersion   string            `json:"resourceVersion"`
+	Uid               string            `json:"uid"`
+}
@@ -0,0 +1,72 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     kinds/gen.go
+// Using jennies:
+//     GoResourceTypes
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+package rolebinding
+
+// Defines values for BuiltinRoleRefKind.
+const (
+	BuiltinRoleRefKindBuiltinRole BuiltinRoleRefKind = "BuiltinRole"
+)
+
+// Defines values for BuiltinRoleRefName.
+const (
+	BuiltinRoleRefNameAdmin  BuiltinRoleRefName = "admin"
+	BuiltinRoleRefNameEditor BuiltinRoleRefName = "editor"
+	BuiltinRoleRefNameViewer BuiltinRoleRefName = "viewer"
+)
+
+// Defines values for CustomRoleRefKind.
+const (
+	CustomRoleRefKindRole CustomRoleRefKind = "Role"
+)
+
+// Defines values for SubjectKind.
+const (
+	SubjectKindTeam SubjectKind = "Team"
+	SubjectKindUser SubjectKind = "User"
+)
+
+// BuiltinRoleRef defines model for BuiltinRoleRef.
+type BuiltinRoleRef struct {
+	Kind BuiltinRoleRefKind `json:"kind"`
+	Name BuiltinRoleRefName `json:"name"`
+}
+
+// BuiltinRoleRefKind defines model for BuiltinRoleRef.Kind.
+type BuiltinRoleRefKind string
+
+// BuiltinRoleRefName defines model for BuiltinRoleRef.Name.
+type BuiltinRoleRefName string
+
+// CustomRoleRef defines model for CustomRoleRef.
+type CustomRoleRef struct {
+	Kind CustomRoleRefKind `json:"kind"`
+	Name string            `json:"name"`
+}
+
+// CustomRoleRefKind defines model for CustomRoleRef.Kind.
+type CustomRoleRefKind string
+
+// Subject defines model for Subject.
+type Subject struct {
+	Kind SubjectKind `json:"kind"`
+
+	// The team/user identifier name
+	Name string `json:"name"`
+}
+
+// SubjectKind defines model for Subject.Kind.
+type SubjectKind string
+
+// Spec defines model for Spec.
+type Spec struct {
+	// The role we are discussing
+	Role    interface{} `json:"role"`
+	Subject Subject     `json:"subject"`
+}
@@ -0,0 +1,74 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     kinds/gen.go
+// Using jennies:
+//     GoResourceTypes
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+package rolebinding
+
+// Defines values for OperatorStateState.
+const (
+	OperatorStateStateFailed     OperatorStateState = "failed"
+	OperatorStateStateInProgress OperatorStateState = "in_progress"
+	OperatorStateStateSuccess    OperatorStateState = "success"
+)
+
+// Defines values for StatusOperatorStateState.
+const (
+	StatusOperatorStateStateFailed     StatusOperatorStateState = "failed"
+	StatusOperatorStateStateInProgress StatusOperatorStateState = "in_progress"
+	StatusOperatorStateStateSuccess    StatusOperatorStateState = "success"
+)
+
+// OperatorState defines model for OperatorState.
+type OperatorState struct {
+	// descriptiveState is an optional more descriptive state field which has no requirements on format
+	DescriptiveState *string `json:"descriptiveState,omitempty"`
+
+	// details contains any extra information that is operator-specific
+	Details map[string]interface{} `json:"details,omitempty"`
+
+	// lastEvaluation is the ResourceVersion last evaluated
+	LastEvaluation string `json:"lastEvaluation"`
+
+	// state describes the state of the lastEvaluation.
+	// It is limited to three possible states for machine evaluation.
+	State OperatorStateState `json:"state"`
+}
+
+// OperatorStateState state describes the state of the lastEvaluation.
+// It is limited to three possible states for machine evaluation.
+type OperatorStateState string
+
+// Status defines model for Status.
+type Status struct {
+	// additionalFields is reserved for future use
+	AdditionalFields map[string]interface{} `json:"additionalFields,omitempty"`
+
+	// operatorStates is a map of operator ID to operator state evaluations.
+	// Any operator which consumes this kind SHOULD add its state evaluation information to this field.
+	OperatorStates map[string]StatusOperatorState `json:"operatorStates,omitempty"`
+}
+
+// StatusOperatorState defines model for status.#OperatorState.
+type StatusOperatorState struct {
+	// descriptiveState is an optional more descriptive state field which has no requirements on format
+	DescriptiveState *string `json:"descriptiveState,omitempty"`
+
+	// details contains any extra information that is operator-specific
+	Details map[string]interface{} `json:"details,omitempty"`
+
+	// lastEvaluation is the ResourceVersion last evaluated
+	LastEvaluation string `json:"lastEvaluation"`
+
+	// state describes the state of the lastEvaluation.
+	// It is limited to three possible states for machine evaluation.
+	State StatusOperatorStateState `json:"state"`
+}
+
+// StatusOperatorStateState state describes the state of the lastEvaluation.
+// It is limited to three possible states for machine evaluation.
+type StatusOperatorStateState string