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.

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

✨ Add OpenAPI Schema support to virtual workspace framework #3059

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

✨ Add OpenAPI Schema support to virtual workspace framework #3059

wants to merge 1 commit into from

Conversation

palnabarun
Copy link
Member

Summary

Add OpenAPI Schema support to virtual workspace framework.

The implementation taps into the CreateServingInfo path to generate the spec and adds a handler to VW apiserver for handling the request and updating the OpenAPI v3 service caches.

TODO: OpenAPI v2 support and structuring the code for merge.

Related issue(s)

None

Release Notes

TODO: Before merge.

@kcp-ci-bot kcp-ci-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. dco-signoff: yes Indicates the PR's author has signed the DCO. labels Dec 12, 2023
@kcp-ci-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign sttts for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@kcp-ci-bot kcp-ci-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 12, 2023
@kcp-ci-bot
Copy link
Contributor

Hi @palnabarun. Thanks for your PR.

I'm waiting for a kcp-dev member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@palnabarun palnabarun force-pushed the vw-openapi branch 2 times, most recently from 9e78baa to 07deb4f Compare December 12, 2023 13:27
sttts
sttts reviewed Dec 12, 2023
View reviewed changes
pkg/virtual/framework/dynamic/apiserver/discovery.go
for gvr, apiDefinition := range apiSet {
if group == "" || (group != "" && group == gvr.Group) {
spec := apiDefinition.GetOpenAPIV3Spec()
h.openAPIV3Service.UpdateGroupVersion(gvr.Group, spec)
Copy link
Member

Choose a reason for hiding this comment

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

is this synchronous?

Copy link
Member Author

Choose a reason for hiding this comment

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

It lazily updates the cache, IIUC.

@sttts
Copy link
Member

sttts commented Dec 12, 2023

Can you add an e2e test? Am interested to see the schema for exported and claimed resources (both APIResourceSchemas and native resources) of an APIExport.

@mjudeikis mjudeikis changed the title 📝 Add OpenAPI Schema support to virtual workspace framework ✨ Add OpenAPI Schema support to virtual workspace framework Dec 13, 2023
@palnabarun
Copy link
Member Author

Can you add an e2e test? Am interested to see the schema for exported and claimed resources (both APIResourceSchemas and native resources) of an APIExport.

@sttts Sure. I will explore the tests. Can you also add the ok-to-test label so that the usual tests run on the PR?

@sttts
Copy link
Member

sttts commented Dec 14, 2023

/ok-to-test

@kcp-ci-bot kcp-ci-bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 14, 2023
@mjudeikis mjudeikis added this to the 1.30-rebase milestone Jan 23, 2024
@xrstf
Copy link
Contributor

xrstf commented Apr 8, 2024

I think I might need this. I'm trying to implement a virtual workspace using the fixedgvs abstraction, but it keeps blowing up with "OpenAPIV3 config must not be nil".

sttts
sttts reviewed Apr 11, 2024
View reviewed changes
pkg/virtual/framework/dynamic/apiserver/discovery.go
@@ -330,3 +332,86 @@ func sortGroupDiscoveryByKubeAwareVersion(gd []metav1.GroupVersionForDiscovery)
return version.CompareKubeAwareVersionStrings(gd[i].Version, gd[j].Version) > 0
})
}

type openAPIHandler struct {
Copy link
Member

Choose a reason for hiding this comment

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

can you describe on the high level how this handler gets a v3 schema for the right resources?

Copy link
Member

Choose a reason for hiding this comment

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

go doc I mean

sttts
sttts reviewed Apr 11, 2024
View reviewed changes
pkg/virtual/framework/dynamic/apiserver/discovery.go
w, r)
}

h.openAPIV3Service.HandleGroupVersion(w, r)
Copy link
Member

Choose a reason for hiding this comment

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

If I am not mistaken, die service is not workspace and binding aware.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sttts sttts sttts left review comments

Assignees
No one assigned
Labels
dco-signoff: yes Indicates the PR's author has signed the DCO. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
1.30-rebase
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@palnabarun @kcp-ci-bot @sttts @xrstf @mjudeikis