Skip to content

Feature: Allow to pass selectableFields for CRD definition #1605

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Oct 17, 2024
Merged

Feature: Allow to pass selectableFields for CRD definition #1605

merged 5 commits into from
Oct 17, 2024

Conversation

Danil-Grigorev
Copy link
Member

@Danil-Grigorev Danil-Grigorev commented Oct 15, 2024 •
edited
Loading

Motivation

KEP 4358 allows to define new field - selectableFields within the CRD schema, enabled by default (beta) in 1.31.

Solution

Expose the selectable key in kube() macro, allowing to provide a set of values into generated CRD.

Example:

#[kube(
    group = "clux.dev",
    version = "v1",
    kind = "Foo",
    namespaced,
    selectable = "spec.key",
    selectable = "spec.name"
)]

@Danil-Grigorev
Allow to pass selectableFields for CRD definition
8d533b3 
Signed-off-by: Danil-Grigorev <danil.grigorev@suse.com>
@clux clux added the changelog-add changelog added category for prs label Oct 15, 2024
@clux clux added this to the 0.97.0 milestone Oct 15, 2024
@Danil-Grigorev
Make selectableFields key optional to permit pre 1.30 clusters
aecf47e 
Signed-off-by: Danil-Grigorev <danil.grigorev@suse.com>
@codecov Codecov
Copy link

codecov bot commented Oct 15, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.2%. Comparing base (95cf702) to head (9ed7f88).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##            main   #1605     +/-   ##
=======================================
+ Coverage   75.2%   75.2%   +0.1%     
=======================================
  Files         82      82             
  Lines       7335    7342      +7     
=======================================
+ Hits        5514    5521      +7     
  Misses      1821    1821
Files with missing lines Coverage Δ
kube-derive/src/custom_resource.rs 81.2% <100.0%> (+0.8%) ⬆️
kube-derive/src/lib.rs 0.0% <ø> (ø)
kube-derive/tests/crd_schema_test.rs 96.9% <ø> (ø)

clux
clux reviewed Oct 15, 2024
View reviewed changes
clux
clux reviewed Oct 15, 2024
View reviewed changes
Copy link
Member

@clux clux left a comment

Choose a reason for hiding this comment

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

Looks great. Nice KEP also, had missed this! Maybe add a quick markdown header for it in the lib.rs file so people can discover it?

@clux clux mentioned this pull request Oct 15, 2024
Open
@Danil-Grigorev
Make it selectable
879bf16 
Signed-off-by: Danil-Grigorev <danil.grigorev@suse.com>
@Danil-Grigorev
Mention selectable in the lib.rs
bc59b8f 
Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>
clux
clux reviewed Oct 15, 2024
View reviewed changes
@Danil-Grigorev
Add a detail about version limitation for using selectableFields
9ed7f88 
Signed-off-by: Danil-Grigorev <danil.grigorev@suse.com>
@Danil-Grigorev Danil-Grigorev force-pushed the selectable-fields-support branch from 705e04c to 9ed7f88 Compare October 16, 2024 15:57
@Danil-Grigorev
Copy link
Member Author

Looks like CI failures are unrelated to the PR.

clux
clux reviewed Oct 16, 2024
View reviewed changes
@clux
Copy link
Member

clux commented Oct 16, 2024

Looks like CI failures are unrelated to the PR.

indeed. dunno what's up with the rustls build atm. C library type errors :|

@clux clux merged commit 9dd62b9 into kube-rs:main Oct 17, 2024
17 checks passed
@aviramha
Copy link
Contributor

I think this breaks the Kubernetes version guarantee - requires openapi to upgraded to 1.31 to compile kube-rs as a dependency. @clux

@clux
Copy link
Member

clux commented Oct 18, 2024

oops, good spot. we need to version gate it!

@aviramha
Copy link
Contributor

can we rollback this until it's version gate? can't build main as dependency :(
also, perhaps the dev requirement should adhere to the policy so we can guarantee better?

@Danil-Grigorev
Copy link
Member Author

It should not break CRD generation for pre 1.31 clusters if the selectable is not specified @aviramha

@aviramha
Copy link
Contributor

It should not break CRD generation for pre 1.31 clusters if the selectable is not specified @aviramha

I think there's some ambiguity whether the MK8SV is runtime or compilation, in my case, if we use "earliest" on k8s open api we can't compile this commit.

@Danil-Grigorev
Copy link
Member Author

Ah, I suppose I see where your problem is https://github.com/kube-rs/kube/pull/1605/files#diff-6750cfa2314830da21402810282fd1a9a9f270c217c393e03a2c04e1b2735d10R450, makes sense.

@clux
Copy link
Member

clux commented Oct 18, 2024

i think you can use a https://docs.rs/k8s-openapi/latest/k8s_openapi/macro.k8s_if_ge_1_30.html around an if that factors out the fields: Vec... ^

@aviramha: a bit off-topic, but is there any reason you don't use latest? you generally don't lose anything by going newer.

@aviramha
Copy link
Contributor

i think you can use a https://docs.rs/k8s-openapi/latest/k8s_openapi/macro.k8s_if_ge_1_30.html around an if that factors out the fields: Vec... ^

@aviramha: a bit off-topic, but is there any reason you don't use latest? you generally don't lose anything by going newer.

It's pretty much the first dependency we added, and earliest felt safest. I think it still makes sense, so devs won't try to use API that isn't compatible with older clusters by accident.

@Danil-Grigorev
Copy link
Member Author

Thanks for the pointer @clux, was about to ask how the version gating done elsewhere, will prepare a PR in a moment :)

@clux
Copy link
Member

clux commented Oct 18, 2024

also had a quick look, i think this will do it: #1609

@Danil-Grigorev Danil-Grigorev mentioned this pull request Oct 18, 2024
Merged
@aviramha aviramha mentioned this pull request Oct 18, 2024
Open
@clux clux mentioned this pull request Nov 19, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@clux clux clux approved these changes

Assignees
No one assigned
Labels
changelog-add changelog added category for prs
Projects
None yet
Milestone
0.97.0
Development

Successfully merging this pull request may close these issues.
3 participants
@Danil-Grigorev @clux @aviramha