K8s: Add dashboard service (requires dev mode) (#78565)

pkg/apis/dashboard/v0alpha1/doc.go

@@ -0,0 +1,5 @@
+// +k8s:deepcopy-gen=package
+// +k8s:openapi-gen=true
+// +groupName=dashboard.grafana.app
+
+package v0alpha1 // import "github.com/grafana/grafana/pkg/apis/dashboard/v0alpha1"

pkg/apis/dashboard/v0alpha1/types.go

@@ -0,0 +1,124 @@
+package v0alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	runtime "k8s.io/apimachinery/pkg/runtime"
+
+	"github.com/grafana/grafana/pkg/apis"
+)
+
+const (
+	GROUP      = "dashboard.grafana.app"
+	VERSION    = "v0alpha1"
+	APIVERSION = GROUP + "/" + VERSION
+)
+
+var DashboardResourceInfo = apis.NewResourceInfo(GROUP, VERSION,
+	"dashboards", "dashboard", "Dashboard",
+	func() runtime.Object { return &Dashboard{} },
+	func() runtime.Object { return &DashboardList{} },
+)
+
+var DashboardSummaryResourceInfo = apis.NewResourceInfo(GROUP, VERSION,
+	"summary", "summary", "DashboardSummary",
+	func() runtime.Object { return &DashboardSummary{} },
+	func() runtime.Object { return &DashboardSummaryList{} },
+)
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type Dashboard struct {
+	metav1.TypeMeta `json:",inline"`
+	// Standard object's metadata
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// The dashboard body (unstructured for now)
+	Spec Unstructured `json:"spec"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type DashboardList struct {
+	metav1.TypeMeta `json:",inline"`
+	// +optional
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	Items []Dashboard `json:"items,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type DashboardSummary struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// The dashboard body
+	Spec DashboardSummarySpec `json:"spec,omitempty"`
+}
+
+type DashboardSummarySpec struct {
+	Title string   `json:"title"`
+	Tags  []string `json:"tags,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type DashboardSummaryList struct {
+	metav1.TypeMeta `json:",inline"`
+	// +optional
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	Items []DashboardSummary `json:"items,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type DashboardVersionsInfo struct {
+	metav1.TypeMeta `json:",inline"`
+	// +optional
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	Items []DashboardVersionInfo `json:"items,omitempty"`
+}
+
+type DashboardVersionInfo struct {
+	Version       int    `json:"version"`
+	ParentVersion int    `json:"parentVersion,omitempty"`
+	Created       int64  `json:"created"`
+	Message       string `json:"message,omitempty"`
+	CreatedBy     string `json:"createdBy,omitempty"`
+}
+
+// +k8s:conversion-gen:explicit-from=net/url.Values
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type VersionsQueryOptions struct {
+	metav1.TypeMeta `json:",inline"`
+
+	// Path is the URL path
+	// +optional
+	Path string `json:"path,omitempty"`
+
+	// +optional
+	Version int64 `json:"version,omitempty"`
+}
+
+// Information about how the requesting user can use a given dashboard
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type DashboardAccessInfo struct {
+	metav1.TypeMeta `json:",inline"`
+
+	CanSave                bool                  `json:"canSave"`
+	CanEdit                bool                  `json:"canEdit"`
+	CanAdmin               bool                  `json:"canAdmin"`
+	CanStar                bool                  `json:"canStar"`
+	CanDelete              bool                  `json:"canDelete"`
+	AnnotationsPermissions *AnnotationPermission `json:"annotationsPermissions"`
+}
+
+type AnnotationPermission struct {
+	Dashboard    AnnotationActions `json:"dashboard"`
+	Organization AnnotationActions `json:"organization"`
+}
+
+type AnnotationActions struct {
+	CanAdd    bool `json:"canAdd"`
+	CanEdit   bool `json:"canEdit"`
+	CanDelete bool `json:"canDelete"`
+}

pkg/apis/dashboard/v0alpha1/unstructured.go

