Merge pull request #10778 from sbueringer/pr-xmetadata

✨ Add metadata for top-level and nested variables & deprecate previous metadata field

Author: k8s-ci-robot

.golangci.yml

@@ -234,7 +234,7 @@ issues:
   # should be removed as the referenced deprecated item is removed from the project.
   - linters:
       - staticcheck
-    text: "SA1019: (bootstrapv1.ClusterStatus|KubeadmConfigSpec.UseExperimentalRetryJoin|scope.Config.Spec.UseExperimentalRetryJoin|DockerMachine.Spec.Bootstrapped|machineStatus.Bootstrapped|c.TopologyPlan) is deprecated"
+    text: "SA1019: (bootstrapv1.ClusterStatus|KubeadmConfigSpec.UseExperimentalRetryJoin|scope.Config.Spec.UseExperimentalRetryJoin|DockerMachine.Spec.Bootstrapped|machineStatus.Bootstrapped|c.TopologyPlan|clusterv1.ClusterClassVariableMetadata|(variable|currentDefinition|specVar|newVariableDefinition|statusVarDefinition).Metadata) is deprecated"
   # Specific exclude rules for deprecated packages that are still part of the codebase. These
   # should be removed as the referenced deprecated packages are removed from the project.
   - linters:

api/v1beta1/clusterclass_types.go

@@ -396,6 +396,9 @@ type ClusterClassVariable struct {
 	// Metadata is the metadata of a variable.
 	// It can be used to add additional data for higher level tools to
 	// a ClusterClassVariable.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please use XMetadata in JSONSchemaProps instead.
+	//
 	// +optional
 	Metadata ClusterClassVariableMetadata `json:"metadata,omitempty"`
 
@@ -406,6 +409,8 @@ type ClusterClassVariable struct {
 // ClusterClassVariableMetadata is the metadata of a variable.
 // It can be used to add additional data for higher level tools to
 // a ClusterClassVariable.
+//
+// Deprecated: This struct is deprecated and is going to be removed in the next apiVersion.
 type ClusterClassVariableMetadata struct {
 	// Map of string keys and values that can be used to organize and categorize
 	// (scope and select) variables.
@@ -569,6 +574,26 @@ type JSONSchemaProps struct {
 	// +listType=map
 	// +listMapKey=rule
 	XValidations []ValidationRule `json:"x-kubernetes-validations,omitempty"`
+
+	// XMetadata is the metadata of a variable or a nested field within a variable.
+	// It can be used to add additional data for higher level tools.
+	// +optional
+	XMetadata *VariableSchemaMetadata `json:"x-metadata,omitempty"`
+}
+
+// VariableSchemaMetadata is the metadata of a variable or a nested field within a variable.
+// It can be used to add additional data for higher level tools.
+type VariableSchemaMetadata struct {
+	// Map of string keys and values that can be used to organize and categorize
+	// (scope and select) variables.
+	// +optional
+	Labels map[string]string `json:"labels,omitempty"`
+
+	// Annotations is an unstructured key value map that can be used to store and
+	// retrieve arbitrary metadata.
+	// They are not queryable.
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`
 }
 
 // ValidationRule describes a validation rule written in the CEL expression language.
@@ -897,6 +922,9 @@ type ClusterClassStatusVariableDefinition struct {
 	// Metadata is the metadata of a variable.
 	// It can be used to add additional data for higher level tools to
 	// a ClusterClassVariable.
+	//
+	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion.
+	//
 	// +optional
 	Metadata ClusterClassVariableMetadata `json:"metadata,omitempty"`
 

api/v1beta1/zz_generated.deepcopy.go

@@ -114,6 +114,14 @@ func TestClusterClassReconciler_reconcile(t *testing.T) {
 				Schema: clusterv1.VariableSchema{
 					OpenAPIV3Schema: clusterv1.JSONSchemaProps{
 						Type: "integer",
+						XMetadata: &clusterv1.VariableSchemaMetadata{
+							Labels: map[string]string{
+								"some-label": "some-label-value",
+							},
+							Annotations: map[string]string{
+								"some-annotation": "some-annotation-value",
+							},
+						},
 					},
 				},
 				Metadata: clusterv1.ClusterClassVariableMetadata{
@@ -408,6 +416,14 @@ func TestReconciler_reconcileVariables(t *testing.T) {
 					Schema: clusterv1.VariableSchema{
 						OpenAPIV3Schema: clusterv1.JSONSchemaProps{
 							Type: "integer",
+							XMetadata: &clusterv1.VariableSchemaMetadata{
+								Labels: map[string]string{
+									"some-label": "some-label-value",
+								},
+								Annotations: map[string]string{
+									"some-annotation": "some-annotation-value",
+								},
+							},
 						},
 					},
 					Metadata: clusterv1.ClusterClassVariableMetadata{
@@ -448,6 +464,14 @@ func TestReconciler_reconcileVariables(t *testing.T) {
 							Schema: clusterv1.VariableSchema{
 								OpenAPIV3Schema: clusterv1.JSONSchemaProps{
 									Type: "integer",
+									XMetadata: &clusterv1.VariableSchemaMetadata{
+										Labels: map[string]string{
+											"some-label": "some-label-value",
+										},
+										Annotations: map[string]string{
+											"some-annotation": "some-annotation-value",
+										},
+									},
 								},
 							},
 							Metadata: clusterv1.ClusterClassVariableMetadata{
@@ -512,6 +536,14 @@ func TestReconciler_reconcileVariables(t *testing.T) {
 						Schema: clusterv1.VariableSchema{
 							OpenAPIV3Schema: clusterv1.JSONSchemaProps{
 								Type: "string",
+								XMetadata: &clusterv1.VariableSchemaMetadata{
+									Labels: map[string]string{
+										"some-label": "some-label-value",
+									},
+									Annotations: map[string]string{
+										"some-annotation": "some-annotation-value",
+									},
+								},
 							},
 						},
 						Metadata: clusterv1.ClusterClassVariableMetadata{
@@ -535,6 +567,14 @@ func TestReconciler_reconcileVariables(t *testing.T) {
 							Schema: clusterv1.VariableSchema{
 								OpenAPIV3Schema: clusterv1.JSONSchemaProps{
 									Type: "integer",
+									XMetadata: &clusterv1.VariableSchemaMetadata{
+										Labels: map[string]string{
+											"some-label": "some-label-value",
+										},
+										Annotations: map[string]string{
+											"some-annotation": "some-annotation-value",
+										},
+									},
 								},
 							},
 							Metadata: clusterv1.ClusterClassVariableMetadata{
@@ -565,6 +605,14 @@ func TestReconciler_reconcileVariables(t *testing.T) {
 							Schema: clusterv1.VariableSchema{
 								OpenAPIV3Schema: clusterv1.JSONSchemaProps{
 									Type: "string",
+									XMetadata: &clusterv1.VariableSchemaMetadata{
+										Labels: map[string]string{
+											"some-label": "some-label-value",
+										},
+										Annotations: map[string]string{
+											"some-annotation": "some-annotation-value",
+										},
+									},
 								},
 							},
 							Metadata: clusterv1.ClusterClassVariableMetadata{