Add x-kubernetes-{embedded-resource,preserve-unknown-fields} support

Author: sttts

go.mod

@@ -17,5 +17,6 @@ require (
 	k8s.io/api v0.0.0-20190918155943-95b840bb6a1f
 	k8s.io/apiextensions-apiserver v0.0.0-20190918161926-8f644eb6e783
 	k8s.io/apimachinery v0.0.0-20190913080033-27d36303b655
+	k8s.io/utils v0.0.0-20190801114015-581e00157fb1
 	sigs.k8s.io/yaml v1.1.0
 )

pkg/crd/markers/validation.go

@@ -58,6 +58,8 @@ var ValidationMarkers = mustMakeAllWithPrefix("kubebuilder:validation", markers.
 	Enum(nil),
 	Format(""),
 	Type(""),
+	XPreserveUnknownFields{},
+	XEmbeddedResource{},
 )
 
 // FieldOnlyMarkers list field-specific validation markers (i.e. those markers that don't make
@@ -75,6 +77,11 @@ var FieldOnlyMarkers = []*definitionWithHelp{
 
 	must(markers.MakeAnyTypeDefinition("kubebuilder:default", markers.DescribesField, Default{})).
 		WithHelp(Default{}.Help()),
+
+	must(markers.MakeDefinition("kubebuilder:pruning:PreserveUnknownFields", markers.DescribesField, XPreserveUnknownFields{})).
+		WithHelp(XPreserveUnknownFields{}.Help()),
+	must(markers.MakeDefinition("kubebuilder:validation:EmbeddedResource", markers.DescribesField, XEmbeddedResource{})).
+		WithHelp(XEmbeddedResource{}.Help()),
 }
 
 func init() {
@@ -175,6 +182,26 @@ type Default struct {
 	Value interface{}
 }
 
+// +controllertools:marker:generateHelp:category="CRD processing"
+// PreserveUnknownFields stops the apiserver from pruning fields which are not specified.
+//
+// By default the apiserver drops unknown fields from the request payload
+// during the decoding step. This marker stops the API server from doing so.
+// It affects fields recursively, but switches back to normal pruning behaviour
+// if nested  properties or additionalProperties are specified in the schema.
+// This can either be true or undefined. False
+// is forbidden.
+type XPreserveUnknownFields struct{}
+
+// +controllertools:marker:generateHelp:category="CRD validation"
+// EmbeddedResource marks a fields as an embedded resource with apiVersion, kind and metadata fields.
+//
+// An embedded resource is a value that has apiVersion, kind and metadata fields.
+// They are validated implicitly according to the semantics of the currently
+// running apiserver. It is not necessary to add any additional schema for these
+// field, yet it is possible. This can be combined with PreserveUnknownFields.
+type XEmbeddedResource struct{}
+
 func (m Maximum) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
 	if schema.Type != "integer" {
 		return fmt.Errorf("must apply maximum to an integer")
@@ -310,3 +337,14 @@ func (m Default) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
 	schema.Default = &apiext.JSON{Raw: marshalledDefault}
 	return nil
 }
+
+func (m XPreserveUnknownFields) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
+	defTrue := true
+	schema.XPreserveUnknownFields = &defTrue
+	return nil
+}
+
+func (m XEmbeddedResource) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
+	schema.XEmbeddedResource = true
+	return nil
+}

pkg/crd/markers/zz_generated.markerhelp.go

@@ -28,6 +28,7 @@ import (
 	batchv1beta1 "k8s.io/api/batch/v1beta1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
 )
 
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
@@ -112,6 +113,19 @@ type CronJobSpec struct {
 	// This tests that pattern validator is properly applied.
 	// +kubebuilder:validation:Pattern=`^$|^((https):\/\/?)[^\s()<>]+(?:\([\w\d]+\)|([^[:punct:]\s]|\/?))$`
 	PatternObject string `json:"patternObject"`
+
+	// +kubebuilder:validation:EmbeddedResource
+	// +kubebuilder:validation:nullable
+	EmbeddedResource runtime.RawExtension `json:"embeddedResource"`
+
+	// +kubebuilder:validation:nullable
+	// +kubebuilder:pruning:PreserveUnknownFields
+	UnprunedJSON NestedObject `json:"unprunedJSON"`
+
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:EmbeddedResource
+	// +kubebuilder:validation:nullable
+	UnprunedEmbeddedResource runtime.RawExtension `json:"unprunedEmbeddedResource"`
 }
 
 type NestedObject struct {
@@ -150,6 +164,7 @@ func (t *TotallyABool) UnmarshalJSON(in []byte) error {
 	default:
 		return fmt.Errorf("bad TotallyABool value %q", string(in))
 	}
+	return nil
 }
 
 // ConcurrencyPolicy describes how the job will be handled.

pkg/crd/testdata/cronjob_types.go

@@ -97,6 +97,9 @@ spec:
                 default: forty-two
                 description: This tests that primitive defaulting can be performed.
                 type: string
+              embeddedResource:
+                type: object
+                x-kubernetes-embedded-resource: true
               failedJobsHistoryLimit:
                 description: The number of failed finished jobs to retain. This is
                   a pointer to distinguish between explicit zero and not specified.
@@ -4983,17 +4986,35 @@ spec:
                   and types are applied to types
                 minLength: 4
                 type: string
+              unprunedEmbeddedResource:
+                type: object
+                x-kubernetes-embedded-resource: true
+                x-kubernetes-preserve-unknown-fields: true
+              unprunedJSON:
+                properties:
+                  bar:
+                    type: boolean
+                  foo:
+                    type: string
+                required:
+                - bar
+                - foo
+                type: object
+                x-kubernetes-preserve-unknown-fields: true
             required:
             - binaryName
             - canBeNull
             - defaultedObject
             - defaultedSlice
             - defaultedString
+            - embeddedResource
             - jobTemplate
             - patternObject
             - schedule
             - twoOfAKindPart0
             - twoOfAKindPart1
+            - unprunedEmbeddedResource
+            - unprunedJSON
             type: object
           status:
             description: CronJobStatus defines the observed state of CronJob