fixedgvs

Documentation

Overview

Package fixedgvs provides the types (and underlying implementation) required to build virtual workspaces which allow adding well-defined APIs in a limited number of group/versions, implemented as Rest storages.

Index

• type FixedGroupVersionsVirtualWorkspace
  • func (vw *FixedGroupVersionsVirtualWorkspace) GetName() string
  • func (vw *FixedGroupVersionsVirtualWorkspace) IsReady() error
  • func (vw *FixedGroupVersionsVirtualWorkspace) Register(rootAPIServerConfig genericapiserver.CompletedConfig, ...) (genericapiserver.DelegationTarget, error)
  • func (vw *FixedGroupVersionsVirtualWorkspace) ResolveRootPath(urlPath string, context context.Context) (accepted bool, prefixToStrip string, completedContext context.Context)
• type GroupVersionAPISet
• type RestStorageBuilder

Types

type FixedGroupVersionsVirtualWorkspace

type FixedGroupVersionsVirtualWorkspace struct {
	Name                string
	RootPathResolver    framework.RootPathResolverFunc
	Ready               framework.ReadyFunc
	GroupVersionAPISets []GroupVersionAPISet
}

FixedGroupVersionsVirtualWorkspace is an implementation of the VirtualWorkspace interface, which allows adding well-defined APIs in a limited number of group/versions, implemented as Rest storages.

func (*FixedGroupVersionsVirtualWorkspace) GetName

func (vw *FixedGroupVersionsVirtualWorkspace) GetName() string

func (*FixedGroupVersionsVirtualWorkspace) IsReady

func (vw *FixedGroupVersionsVirtualWorkspace) IsReady() error

func (*FixedGroupVersionsVirtualWorkspace) Register

func (vw *FixedGroupVersionsVirtualWorkspace) Register(rootAPIServerConfig genericapiserver.CompletedConfig, delegateAPIServer genericapiserver.DelegationTarget) (genericapiserver.DelegationTarget, error)

func (*FixedGroupVersionsVirtualWorkspace) ResolveRootPath

func (vw *FixedGroupVersionsVirtualWorkspace) ResolveRootPath(urlPath string, context context.Context) (accepted bool, prefixToStrip string, completedContext context.Context)

type GroupVersionAPISet

type GroupVersionAPISet struct {
	GroupVersion schema.GroupVersion

	// AddToScheme adds the additional schemes required to register the REST storages
	AddToScheme func(*runtime.Scheme) error

	// OpenAPIDefinitions contains the OpenAPI v2 definitions of resources provided by the REST storages
	OpenAPIDefinitions openapicommon.GetOpenAPIDefinitions

	// BootstrapRestResources bootstraps the various Rest storage builders (one for each REST resource name),
	// that will be later registered in dedicated delegated APIServer by the framework.
	// This bootstrapping may include creating active objects like controllers,
	// adding poststart hooks into the rootAPIServerConfig, etc ...
	BootstrapRestResources func(rootAPIServerConfig genericapiserver.CompletedConfig) (map[string]RestStorageBuilder, error)
}

GroupVersionAPISet describes the set of APIs that should be added in a given group/version. This allows specifying the logic that should build related REST storages, as well as the additional schemes required to register the REST storages.

type RestStorageBuilder

type RestStorageBuilder func(apiGroupAPIServerConfig genericapiserver.CompletedConfig) (restStorage.Storage, error)

RestStorageBuilder is a function that builds a REST Storage based on the config of the dedicated delegated APIServer is will be created on.