K8s: use +enum tag in playlist and unstructured dummy (#82022)

pkg/apis/datasource/v0alpha1/types.go

@@ -21,7 +21,6 @@ type DataSourceConnection struct {
 // +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"`

pkg/apis/example/v0alpha1/types.go

@@ -2,6 +2,8 @@ package v0alpha1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	common "github.com/grafana/grafana/pkg/apis/common/v0alpha1"
 )
 
 // Mirrors the info exposed in "github.com/grafana/grafana/pkg/setting"
@@ -26,13 +28,12 @@ type DummyResource struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec string `json:"spec,omitempty"`
+	Spec common.Unstructured `json:"spec,omitempty"`
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type DummyResourceList struct {
 	metav1.TypeMeta `json:",inline"`
-	// +optional
 	metav1.ListMeta `json:"metadata,omitempty"`
 
 	Items []DummyResource `json:"items,omitempty"`

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

@@ -16,6 +16,7 @@ func (in *DummyResource) DeepCopyInto(out *DummyResource) {
 	*out = *in
 	out.TypeMeta = in.TypeMeta
 	in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
+	in.Spec.DeepCopyInto(&out.Spec)
 	return
 }
 

pkg/apis/example/v0alpha1/zz_generated.openapi.go

@@ -51,15 +51,14 @@ func schema_pkg_apis_example_v0alpha1_DummyResource(ref common.ReferenceCallback
 					},
 					"spec": {
 						SchemaProps: spec.SchemaProps{
-							Type:   []string{"string"},
+							Ref: ref("github.com/grafana/grafana/pkg/apis/common/v0alpha1.Unstructured"),
-							Format: "",
 						},
 					},
 				},
 			},
 		},
 		Dependencies: []string{
-			"k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta"},
+			"github.com/grafana/grafana/pkg/apis/common/v0alpha1.Unstructured", "k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta"},
 	}
 }
 

pkg/apis/peakq/v0alpha1/zz_generated.openapi.go

@@ -407,7 +407,7 @@ func schema_pkg_apis_peakq_v0alpha1_VariableReplacement(ref common.ReferenceCall
 				Properties: map[string]spec.Schema{
 					"path": {
 						SchemaProps: spec.SchemaProps{
-							Description: "Path is the location of the property within the the target properties. The format for this is not figured out yet (Maybe JSONPath?). Idea: [\"string\", int, \"string\"] where int indicates array offset",
+							Description: "Path is the location of the property within a target. The format for this is not figured out yet (Maybe JSONPath?). Idea: [\"string\", int, \"string\"] where int indicates array offset",
 							Default:     "",
 							Type:        []string{"string"},
 							Format:      "",

pkg/apis/playlist/v0alpha1/types.go

@@ -36,12 +36,16 @@ type Spec struct {
 	Items []Item `json:"items,omitempty"`
 }
 
+// Type of the item.
+// +enum
+type ItemType string
+
 // Defines values for ItemType.
 const (
 	ItemTypeDashboardByTag ItemType = "dashboard_by_tag"
 	ItemTypeDashboardByUid ItemType = "dashboard_by_uid"
 
-	// deprecated -- should use UID
+	// Deprecated -- should use UID
 	ItemTypeDashboardById ItemType = "dashboard_by_id"
 )
 
@@ -60,6 +64,3 @@ type Item struct {
 	//  - dashboard_by_uid: The value is the dashboard UID
 	Value string `json:"value"`
 }
-
-// Type of the item.
-type ItemType string

pkg/apis/playlist/v0alpha1/zz_generated.openapi.go

@@ -32,10 +32,11 @@ func schema_pkg_apis_playlist_v0alpha1_Item(ref common.ReferenceCallback) common
 				Properties: map[string]spec.Schema{
 					"type": {
 						SchemaProps: spec.SchemaProps{
-							Description: "Type of the item.",
+							Description: "Type of the item.\n\nPossible enum values:\n - `\"dashboard_by_id\"` Deprecated -- should use UID\n - `\"dashboard_by_tag\"`\n - `\"dashboard_by_uid\"`",
 							Default:     "",
 							Type:        []string{"string"},
 							Format:      "",
+							Enum:        []interface{}{"dashboard_by_id", "dashboard_by_tag", "dashboard_by_uid"},
 						},
 					},
 					"value": {

pkg/apis/query/v0alpha1/doc.go

@@ -3,4 +3,4 @@
 // +k8s:defaulter-gen=TypeMeta
 // +groupName=query.grafana.app
 
-package v0alpha1
+package v0alpha1 // import "github.com/grafana/grafana/pkg/apis/query/v0alpha1"

pkg/cmd/grafana/apiserver/cmd.go

@@ -28,7 +28,7 @@ func newCommandStartExampleAPIServer(o *APIServerOptions, stopCh <-chan struct{}
 		Short: "Run the grafana apiserver",
 		Long: "Run a standalone kubernetes based apiserver that can be aggregated by a root apiserver. " +
 			devAcknowledgementNotice,
-		Example: "grafana apiserver example.grafana.app",
+		Example: "grafana apiserver --runtime-config=example.grafana.app/v0alpha1=true",
 		RunE: func(c *cobra.Command, args []string) error {
 			runtime, err := standalone.ReadRuntimeConfig(runtimeConfig)
 			if err != nil {

pkg/registry/apis/example/dummy_storage.go

@@ -12,6 +12,7 @@ import (
 	genericregistry "k8s.io/apiserver/pkg/registry/generic/registry"
 	"k8s.io/apiserver/pkg/registry/rest"
 
+	common "github.com/grafana/grafana/pkg/apis/common/v0alpha1"
 	example "github.com/grafana/grafana/pkg/apis/example/v0alpha1"
 	grafanarequest "github.com/grafana/grafana/pkg/services/apiserver/endpoints/request"
 	grafanaregistry "github.com/grafana/grafana/pkg/services/apiserver/registry/generic"
@@ -93,7 +94,11 @@ func (s *dummyStorage) Get(ctx context.Context, name string, options *metav1.Get
 			CreationTimestamp: s.creationTimestamp,
 			ResourceVersion:   "1",
 		},
-		Spec: fmt.Sprintf("dummy: %s", name),
+		Spec: common.Unstructured{
+			Object: map[string]any{
+				"Dummy": name,
+			},
+		},
 	}, nil
 }
 
@@ -112,7 +117,11 @@ func (s *dummyStorage) List(ctx context.Context, options *internalversion.ListOp
 				CreationTimestamp: s.creationTimestamp,
 				ResourceVersion:   "1",
 			},
-			Spec: fmt.Sprintf("dummy: %s", name),
+			Spec: common.Unstructured{
+				Object: map[string]any{
+					"Dummy": name,
+				},
+			},
 		})
 	}
 	return res, nil