metadata.annotations: Too long: must have at most 262144 bytes

[ka-keung]

What broke? What's expected?

clone this project on the machine, an go to dir docs/book/src/multiversion-tutorial/testdata/project . make install deploy; then this error appear

 make install deploy
/var/tmp/kubebuilder-master/docs/book/src/multiversion-tutorial/testdata/project/bin/controller-gen rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
/var/tmp/kubebuilder-master/docs/book/src/multiversion-tutorial/testdata/project/bin/kustomize build config/crd | kubectl apply -f -
The CustomResourceDefinition "cronjobs.batch.tutorial.kubebuilder.io" is invalid: metadata.annotations: Too long: must have at most 262144 bytes
make: *** [install] Error 1

Reproducing this issue

No response

KubeBuilder (CLI) Version

3.3.0

PROJECT version

3

Plugin versions

No response

Other versions

k8s: v1.21.9
go: 1.16.2
kustomize: v4.5.2
centos: 3.10.0-693.el7.x86_64

Extra Labels

No response

[camilamacedo86]

hI @ka-keung,

It shows that you added an metadata.annotations which is bigger than the value supported by K8s API. Not sure how it could be solved via these project KB (which is a CLI to scaffolds the project ) or controller-gen (which will help scaffolds the manifest).

[ka-keung]

hI @ka-keung,

It shows that you added an metadata.annotations which is bigger than the value supported by K8s API. Not sure how it could be solved via these project KB (which is a CLI to scaffolds the project ) or controller-gen (which will help scaffolds the manifest).

@camilamacedo86 i had't do nothing but clone this repository and go to the dir docs/book/src/multiversion-tutorial/testdata/project run make install deploy

[camilamacedo86]

Could you please test with go: 1.17+ < 1.18 just for we ensure that is not related?
Also, the kustomize: v4.5.2 is not the version scaffold on it (https://github.com/kubernetes-sigs/kubebuilder/blob/master/testdata/project-v3/Makefile#L116) and from v3 to v4 it has breaking changes

See:

• https://book.kubebuilder.io/quick-start.html#versions-and-supportability

[ka-keung]

hi @camilamacedo86

try again with version:

go: v1.17.8
kustomize: 3.8.7
controller-gen: v0.8.0

same result~.

my step:

git clone https://github.com/kubernetes-sigs/kubebuilder.git
cd kubebuilder/docs/book/src/multiversion-tutorial/testdata/project
make install

[ka-keung]

Could you please test with go: 1.17+ < 1.18 just for we ensure that is not related? Also, the kustomize: v4.5.2 is not the version scaffold on it (https://github.com/kubernetes-sigs/kubebuilder/blob/master/testdata/project-v3/Makefile#L116) and from v3 to v4 it has breaking changes

See:

• https://book.kubebuilder.io/quick-start.html#versions-and-supportability

1. CRD_OPTIONS ?= "crd:maxDescLen=0" in Makefile not work. that's why
2. modify Makefile manifests target . change crd => crd:maxDescLen=0 ; then make install; it solved

.PHONY: manifests
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
	$(CONTROLLER_GEN) rbac:roleName=manager-role crd:maxDescLen=0 webhook paths="./..." output:crd:artifacts:config=config/crd/bases

[camilamacedo86]

So, we need to check here:

• why the description is too long in the book sample? Is it because we are adding comments for the docs and those are going to the manifests?
• Can we fix it without removing the info from the docs? if not, then we might be able to just update the sample with the workaround found and a comment on top explaining why the crd:maxDescLen=0 was added.

WDYT? @ka-keung would you like to help on this one?
Would you like to help us solve this issue?

[ka-keung]

thankyou for your answer. i also would like to improve this project , but now . i need more deep learn to find out what happend in those action @camilamacedo86

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten