Skip to content

✨ Add OpenAPI v3 schema support to the Virtual Workspace framework #3246

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

Merged
merged 9 commits into from
Feb 22, 2025
Merged

✨ Add OpenAPI v3 schema support to the Virtual Workspace framework #3246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1fc3045
Add OpenAPI Schema support to virtual workspace framework
palnabarun Nov 22, 2023
dc020d8
Implement initial OpenAPI v3 support for virtual workspaces
xmudrii Jan 27, 2025
8db4f33
Implement basic caching and logging
xmudrii Feb 6, 2025
ecc49cf
Add E2E test for virtual workspace-aware OpenAPI support
xmudrii Feb 11, 2025
01f9647
Improve virtual workspace-aware OpenAPI caching
xmudrii Feb 11, 2025
7b6a5bf
Address review comments
xmudrii Feb 11, 2025
5edaf95
Address review comments (part 2)
xmudrii Feb 11, 2025
3a50095
Test retry in OpenAPI test
xmudrii Feb 12, 2025
c7363bd
Address remaining review comments
xmudrii Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions pkg/virtual/framework/dynamic/apiserver/apiserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ import (
"k8s.io/apimachinery/pkg/runtime/serializer"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apiserver/pkg/endpoints/discovery"
openapinamer "k8s.io/apiserver/pkg/endpoints/openapi"
genericapiserver "k8s.io/apiserver/pkg/server"
"k8s.io/apiserver/pkg/util/openapi"
generatedopenapi "k8s.io/kubernetes/pkg/generated/openapi"

virtualcontext "github.com/kcp-dev/kcp/pkg/virtual/framework/context"
"github.com/kcp-dev/kcp/pkg/virtual/framework/dynamic/apidefinition"
Expand Down Expand Up @@ -177,14 +180,21 @@ func (c completedConfig) New(virtualWorkspaceName string, delegationTarget gener

s.GenericAPIServer.Handler.GoRestfulContainer.Add(discovery.NewLegacyRootAPIHandler(c.GenericConfig.DiscoveryAddresses, s.GenericAPIServer.Serializer, "/api").WebService())

if !c.GenericConfig.SkipOpenAPIInstallation {
getOpenAPIDefinitions := openapi.GetOpenAPIDefinitionsWithoutDisabledFeatures(generatedopenapi.GetOpenAPIDefinitions)
namer := openapinamer.NewDefinitionNamer(scheme)
openapiv3Config := genericapiserver.DefaultOpenAPIV3Config(getOpenAPIDefinitions, namer)
openapiv3Config.Info.Title = "Kubernetes"

openAPIHandler := newOpenAPIHandler(s.APISetRetriever, s.GenericAPIServer.Handler.GoRestfulContainer, openapiv3Config, DefaultServiceCacheSize, delegateHandler)

s.GenericAPIServer.Handler.NonGoRestfulMux.Handle("/openapi", openAPIHandler)
s.GenericAPIServer.Handler.NonGoRestfulMux.HandlePrefix("/openapi/", openAPIHandler)
}

s.GenericAPIServer.Handler.NonGoRestfulMux.Handle("/apis", crdHandler)
s.GenericAPIServer.Handler.NonGoRestfulMux.HandlePrefix("/apis/", crdHandler)
s.GenericAPIServer.Handler.NonGoRestfulMux.Handle("/api/v1", crdHandler)
s.GenericAPIServer.Handler.NonGoRestfulMux.HandlePrefix("/api/v1/", crdHandler)

// TODO(david): plug OpenAPI if necessary. For now, according to the various virtual workspace use-cases,
// it doesn't seem necessary.
// Of course this requires using the --validate=false argument with some kubectl command like kubectl apply.

return s, nil
}
Loading