rest

package
v0.46.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 1, 2021 License: Apache-2.0 Imports: 40 Imported by: 7

Documentation

Index

Constants

View Source
const (
	NamespaceParamName = "namespace"
	NameParamName      = "name"
)
View Source
const (
	PortParamName     = "port"
	PortPath          = "/{port:[0-9]+}"
	ProtocolParamName = "protocol"
	ProtocolPath      = "/{protocol:tcp|udp}"
)

Variables

This section is empty.

Functions

func ComposeAPIDefinitions added in v0.10.0

func ComposeAPIDefinitions() []*restful.WebService

func GenericResourceProxy

func GenericResourceProxy(ws *restful.WebService, gvr schema.GroupVersionResource, objPointer runtime.Object, objKind string, objListPointer runtime.Object) (*restful.WebService, error)

func GroupBasePath

func GroupBasePath(gvr schema.GroupVersion) string

func GroupVersionBasePath

func GroupVersionBasePath(gvr schema.GroupVersion) string

func GroupVersionProxyBase

func GroupVersionProxyBase(gv schema.GroupVersion) (*restful.WebService, error)

func NameParam

func NameParam(ws *restful.WebService) *restful.Parameter

func NamespaceParam

func NamespaceParam(ws *restful.WebService) *restful.Parameter

func Noop added in v0.10.0

func Noop(_ *restful.Request, _ *restful.Response)

func PortForwardPortParameter added in v0.44.1

func PortForwardPortParameter(ws *restful.WebService) *restful.Parameter

func PortForwardProtocolParameter added in v0.44.1

func PortForwardProtocolParameter(ws *restful.WebService) *restful.Parameter

func ResourceBasePath

func ResourceBasePath(gvr schema.GroupVersionResource) string

func ResourcePath

func ResourcePath(gvr schema.GroupVersionResource) string

func ResourceProxyAutodiscovery

func ResourceProxyAutodiscovery(gvr schema.GroupVersionResource) (*restful.WebService, error)

func SubResourcePath

func SubResourcePath(subResource string) string

Types

type MockVirtApiAuthorizor added in v0.12.0

type MockVirtApiAuthorizor struct {
	// contains filtered or unexported fields
}

Mock of VirtApiAuthorizor interface

func NewMockVirtApiAuthorizor added in v0.12.0

func NewMockVirtApiAuthorizor(ctrl *gomock.Controller) *MockVirtApiAuthorizor

func (*MockVirtApiAuthorizor) AddExtraPrefixHeaders added in v0.12.0

func (_m *MockVirtApiAuthorizor) AddExtraPrefixHeaders(header []string)

func (*MockVirtApiAuthorizor) AddGroupHeaders added in v0.12.0

func (_m *MockVirtApiAuthorizor) AddGroupHeaders(header []string)

func (*MockVirtApiAuthorizor) AddUserHeaders added in v0.12.0

func (_m *MockVirtApiAuthorizor) AddUserHeaders(header []string)

func (*MockVirtApiAuthorizor) Authorize added in v0.12.0

func (_m *MockVirtApiAuthorizor) Authorize(req *go_restful.Request) (bool, string, error)

func (*MockVirtApiAuthorizor) EXPECT added in v0.12.0

func (_m *MockVirtApiAuthorizor) EXPECT() *_MockVirtApiAuthorizorRecorder

func (*MockVirtApiAuthorizor) GetExtraPrefixHeaders added in v0.12.0

func (_m *MockVirtApiAuthorizor) GetExtraPrefixHeaders() []string

func (*MockVirtApiAuthorizor) GetGroupHeaders added in v0.12.0

func (_m *MockVirtApiAuthorizor) GetGroupHeaders() []string

func (*MockVirtApiAuthorizor) GetUserHeaders added in v0.12.0

func (_m *MockVirtApiAuthorizor) GetUserHeaders() []string

type Streamer added in v0.44.1

type Streamer struct {
	// contains filtered or unexported fields
}

func NewRawStreamer added in v0.44.1

func NewRawStreamer(fetch vmiFetcher, validate validator, dial dialer) *Streamer

func NewWebsocketStreamer added in v0.44.1

func NewWebsocketStreamer(fetch vmiFetcher, validate validator, dial dialer) *Streamer

func (*Streamer) Handle added in v0.44.1

func (s *Streamer) Handle(request *restful.Request, response *restful.Response) error

type SubresourceAPIApp added in v0.4.0

type SubresourceAPIApp struct {
	// contains filtered or unexported fields
}

func NewSubresourceAPIApp added in v0.20.0

func NewSubresourceAPIApp(virtCli kubecli.KubevirtClient, consoleServerPort int, tlsConfiguration *tls.Config, clusterConfig *virtconfig.ClusterConfig) *SubresourceAPIApp

func (*SubresourceAPIApp) ConsoleRequestHandler added in v0.4.0

func (app *SubresourceAPIApp) ConsoleRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) DumpClusterProfilerHandler added in v0.46.0

func (app *SubresourceAPIApp) DumpClusterProfilerHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) FetchVirtualMachineInstance added in v0.44.1

func (app *SubresourceAPIApp) FetchVirtualMachineInstance(namespace, name string) (*v1.VirtualMachineInstance, *errors.StatusError)

FetchVirtualMachineInstance by namespace and name

func (*SubresourceAPIApp) FetchVirtualMachineInstanceForVM added in v0.44.1

func (app *SubresourceAPIApp) FetchVirtualMachineInstanceForVM(namespace, name string) (*v1.VirtualMachineInstance, *errors.StatusError)

FetchVirtualMachineInstanceForVM by namespace and name

func (*SubresourceAPIApp) FilesystemList added in v0.28.0

func (app *SubresourceAPIApp) FilesystemList(request *restful.Request, response *restful.Response)

FilesystemList handles the subresource for providing guest filesystem list

func (*SubresourceAPIApp) FreezeVMIRequestHandler added in v0.44.1

func (app *SubresourceAPIApp) FreezeVMIRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) GuestOSInfo added in v0.27.0

func (app *SubresourceAPIApp) GuestOSInfo(request *restful.Request, response *restful.Response)

GuestOSInfo handles the subresource for providing VM guest agent information

func (*SubresourceAPIApp) MigrateVMRequestHandler added in v0.21.0

func (app *SubresourceAPIApp) MigrateVMRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) PauseVMIRequestHandler added in v0.24.0

func (app *SubresourceAPIApp) PauseVMIRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) PortForwardRequestHandler added in v0.44.1

func (app *SubresourceAPIApp) PortForwardRequestHandler(fetcher vmiFetcher) restful.RouteFunction

func (*SubresourceAPIApp) RestartVMRequestHandler added in v0.11.0

func (app *SubresourceAPIApp) RestartVMRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) StartClusterProfilerHandler added in v0.46.0

func (app *SubresourceAPIApp) StartClusterProfilerHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) StartVMRequestHandler added in v0.17.0

func (app *SubresourceAPIApp) StartVMRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) StopClusterProfilerHandler added in v0.46.0

func (app *SubresourceAPIApp) StopClusterProfilerHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) StopVMRequestHandler added in v0.17.0

func (app *SubresourceAPIApp) StopVMRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) USBRedirRequestHandler added in v0.44.1

func (app *SubresourceAPIApp) USBRedirRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) UnfreezeVMIRequestHandler added in v0.44.1

func (app *SubresourceAPIApp) UnfreezeVMIRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) UnpauseVMIRequestHandler added in v0.24.0

func (app *SubresourceAPIApp) UnpauseVMIRequestHandler(request *restful.Request, response *restful.Response)

func (*SubresourceAPIApp) UserList added in v0.28.0

func (app *SubresourceAPIApp) UserList(request *restful.Request, response *restful.Response)

UserList handles the subresource for providing VM guest user list

func (*SubresourceAPIApp) VMAddVolumeRequestHandler added in v0.36.0

func (app *SubresourceAPIApp) VMAddVolumeRequestHandler(request *restful.Request, response *restful.Response)

VMAddVolumeRequestHandler handles the subresource for hot plugging a volume and disk.

func (*SubresourceAPIApp) VMIAddVolumeRequestHandler added in v0.36.0

func (app *SubresourceAPIApp) VMIAddVolumeRequestHandler(request *restful.Request, response *restful.Response)

VMIAddVolumeRequestHandler handles the subresource for hot plugging a volume and disk.

func (*SubresourceAPIApp) VMIRemoveVolumeRequestHandler added in v0.36.0

func (app *SubresourceAPIApp) VMIRemoveVolumeRequestHandler(request *restful.Request, response *restful.Response)

VMIRemoveVolumeRequestHandler handles the subresource for hot plugging a volume and disk.

func (*SubresourceAPIApp) VMRemoveVolumeRequestHandler added in v0.36.0

func (app *SubresourceAPIApp) VMRemoveVolumeRequestHandler(request *restful.Request, response *restful.Response)

VMRemoveVolumeRequestHandler handles the subresource for hot plugging a volume and disk.

func (*SubresourceAPIApp) VNCRequestHandler added in v0.4.0

func (app *SubresourceAPIApp) VNCRequestHandler(request *restful.Request, response *restful.Response)

type URLResolver added in v0.20.0

type VirtApiAuthorizor added in v0.4.0

type VirtApiAuthorizor interface {
	Authorize(req *restful.Request) (bool, string, error)
	AddUserHeaders(header []string)
	GetUserHeaders() []string
	AddGroupHeaders(header []string)
	GetGroupHeaders() []string
	AddExtraPrefixHeaders(header []string)
	GetExtraPrefixHeaders() []string
}

func NewAuthorizor added in v0.4.0

func NewAuthorizor(rateLimiter flowcontrol.RateLimiter) (VirtApiAuthorizor, error)

func NewAuthorizorFromConfig added in v0.4.0

func NewAuthorizorFromConfig(config *restclient.Config) (VirtApiAuthorizor, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL