K8s: Expose testdata connection as an api-server (dev mode only) (#79726)

pkg/apis/datasource/v0alpha1/doc.go

@@ -0,0 +1,5 @@
+// +k8s:deepcopy-gen=package
+// +k8s:openapi-gen=true
+// +groupName=datasources.grafana.com
+
+package v0alpha1

pkg/apis/datasource/v0alpha1/types.go

@@ -0,0 +1,57 @@
+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   = "*.datasource.grafana.app"
+	VERSION = "v0alpha1"
+)
+
+var GenericConnectionResourceInfo = apis.NewResourceInfo(GROUP, VERSION,
+	"connections", "connection", "DataSourceConnection",
+	func() runtime.Object { return &DataSourceConnection{} },
+	func() runtime.Object { return &DataSourceConnectionList{} },
+)
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type DataSourceConnection struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// The display name
+	Title string `json:"title"`
+
+	// Optional description for the data source (does not exist yet)
+	Description string `json:"description,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type DataSourceConnectionList struct {
+	metav1.TypeMeta `json:",inline"`
+	// +optional
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	Items []DataSourceConnection `json:"items,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type HealthCheckResult struct {
+	metav1.TypeMeta `json:",inline"`
+
+	// The string description
+	Status string `json:"status,omitempty"`
+
+	// Explicit status code
+	Code int `json:"code,omitempty"`
+
+	// Optional description for the data source
+	Message string `json:"message,omitempty"`
+
+	// Spec depends on the the plugin
+	Details *Unstructured `json:"details,omitempty"`
+}

pkg/apis/datasource/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/datasource/v0alpha1/zz_generated.deepcopy.go

@@ -0,0 +1,100 @@
+//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 *DataSourceConnection) DeepCopyInto(out *DataSourceConnection) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DataSourceConnection.
+func (in *DataSourceConnection) DeepCopy() *DataSourceConnection {
+	if in == nil {
+		return nil
+	}
+	out := new(DataSourceConnection)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *DataSourceConnection) 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 *DataSourceConnectionList) DeepCopyInto(out *DataSourceConnectionList) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ListMeta.DeepCopyInto(&out.ListMeta)
+	if in.Items != nil {
+		in, out := &in.Items, &out.Items
+		*out = make([]DataSourceConnection, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DataSourceConnectionList.
+func (in *DataSourceConnectionList) DeepCopy() *DataSourceConnectionList {
+	if in == nil {
+		return nil
+	}
+	out := new(DataSourceConnectionList)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *DataSourceConnectionList) 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 *HealthCheckResult) DeepCopyInto(out *HealthCheckResult) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	if in.Details != nil {
+		in, out := &in.Details, &out.Details
+		*out = (*in).DeepCopy()
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HealthCheckResult.
+func (in *HealthCheckResult) DeepCopy() *HealthCheckResult {
+	if in == nil {
+		return nil
+	}
+	out := new(HealthCheckResult)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *HealthCheckResult) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}

pkg/apis/datasource/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
+}

pkg/apis/example/v0alpha1/doc.go

@@ -1,6 +1,6 @@
 // +k8s:deepcopy-gen=package
 // +k8s:openapi-gen=true
-// +groupName=example.grafana.com
+// +groupName=example.grafana.app
 
 // The testing api is a dependency free service that we can use to experiment with
 // api aggregation across multiple deployment models.  Specifically:

pkg/apis/types.go

@@ -13,6 +13,7 @@ type ResourceInfo struct {
 	version      string
 	resourceName string
 	singularName string
+	shortName    string
 	kind         string
 	newObj       func() runtime.Object
 	newList      func() runtime.Object
@@ -20,13 +21,34 @@ type ResourceInfo struct {
 
 func NewResourceInfo(group, version, resourceName, singularName, kind string,
 	newObj func() runtime.Object, newList func() runtime.Object) ResourceInfo {
-	return ResourceInfo{group, version, resourceName, singularName, kind, newObj, newList}
+	shortName := "" // an optional alias helpful in kubectl eg ("sa" for serviceaccounts)
+	return ResourceInfo{group, version, resourceName, singularName, shortName, kind, newObj, newList}
+}
+
+func (info *ResourceInfo) WithGroupAndShortName(group string, shortName string) ResourceInfo {
+	return ResourceInfo{
+		group:        group,
+		version:      info.version,
+		resourceName: info.resourceName,
+		singularName: info.singularName,
+		kind:         info.kind,
+		shortName:    shortName,
+		newObj:       info.newObj,
+		newList:      info.newList,
+	}
 }
 
 func (info *ResourceInfo) GetSingularName() string {
 	return info.singularName
 }
 
+func (info *ResourceInfo) GetShortNames() []string {
+	if info.shortName == "" {
+		return []string{}
+	}
+	return []string{info.shortName}
+}
+
 // TypeMeta returns k8s type
 func (info *ResourceInfo) TypeMeta() metav1.TypeMeta {
 	return metav1.TypeMeta{