@@ -0,0 +1,100 @@
+package v0alpha1
+
+import (
+	"encoding/json"
+
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	runtime "k8s.io/apimachinery/pkg/runtime"
+)
+
+// Unstructured allows objects that do not have Golang structs registered to be manipulated
+// generically.
+type Unstructured struct {
+	// Object is a JSON compatible map with string, float, int, bool, []interface{}, or
+	// map[string]interface{}
+	// children.
+	Object map[string]interface{}
+}
+
+func (u *Unstructured) UnstructuredContent() map[string]interface{} {
+	if u.Object == nil {
+		return make(map[string]interface{})
+	}
+	return u.Object
+}
+
+func (u *Unstructured) SetUnstructuredContent(content map[string]interface{}) {
+	u.Object = content
+}
+
+// MarshalJSON ensures that the unstructured object produces proper
+// JSON when passed to Go's standard JSON library.
+func (u *Unstructured) MarshalJSON() ([]byte, error) {
+	return json.Marshal(u.Object)
+}
+
+// UnmarshalJSON ensures that the unstructured object properly decodes
+// JSON when passed to Go's standard JSON library.
+func (u *Unstructured) UnmarshalJSON(b []byte) error {
+	return json.Unmarshal(b, &u.Object)
+}
+
+func (u *Unstructured) DeepCopy() *Unstructured {
+	if u == nil {
+		return nil
+	}
+	out := new(Unstructured)
+	*out = *u
+	out.Object = runtime.DeepCopyJSON(u.Object)
+	return out
+}
+
+func (u *Unstructured) DeepCopyInto(out *Unstructured) {
+	clone := u.DeepCopy()
+	*out = *clone
+}
+
+func (u *Unstructured) Set(field string, value interface{}) {
+	if u.Object == nil {
+		u.Object = make(map[string]interface{})
+	}
+	_ = unstructured.SetNestedField(u.Object, value, field)
+}
+
+func (u *Unstructured) Remove(fields ...string) {
+	if u.Object == nil {
+		u.Object = make(map[string]interface{})
+	}
+	unstructured.RemoveNestedField(u.Object, fields...)
+}
+
+func (u *Unstructured) SetNestedField(value interface{}, fields ...string) {
+	if u.Object == nil {
+		u.Object = make(map[string]interface{})
+	}
+	_ = unstructured.SetNestedField(u.Object, value, fields...)
+}
+
+func (u *Unstructured) GetNestedString(fields ...string) string {
+	val, found, err := unstructured.NestedString(u.Object, fields...)
+	if !found || err != nil {
+		return ""
+	}
+	return val
+}
+
+func (u *Unstructured) GetNestedStringSlice(fields ...string) []string {
+	val, found, err := unstructured.NestedStringSlice(u.Object, fields...)
+	if !found || err != nil {
+		return nil
+	}
+	return val
+}
+
+func (u *Unstructured) GetNestedInt64(fields ...string) int64 {
+	val, found, err := unstructured.NestedInt64(u.Object, fields...)
+	if !found || err != nil {
+		return 0
+	}
+	return val
+}

pkg/apis/dashboard/v0alpha1/zz_generated.deepcopy.go

