Should respect +required

[thockin]

What do you want to happen?

Generating CRD from a field defined as:

// +required
Foo string `json:"foo,omitempty" protobuf:"bytes,1,opt,name=foo"`

...should be determined as "required" and not optional. It's a little wonky, but context is kubernetes/kubernetes#124553 (comment) and kubernetes/kubernetes#124553 (comment)

Extra Labels

No response

[camilamacedo86]

Hi @thockin,

The project responsible for generate the CRDs and etc is the controller-tools: https://github.com/kubernetes-sigs/controller-tools

So, can you please raise this issue against their repo?

Also, see that you are using omitempty therefore, you are saying that it can be empty so I do not think that the "+required" can work in this case. You must remove omitempty otherwise, an empty value is also acceptable.

Thank you for your understanding.
I hope that this can help you.

Cheers,

[camilamacedo86]

Hi @thockin

Also, see: kubernetes-sigs/kubebuilder#3794
Note that we clarify it in the docs.

[thockin]

I am confused. I don't see +required documented, just +optional.

The point is that the cited example, with omitempty, does NOT get marked as required, despite the +required tag. I had to remove the omitempty.

Am I missing something?

[thockin]

Maybe to clarify - this is a tag used in kubernetes/api, which is being referenced by other CRDs. We don't want to use kubebuilder tags in k/k when we have "simple" equivalents.

[liggitt]

agree this should be re-opened, so that kubebuilder can generate correct CRDs that embed built-in kubernetes go types

[liggitt]

/reopen
/transfer controller-tools

[liggitt]

omitempty means a zero value should not be serialized. That is independent of whether a value is required. An explicit +required indicates this in kube-openapi / kubernetes API types

[liggitt]

/reopen

[k8s-ci-robot]

@liggitt: Reopened this issue.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[sbueringer]

Agree, we should support +required. Just like we already support +optional