Error applying a CRD generated by controller-tools that contains the ContainerPort struct

[MenD32]

I have the following types.go file:

// types.go

type ExampleSpec struct {
	apiv1.ContainerPort `json:",inline"`
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.conditions[0].message"
// +kubebuilder:printcolumn:name="Synced",type="string",JSONPath=".status.conditions[0].status"
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
// +genclient

type Example struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ExampleSpec	`json:"spec"`
}

after generating a CRD from this code with controller-gen like so:
controller-gen crd:generateEmbeddedObjectMeta=true paths="./pkg/apis/..." output:stdout | tail -n +2 > manifests/crd.yaml

and trying to apply with kubectl create I get the following error(s):

* spec.validation.openAPIV3Schema.properties[spec].properties[protocol].allOf[0].default: Forbidden: must be undefined to be structural
* spec.validation.openAPIV3Schema.properties[spec].properties[protocol].allOf[1].default: Forbidden: must be undefined to be structural

after some messing around i found that removing the // +default="TCP" comment from ContainerPort.Protocol in k8s.io/api, fixes the issue while maintaining the default value of TCP in the CRD itself.

versions:

• Kubernetes v1.30.0
• Controller-gen built from master, hash is b98a19a
• k8s.io/[email protected]

[aerfio]

It affects https://github.com/kubernetes-sigs/controller-tools/releases/tag/v0.16.0-beta.0, works with v0.15.0 in my case

[sbueringer]

Another case was reported here: #1034

[sbueringer]

I assume the relevant change since v0.15.0 is this one: #938

[sbueringer]

Not sure what's going on, clearly looks like a bug:

	// Protocol for port. Must be UDP, TCP, or SCTP.
	// Defaults to "TCP".
	// +optional
	// +default="TCP"
	Protocol corev1.Protocol `json:"protocol,omitempty" protobuf:"bytes,4,opt,name=protocol,casttype=Protocol"`

leads to

              protocol:
                allOf:
                - default: TCP
                - default: TCP
                description: |-
                  Protocol for port. Must be UDP, TCP, or SCTP.
                  Defaults to "TCP".
                type: string

[sbueringer]

Oh my...

controller-tools/pkg/crd/known_types.go

Lines 28 to 35 in 0adb7e1

	"k8s.io/api/core/v1": func(p *Parser, pkg *loader.Package) {
	// Explicit defaulting for the corev1.Protocol type in lieu of https://github.com/kubernetes/enhancements/pull/1928
	p.Schemata[TypeIdent{Name: "Protocol", Package: pkg}] = apiext.JSONSchemaProps{
	Type: "string",
	Default: &apiext.JSON{Raw: []byte(`"TCP"`)},
	}
	p.AddPackage(pkg)
	},

[mbobrovskyi]

Oh my...

controller-tools/pkg/crd/known_types.go

Lines 28 to 35 in 0adb7e1

	"k8s.io/api/core/v1": func(p *Parser, pkg *loader.Package) {
	// Explicit defaulting for the corev1.Protocol type in lieu of https://github.com/kubernetes/enhancements/pull/1928
	p.Schemata[TypeIdent{Name: "Protocol", Package: pkg}] = apiext.JSONSchemaProps{
	Type: "string",
	Default: &apiext.JSON{Raw: []byte(`"TCP"`)},
	}
	p.AddPackage(pkg)
	},

Good catch!

[mbobrovskyi]

@sbueringer do you want to fix it?

[sbueringer]

Already on it

[sbueringer]

PR is open: #1035

If possible, please also test in your use cases to ensure it fixes the entire issue (although I'm pretty confident)

Once the PR merges I would cut a patch release

[mbobrovskyi]

If possible, please also test in your use cases to ensure it fixes the entire issue (although I'm pretty confident)

Yes, it's working fine. Thank you so much!

[pmalek]

PR is open: #1035

If possible, please also test in your use cases to ensure it fixes the entire issue (although I'm pretty confident)

Once the PR merges I would cut a patch release

It does look like it doesn't produce the defaults for container port. 👍

[sbueringer]

Thx for reporting everyone! v0.16.1 with the fix is now available: https://github.com/kubernetes-sigs/controller-tools/releases/tag/v0.16.1