⚠️ Add MaxItems markers to API fields #11934
Conversation
Signed-off-by: Stefan Büringer [email protected]
k8s-ci-robot
added
cncf-cla: yes
k8s-ci-robot
added
the
size/M
|
/assign @fabriziopandini @chrischdi @JoelSpeed PTAL and let me know if you have concerns if some of these values are too low and I'm happy to increase them. |
| - path: "api/v1beta1/*" | ||
| text: "must have a maximum length, add (kubebuilder:validation:MaxLength|kubebuilder:validation:items:MaxLength) marker" | ||
| linters: | ||
| - kal |
There was a problem hiding this comment.
Will be removed via the next PRs
There was a problem hiding this comment.
It may be interesting to try and inspect the maximum estimated size of each of these types based on the maximum request size, if you wanted to try, we do something similar in this snippet. The manual way to do it is to work out the minimum serialized size of the object and divide that into 3MiB.
|
@JoelSpeed @fabriziopandini @chrischdi Thx for the reviews. PTAL :) |
sbueringer
force-pushed
the
pr-add-max-items
branch
from
9b51b88 to
4bc5347
Compare
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 8482e2aff2e20034db0dcdddeffd8778499123f5
|
|
/approve for @JoelSpeed and @chrischdi to take another look (@sbueringer feel free to unhold if we can get additional finding fixed in a follow up) |
k8s-ci-robot
added
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fabriziopandini The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
Alrighty. Thx. I'll merge this one already. If there any further findings please let me know and I'll follow-up. Or feel free to comment on #11949 I added markers to mostly the same fields as I did on this PR here |
|
/hold cancel |
k8s-ci-robot
removed
the
do-not-merge/hold
Signed-off-by: Stefan Büringer [email protected]
What this PR does / why we need it:
This PR only enables the KAL linter for
kubebuilder:validation:MaxItems. There will be other PRs for similar markers soon.I tried to find a good trade-off between setting some reasonable upper bounds and restricting us too much, e.g. the API fields should not limit the number of MDs or Machines we can support per Cluster.
I also tried to pick similar values for similar fields and also to use only a small set of different values to make this all a bit easier.
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Part of #11834