@@ -0,0 +1,289 @@
+//go:build !ignore_autogenerated
+// +build !ignore_autogenerated
+
+// SPDX-License-Identifier: AGPL-3.0-only
+
+// Code generated by deepcopy-gen. DO NOT EDIT.
+
+package v0alpha1
+
+import (
+	runtime "k8s.io/apimachinery/pkg/runtime"
+)
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *AnnotationActions) DeepCopyInto(out *AnnotationActions) {
+	*out = *in
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnnotationActions.
+func (in *AnnotationActions) DeepCopy() *AnnotationActions {
+	if in == nil {
+		return nil
+	}
+	out := new(AnnotationActions)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *AnnotationPermission) DeepCopyInto(out *AnnotationPermission) {
+	*out = *in
+	out.Dashboard = in.Dashboard
+	out.Organization = in.Organization
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnnotationPermission.
+func (in *AnnotationPermission) DeepCopy() *AnnotationPermission {
+	if in == nil {
+		return nil
+	}
+	out := new(AnnotationPermission)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *Dashboard) DeepCopyInto(out *Dashboard) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
+	in.Spec.DeepCopyInto(&out.Spec)
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Dashboard.
+func (in *Dashboard) DeepCopy() *Dashboard {
+	if in == nil {
+		return nil
+	}
+	out := new(Dashboard)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *Dashboard) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *DashboardAccessInfo) DeepCopyInto(out *DashboardAccessInfo) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	if in.AnnotationsPermissions != nil {
+		in, out := &in.AnnotationsPermissions, &out.AnnotationsPermissions
+		*out = new(AnnotationPermission)
+		**out = **in
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DashboardAccessInfo.
+func (in *DashboardAccessInfo) DeepCopy() *DashboardAccessInfo {
+	if in == nil {
+		return nil
+	}
+	out := new(DashboardAccessInfo)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *DashboardAccessInfo) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *DashboardList) DeepCopyInto(out *DashboardList) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ListMeta.DeepCopyInto(&out.ListMeta)
+	if in.Items != nil {
+		in, out := &in.Items, &out.Items
+		*out = make([]Dashboard, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DashboardList.
+func (in *DashboardList) DeepCopy() *DashboardList {
+	if in == nil {
+		return nil
+	}
+	out := new(DashboardList)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *DashboardList) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *DashboardSummary) DeepCopyInto(out *DashboardSummary) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
+	in.Spec.DeepCopyInto(&out.Spec)
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DashboardSummary.
+func (in *DashboardSummary) DeepCopy() *DashboardSummary {
+	if in == nil {
+		return nil
+	}
+	out := new(DashboardSummary)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *DashboardSummary) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *DashboardSummaryList) DeepCopyInto(out *DashboardSummaryList) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ListMeta.DeepCopyInto(&out.ListMeta)
+	if in.Items != nil {
+		in, out := &in.Items, &out.Items
+		*out = make([]DashboardSummary, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DashboardSummaryList.
+func (in *DashboardSummaryList) DeepCopy() *DashboardSummaryList {
+	if in == nil {
+		return nil
+	}
+	out := new(DashboardSummaryList)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *DashboardSummaryList) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *DashboardSummarySpec) DeepCopyInto(out *DashboardSummarySpec) {
+	*out = *in
+	if in.Tags != nil {
+		in, out := &in.Tags, &out.Tags
+		*out = make([]string, len(*in))
+		copy(*out, *in)
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DashboardSummarySpec.
+func (in *DashboardSummarySpec) DeepCopy() *DashboardSummarySpec {
+	if in == nil {
+		return nil
+	}
+	out := new(DashboardSummarySpec)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *DashboardVersionInfo) DeepCopyInto(out *DashboardVersionInfo) {
+	*out = *in
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DashboardVersionInfo.
+func (in *DashboardVersionInfo) DeepCopy() *DashboardVersionInfo {
+	if in == nil {
+		return nil
+	}
+	out := new(DashboardVersionInfo)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *DashboardVersionsInfo) DeepCopyInto(out *DashboardVersionsInfo) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ListMeta.DeepCopyInto(&out.ListMeta)
+	if in.Items != nil {
+		in, out := &in.Items, &out.Items
+		*out = make([]DashboardVersionInfo, len(*in))
+		copy(*out, *in)
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DashboardVersionsInfo.
+func (in *DashboardVersionsInfo) DeepCopy() *DashboardVersionsInfo {
+	if in == nil {
+		return nil
+	}
+	out := new(DashboardVersionsInfo)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *DashboardVersionsInfo) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *VersionsQueryOptions) DeepCopyInto(out *VersionsQueryOptions) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VersionsQueryOptions.
+func (in *VersionsQueryOptions) DeepCopy() *VersionsQueryOptions {
+	if in == nil {
+		return nil
+	}
+	out := new(VersionsQueryOptions)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *VersionsQueryOptions) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}

pkg/apis/dashboard/v0alpha1/zz_generated.defaults.go

@@ -0,0 +1,19 @@
+//go:build !ignore_autogenerated
+// +build !ignore_autogenerated
+
+// SPDX-License-Identifier: AGPL-3.0-only
+
+// Code generated by defaulter-gen. DO NOT EDIT.
+
+package v0alpha1
+
+import (
+	runtime "k8s.io/apimachinery/pkg/runtime"
+)
+
+// RegisterDefaults adds defaulters functions to the given scheme.
+// Public to allow building arbitrary schemes.
+// All generated defaulters are covering - they call all nested defaulters.
+func RegisterDefaults(scheme *runtime.Scheme) error {
+	return nil
+}