Merge pull request #1247 from lalitc375/k8s-required

✨ Add k8s:required and k8s:optional markers

Author: k8s-ci-robot

pkg/crd/markers/validation.go

@@ -103,7 +103,10 @@ var FieldOnlyMarkers = []*definitionWithHelp{
 		WithHelp(markers.SimpleHelp("CRD validation", "specifies that this field is required.")),
 	must(markers.MakeDefinition("optional", markers.DescribesField, struct{}{})).
 		WithHelp(markers.SimpleHelp("CRD validation", "specifies that this field is optional.")),
-
+	must(markers.MakeDefinition("k8s:required", markers.DescribesField, struct{}{})).
+		WithHelp(markers.SimpleHelp("CRD validation", "specifies that this field is required.")),
+	must(markers.MakeDefinition("k8s:optional", markers.DescribesField, struct{}{})).
+		WithHelp(markers.SimpleHelp("CRD validation", "specifies that this field is optional.")),
 	must(markers.MakeDefinition("nullable", markers.DescribesField, Nullable{})).
 		WithHelp(Nullable{}.Help()),
 

pkg/crd/markers/zz_generated.markerhelp.go

@@ -472,9 +472,9 @@ func structToSchema(ctx *schemaContext, structType *ast.StructType) *apiext.JSON
 			}
 			// explicitly required - kubebuilder
 			props.Required = append(props.Required, fieldName)
-		case field.Markers.Get("optional") != nil:
+		case field.Markers.Get("optional") != nil, field.Markers.Get("k8s:optional") != nil:
 			// explicitly optional - kubernetes
-		case field.Markers.Get("required") != nil:
+		case field.Markers.Get("required") != nil, field.Markers.Get("k8s:required") != nil:
 			if exactlyOneOf.Has(fieldName) || atMostOneOf.Has(fieldName) || atLeastOneOf.Has(fieldName) {
 				ctx.pkg.AddError(loader.ErrFromNode(fmt.Errorf("field %s is part of OneOf constraint and cannot be marked as required", fieldName), structType))
 				return props

pkg/crd/schema.go

@@ -238,6 +238,10 @@ type CronJobSpec struct {
 	// +optional
 	ExplicitlyOptionalKubernetes string `json:"explicitlyOptionalKubernetes"`
 
+	// This tests explicitly optional k8s fields
+	// +k8s:optional
+	ExplicitlyOptionalK8s string `json:"explicitlyOptionalK8s"`
+
 	// This tests explicitly required kubebuilder fields
 	// +kubebuilder:validation:Required
 	ExplicitlyRequiredKubebuilder string `json:"explicitlyRequiredKubebuilder,omitempty"`
@@ -246,6 +250,10 @@ type CronJobSpec struct {
 	// +required
 	ExplicitlyRequiredKubernetes string `json:"explicitlyRequiredKubernetes,omitempty"`
 
+	// This tests explicitly required k8s fields
+	// +k8s:required
+	ExplicitlyRequiredK8s string `json:"explicitlyRequiredK8s,omitempty"`
+
 	// This tests that min/max properties work
 	MinMaxProperties MinMaxObject `json:"minMaxProperties,omitempty"`
 

pkg/crd/testdata/cronjob_types.go

@@ -201,12 +201,18 @@ spec:
                   - 3
                   type: integer
                 type: array
+              explicitlyOptionalK8s:
+                description: This tests explicitly optional k8s fields
+                type: string
               explicitlyOptionalKubebuilder:
                 description: This tests explicitly optional kubebuilder fields
                 type: string
               explicitlyOptionalKubernetes:
                 description: This tests explicitly optional kubernetes fields
                 type: string
+              explicitlyRequiredK8s:
+                description: This tests explicitly required k8s fields
+                type: string
               explicitlyRequiredKubebuilder:
                 description: This tests explicitly required kubebuilder fields
                 type: string
@@ -9174,6 +9180,7 @@ spec:
             - defaultedString
             - doubleDefaultedString
             - embeddedResource
+            - explicitlyRequiredK8s
             - explicitlyRequiredKubebuilder
             - explicitlyRequiredKubernetes
             - float64WithValidations