cmicommon

Documentation

Index

• func ParseEndpoint(ep string) (string, string, error)
• type DefaultIdentityServer
  • func NewDefaultIdentityServer(plugin *DefaultPlugin) *DefaultIdentityServer
  • func (ids *DefaultIdentityServer) GetPluginCapabilities(ctx context.Context, req *cmi.GetPluginCapabilitiesRequest) (*cmi.GetPluginCapabilitiesResponse, error)
  • func (ids *DefaultIdentityServer) GetPluginInfo(ctx context.Context, req *cmi.GetPluginInfoRequest) (*cmi.GetPluginInfoResponse, error)
  • func (ids *DefaultIdentityServer) Probe(ctx context.Context, req *cmi.ProbeRequest) (*cmi.ProbeResponse, error)
• type DefaultMachineServer
  • func NewDefaultMachineServer(d *DefaultPlugin) *DefaultMachineServer
  • func (ms *DefaultMachineServer) CreateMachine(ctx context.Context, req *cmi.CreateMachineRequest) (*cmi.CreateMachineResponse, error)
  • func (ms *DefaultMachineServer) DeleteMachine(ctx context.Context, req *cmi.DeleteMachineRequest) (*cmi.DeleteMachineResponse, error)
  • func (ms *DefaultMachineServer) GetMachineStatus(ctx context.Context, req *cmi.GetMachineStatusRequest) (*cmi.GetMachineStatusResponse, error)
  • func (ms *DefaultMachineServer) GetVolumeIDs(ctx context.Context, req *cmi.GetVolumeIDsRequest) (*cmi.GetVolumeIDsResponse, error)
  • func (ms *DefaultMachineServer) ListMachines(ctx context.Context, req *cmi.ListMachinesRequest) (*cmi.ListMachinesResponse, error)
  • func (ms *DefaultMachineServer) ShutDownMachine(ctx context.Context, req *cmi.ShutDownMachineRequest) (*cmi.ShutDownMachineResponse, error)
• type DefaultPlugin
  • func NewDefaultPlugin(name string, v string) *DefaultPlugin
• type NonBlockingGRPCServer
  • func NewNonBlockingGRPCServer() NonBlockingGRPCServer

Functions

func ParseEndpoint

func ParseEndpoint(ep string) (string, string, error)

ParseEndpoint parses the given endpoint string into the protocol and address

Types

type DefaultIdentityServer

type DefaultIdentityServer struct {
	Plugin *DefaultPlugin
}

DefaultIdentityServer contains the server identity Implements the cmi.IdentityServer

func NewDefaultIdentityServer

func NewDefaultIdentityServer(plugin *DefaultPlugin) *DefaultIdentityServer

NewDefaultIdentityServer returns the default Identity server object

func (*DefaultIdentityServer) GetPluginCapabilities

func (ids *DefaultIdentityServer) GetPluginCapabilities(ctx context.Context, req *cmi.GetPluginCapabilitiesRequest) (*cmi.GetPluginCapabilitiesResponse, error)

GetPluginCapabilities gets capabilities of the plugin

func (*DefaultIdentityServer) GetPluginInfo

func (ids *DefaultIdentityServer) GetPluginInfo(ctx context.Context, req *cmi.GetPluginInfoRequest) (*cmi.GetPluginInfoResponse, error)

GetPluginInfo returns the Server details

func (*DefaultIdentityServer) Probe

func (ids *DefaultIdentityServer) Probe(ctx context.Context, req *cmi.ProbeRequest) (*cmi.ProbeResponse, error)

Probe tries to probe the server and returns a response

type DefaultMachineServer

type DefaultMachineServer struct{}

DefaultMachineServer contains the machine server info It implements the cmi.MachineClient interface

func NewDefaultMachineServer

func NewDefaultMachineServer(d *DefaultPlugin) *DefaultMachineServer

NewDefaultMachineServer returns a default machine server object

func (*DefaultMachineServer) CreateMachine

func (ms *DefaultMachineServer) CreateMachine(ctx context.Context, req *cmi.CreateMachineRequest) (*cmi.CreateMachineResponse, error)

CreateMachine method handles default machine creation request

func (*DefaultMachineServer) DeleteMachine

func (ms *DefaultMachineServer) DeleteMachine(ctx context.Context, req *cmi.DeleteMachineRequest) (*cmi.DeleteMachineResponse, error)

DeleteMachine method handles default machine deletion request

func (*DefaultMachineServer) GetMachineStatus

func (ms *DefaultMachineServer) GetMachineStatus(ctx context.Context, req *cmi.GetMachineStatusRequest) (*cmi.GetMachineStatusResponse, error)

GetMachineStatus method handles default machine get request

func (*DefaultMachineServer) GetVolumeIDs

func (ms *DefaultMachineServer) GetVolumeIDs(ctx context.Context, req *cmi.GetVolumeIDsRequest) (*cmi.GetVolumeIDsResponse, error)

GetVolumeIDs method handles default getPVIDs request

func (*DefaultMachineServer) ListMachines

func (ms *DefaultMachineServer) ListMachines(ctx context.Context, req *cmi.ListMachinesRequest) (*cmi.ListMachinesResponse, error)

ListMachines method handles default machines list request

func (*DefaultMachineServer) ShutDownMachine

func (ms *DefaultMachineServer) ShutDownMachine(ctx context.Context, req *cmi.ShutDownMachineRequest) (*cmi.ShutDownMachineResponse, error)

ShutDownMachine method handles default machines shutdown request

type DefaultPlugin

type DefaultPlugin struct {
	Name    string
	Version string
}

DefaultPlugin object is used to store the plugin details

func NewDefaultPlugin

func NewDefaultPlugin(name string, v string) *DefaultPlugin

NewDefaultPlugin creates a new DefaultPlugin object and returns the same

type NonBlockingGRPCServer

type NonBlockingGRPCServer interface {
	// Start services at the endpoint
	Start(endpoint string, ids cmi.IdentityServer, ms cmi.MachineServer)
	// Waits for the service to stop
	Wait()
	// Stops the service gracefully
	Stop()
	// Stops the service forcefully
	ForceStop()
}

NonBlockingGRPCServer defines Non blocking GRPC server interfaces

func NewNonBlockingGRPCServer

func NewNonBlockingGRPCServer() NonBlockingGRPCServer

NewNonBlockingGRPCServer returns an empty NonBlockingGRPCServer