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 · 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

ZeHuaiWang · Answer 1 · Tue Jun 02 2020 10:48:21 GMT+0800 (China Standard Time)

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

ZeHuaiWang · Answer 2 · Tue Jun 02 2020 12:38:35 GMT+0800 (China Standard Time)

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

Camila Macedo · Answer 3 · Tue Jun 02 2020 17:48:25 GMT+0800 (China Standard Time)

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

Camila Macedo · Answer 4 · Tue Jun 02 2020 17:49:52 GMT+0800 (China Standard Time)

/assign @camilamacedo86

Eric Stroczynski · Answer 5 · Wed Jun 24 2020 00:58:28 GMT+0800 (China Standard Time)

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

Camila Macedo · Answer 6 · Wed Jun 24 2020 15:09:38 GMT+0800 (China Standard Time)

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.

Zack Wu · Answer 7 · Thu Jul 09 2020 17:47:13 GMT+0800 (China Standard Time)

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

ZeHuaiWang · Answer 8 · Thu Jul 09 2020 21:38:24 GMT+0800 (China Standard Time)

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

Zack Wu · Answer 9 · Fri Jul 10 2020 10:35:09 GMT+0800 (China Standard Time)

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

ZeHuaiWang · Answer 10 · Fri Jul 10 2020 10:44:59 GMT+0800 (China Standard Time)

@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.

Camila Macedo · Answer 11 · Fri Jul 10 2020 16:42:09 GMT+0800 (China Standard Time)

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.

Eric Stroczynski · Answer 12 · Sat Aug 08 2020 15:46:55 GMT+0800 (China Standard Time)

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

S. Morteza Hashemi · Answer 13 · Wed Sep 30 2020 20:55:37 GMT+0800 (China Standard Time)

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

Camila Macedo · Answer 14 · Mon Oct 26 2020 19:53:31 GMT+0800 (China Standard Time)

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.

Dimitris-Ilias Gkanatsios · Answer 15 · Thu Nov 05 2020 15:30:21 GMT+0800 (China Standard Time)

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!

Eric Stroczynski · Answer 16 · Sat Nov 07 2020 03:15:25 GMT+0800 (China Standard Time)

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

yukon · Answer 17 · Mon Nov 16 2020 15:22:50 GMT+0800 (China Standard Time)

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.

Eric Stroczynski · Answer 18 · Tue Nov 17 2020 01:27:44 GMT+0800 (China Standard Time)

@zhouxinyu see #1544 (comment)

bilalcaliskan · Answer 19 · Sun Nov 29 2020 22:56:15 GMT+0800 (China Standard Time)

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.