Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃悰 ClusterClass variable schema: drop multipleOf, change min/max to *int64 #5494

Merged

Conversation

sbueringer
Copy link
Member

@sbueringer sbueringer commented Oct 25, 2021

Signed-off-by: Stefan B眉ringer buringerst@vmware.com

What this PR does / why we need it:
This PR changes min/max fields to *int64 and drops multipleOf entirely (as it's not that useful).

I though I had tested json.Number entirely, but I forgot a use case. When using the structs on client-side and sending a json.Number to the server it is marshaled as follows:

  • 1.5, "1.5" => 1.5
  • 1, "1" => 1
    This does not match the OpenAPI schema validation of string or even "int or string". So we cannot use json.Number as the marshaling behavior is not what we want.

Using float64 is not recommended:

found float, the usage of which is highly discouraged, as support for them varies across languages. Please consider serializing your float as string instead. If you are really sure you want to use them, re-run with crd:allowDangerousTypes=true
Error: not all generators ran successfully

So we could use IntOrString (floats would have to be serialized as strings), but let's start with int64 for now as that covers the most use cases. If we want to support floats later on we can tackle that later, although it's not 100% a compatible change to change the field from int64 to intorstring ("Going from int->intorstring is a ~compatible change from API schema perspective, not from code").

xref: lenghty Slack thread discussing the options / prototyping: https://kubernetes.slack.com/archives/C8TSNPY4T/p1635175756089200

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Signed-off-by: Stefan B眉ringer buringerst@vmware.com
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 25, 2021
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 25, 2021
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 25, 2021
@k8s-ci-robot
Copy link
Contributor

@sbueringer: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-cluster-api-apidiff-main 86f58e4 link false /test pull-cluster-api-apidiff-main

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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/test-infra repository. I understand the commands that are listed here.

@sbueringer sbueringer changed the title ClusterClass variable schema: drop multipleOf, change min/max to *int64 馃悰 ClusterClass variable schema: drop multipleOf, change min/max to *int64 Oct 25, 2021
@sbueringer
Copy link
Member Author

/cc @fabriziopandini @randomvariable

Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@vincepri
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 25, 2021
@k8s-ci-robot k8s-ci-robot merged commit e0f4b6f into kubernetes-sigs:main Oct 25, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.1 milestone Oct 25, 2021
@sbueringer sbueringer deleted the pr-change-minmax-to-int branch October 25, 2021 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants