The CustomResourceDefinition "cronjobs.batch.tutorial.kubebuilder.io" is invalid

Question

The CustomResourceDefinition "cronjobs.batch.tutorial.kubebuilder.io" is invalid

zehuaiWANG opened this issue 4 years ago · 19 comments

I followed the tutorial but the cronjob install failed. I clone the master code, but it seems to not work. Could anyone tell me what to do next? Thanks a lot.

[root@test ~/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project]# kubectl version --short
Client Version: v1.18.0
Server Version: v1.19.0-beta.0.318+b618411f1edb98

[root@test ~/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project]# make install
/usr/local/bin/controller-gen "crd:trivialVersions=true" rbac:roleName=manager-role webhook paths="./api/...;./controllers/..." output:crd:artifacts:config=config/crd/bases
kubectl apply -f config/crd/bases
The CustomResourceDefinition "cronjobs.batch.tutorial.kubebuilder.io" is invalid: 
* spec.validation.openAPIV3Schema.properties[spec].properties[jobTemplate].properties[spec].properties[template].properties[spec].properties[initContainers].items.properties[ports].items.properties[protocol].default: Required value: this property is in x-kubernetes-list-map-keys, so it must have a default or be a required property
* spec.validation.openAPIV3Schema.properties[spec].properties[jobTemplate].properties[spec].properties[template].properties[spec].properties[containers].items.properties[ports].items.properties[protocol].default: Required value: this property is in x-kubernetes-list-map-keys, so it must have a default or be a required property
make: *** [install] Error 1

/kind bug

Answer 1 · 2020-06-02T02:48:21.000Z

/assign @camilamacedo86
Could you help me to have a look with this? Thanks a lot.

Answer 2 · 2020-06-02T04:38:35.000Z

If I use kubernentes 1.16, it won't happen. I guess it's a problem after kubernetes 1.18.

Answer 3 · 2020-06-02T09:48:25.000Z

Hi @zehuaiWANG,

The /kubebuilder/docs/book/src/cronjob-tutorial/testdata/project is outdated. I have been working on a PR to update that. See: #1492

Answer 4 · 2020-06-02T09:49:52.000Z

/assign @camilamacedo86

Answer 5 · 2020-06-23T16:58:28.000Z

This is likely related to kubernetes-sigs/controller-tools#444.

Answer 6 · 2020-06-24T07:09:38.000Z

Hi @estroz,

See that the user is trying to check the example code in the repo:

[root@test ~/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project]# kubectl version --short

The project cronjob-tutorial/testdata/project which is used to do the doc is a scaffold project. However, it is NOT updated when we run the golden script. It is very outdated. So, we need to update the scaffolded project cronjob-tutorial/testdata/project to the latest versions of the projects gen with the tool and then, I believe that it will be solved as well.

Answer 7 · 2020-07-09T09:47:13.000Z

So how to solve this issue? I encountered exactly the same problem when learning kubebuilder. 😟

Answer 8 · 2020-07-09T13:38:24.000Z

@keithnull if you use the minikube, you can change the version of kubernetes to 1.16, and it will not happen.

Answer 9 · 2020-07-10T02:35:09.000Z

@zehuaiWANG Thanks, but it's just a work-around. Any way to solve this problem in 1.18?

Answer 10 · 2020-07-10T02:44:59.000Z

@keithnull I haven't found a good way to solve this problem in kubernetes 1.18, this seems to be caused by a field validation introduced by kubernetes 1.18.
maybe @camilamacedo86 will know more details, you can ask her for help.

Answer 11 · 2020-07-10T08:42:09.000Z

Hi @keithnull,

The project cronjob-tutorial/testdata/project has not been updated with the changes made in the tool. We need to update this project. You can check the testdadata/ dir where has projects which are updated and verified for each PR.

However, regards the k8s version its has changes we would need to check the error to better assist you. See #933 and #1065 which might helps you with.

Also, I'd recommend you use the tool to follow up the steps and build the tutorial example instead of trying to use it.
. If you face problems by following this recommendation please raise a new issue with the steps performed and further details for we are able to reproduce and help you with.

Answer 12 · 2020-08-08T07:46:55.000Z

Seems to be fixed by kubernetes-sigs/controller-tools#440

Answer 13 · 2020-09-30T12:55:37.000Z

Hi @keithnull,

The project cronjob-tutorial/testdata/project has not been updated with the changes made in the tool. We need to update this project. You can check the testdadata/ dir where has projects which are updated and verified for each PR.

However, regards the k8s version its has changes we would need to check the error to better assist you. See #933 and #1065 which might helps you with.

Also, I'd recommend you use the tool to follow up the steps and build the tutorial example instead of trying to use it.
. If you face problems by following this recommendation please raise a new issue with the steps performed and further details for we are able to reproduce and help you with.

I started out with building the project by following the instructions on the tutorial and I got the error. Then I tried cloning the project and still see the same error.
I'm using

$ kubectl version --short
Client Version: v1.19.0
Server Version: v1.19.1

Answer 14 · 2020-10-26T11:53:31.000Z

The issue still:

 $ make install
/Users/camilamacedo/go/bin/controller-gen "crd:trivialVersions=true" rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
/Users/camilamacedo/go/bin/kustomize build config/crd | kubectl apply -f -
The CustomResourceDefinition "cronjobs.batch.tutorial.kubebuilder.io" is invalid: 
* spec.validation.openAPIV3Schema.properties[spec].properties[jobTemplate].properties[spec].properties[template].properties[spec].properties[containers].items.properties[ports].items.properties[protocol].default: Required value: this property is in x-kubernetes-list-map-keys, so it must have a default or be a required property
* spec.validation.openAPIV3Schema.properties[spec].properties[jobTemplate].properties[spec].properties[template].properties[spec].properties[initContainers].items.properties[ports].items.properties[protocol].default: Required value: this property is in x-kubernetes-list-map-keys, so it must have a default or be a required property
make: *** [Makefile:33: install] Error 1

As @estroz described it shows to be related to kubernetes-sigs/controller-tools#444 and after we get merged the changes in the PR #1644 and update the examples in the docs/book/src/ it might be solved.

Answer 15 · 2020-11-05T07:30:21.000Z

Any workaround till latest controller-tools is merged?
For context, I'm having a CRD with a field of corev1.PodSpec and I'm getting

The CustomResourceDefinition "testcrd.example.com" is invalid:
* spec.validation.openAPIV3Schema.properties[spec].properties[podSpec].properties[initContainers].items.properties[ports].items.properties[protocol].default: Required value: this property is in x-kubernetes-list-map-keys, so it must have a default or be a required property
* spec.validation.openAPIV3Schema.properties[spec].properties[podSpec].properties[containers].items.properties[ports].items.properties[protocol].default: Required value: this property is in x-kubernetes-list-map-keys, so it must have a default or be a required property

thanks!

Answer 16 · 2020-11-06T19:15:25.000Z

@dgkanatsios yes, see operator-framework/operator-sdk#3235 (comment)

Answer 17 · 2020-11-16T07:22:50.000Z

Do we have any solution about this issue? My CRD contains a field of PodTemplateSpec also can't be installed into a 1.18 k8s cluster.

Answer 18 · 2020-11-16T17:27:44.000Z

@zhouxinyu see #1544 (comment)

Answer 19 · 2020-11-29T14:56:15.000Z

Here is how i solved the issue;

In the api/v1/cronjob_webhook.go , add the following 2 options to the // +kubebuilder:webhook:mutating=false and // +kubebuilder:webhook:mutating=true markers;
```
admissionReviewVersions=v1,sideEffects=None
```
Run make install in the project root directory again and enjoy your newly created CRD.