pluginregistration

package
v0.26.15 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// CSIPlugin identifier for registered CSI plugins
	CSIPlugin = "CSIPlugin"
	// DevicePlugin identifier for registered device plugins
	DevicePlugin = "DevicePlugin"
)

Variables

View Source 
var (
	ErrInvalidLengthApi        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowApi          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupApi = fmt.Errorf("proto: unexpected end of group")
)

Functions

func RegisterRegistrationServer 

func RegisterRegistrationServer(s *grpc.Server, srv RegistrationServer)

Types

type InfoRequest 

type InfoRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

InfoRequest is the empty request message from Kubelet

func (*InfoRequest) Descriptor 

func (*InfoRequest) Descriptor() ([]byte, []int)

func (*InfoRequest) Marshal 

func (m *InfoRequest) Marshal() (dAtA []byte, err error)

func (*InfoRequest) MarshalTo 

func (m *InfoRequest) MarshalTo(dAtA []byte) (int, error)

func (*InfoRequest) MarshalToSizedBuffer 

func (m *InfoRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*InfoRequest) ProtoMessage 

func (*InfoRequest) ProtoMessage()

func (*InfoRequest) Reset 

func (m *InfoRequest) Reset()

func (*InfoRequest) Size 

func (m *InfoRequest) Size() (n int)

func (*InfoRequest) String 

func (this *InfoRequest) String() string

func (*InfoRequest) Unmarshal 

func (m *InfoRequest) Unmarshal(dAtA []byte) error

func (*InfoRequest) XXX_DiscardUnknown 

func (m *InfoRequest) XXX_DiscardUnknown()

func (*InfoRequest) XXX_Marshal 

func (m *InfoRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InfoRequest) XXX_Merge 

func (m *InfoRequest) XXX_Merge(src proto.Message)

func (*InfoRequest) XXX_Size 

func (m *InfoRequest) XXX_Size() int

func (*InfoRequest) XXX_Unmarshal 

func (m *InfoRequest) XXX_Unmarshal(b []byte) error

type PluginInfo 

type PluginInfo struct {
	// Type of the Plugin. CSIPlugin or DevicePlugin
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Plugin name that uniquely identifies the plugin for the given plugin type.
	// For DevicePlugin, this is the resource name that the plugin manages and
	// should follow the extended resource name convention.
	// For CSI, this is the CSI driver registrar name.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Optional endpoint location. If found set by Kubelet component,
	// Kubelet component will use this endpoint for specific requests.
	// This allows the plugin to register using one endpoint and possibly use
	// a different socket for control operations. CSI uses this model to delegate
	// its registration external from the plugin.
	Endpoint string `protobuf:"bytes,3,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Plugin service API versions the plugin supports.
	// For DevicePlugin, this maps to the deviceplugin API versions the
	// plugin supports at the given socket.
	// The Kubelet component communicating with the plugin should be able
	// to choose any preferred version from this list, or returns an error
	// if none of the listed versions is supported.
	SupportedVersions    []string `protobuf:"bytes,4,rep,name=supported_versions,json=supportedVersions,proto3" json:"supported_versions,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

PluginInfo is the message sent from a plugin to the Kubelet pluginwatcher for plugin registration

func (*PluginInfo) Descriptor 

func (*PluginInfo) Descriptor() ([]byte, []int)

func (*PluginInfo) GetEndpoint 

func (m *PluginInfo) GetEndpoint() string

func (*PluginInfo) GetName 

func (m *PluginInfo) GetName() string

func (*PluginInfo) GetSupportedVersions 

func (m *PluginInfo) GetSupportedVersions() []string

func (*PluginInfo) GetType 

func (m *PluginInfo) GetType() string

func (*PluginInfo) Marshal 

func (m *PluginInfo) Marshal() (dAtA []byte, err error)

func (*PluginInfo) MarshalTo 

func (m *PluginInfo) MarshalTo(dAtA []byte) (int, error)

func (*PluginInfo) MarshalToSizedBuffer 

func (m *PluginInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PluginInfo) ProtoMessage 

func (*PluginInfo) ProtoMessage()

func (*PluginInfo) Reset 

func (m *PluginInfo) Reset()

func (*PluginInfo) Size 

func (m *PluginInfo) Size() (n int)

func (*PluginInfo) String 

func (this *PluginInfo) String() string

func (*PluginInfo) Unmarshal 

func (m *PluginInfo) Unmarshal(dAtA []byte) error

func (*PluginInfo) XXX_DiscardUnknown 

func (m *PluginInfo) XXX_DiscardUnknown()

func (*PluginInfo) XXX_Marshal 

func (m *PluginInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PluginInfo) XXX_Merge 

func (m *PluginInfo) XXX_Merge(src proto.Message)

func (*PluginInfo) XXX_Size 

func (m *PluginInfo) XXX_Size() int

func (*PluginInfo) XXX_Unmarshal 

func (m *PluginInfo) XXX_Unmarshal(b []byte) error

type RegistrationClient 

type RegistrationClient interface {
	GetInfo(ctx context.Context, in *InfoRequest, opts ...grpc.CallOption) (*PluginInfo, error)
	NotifyRegistrationStatus(ctx context.Context, in *RegistrationStatus, opts ...grpc.CallOption) (*RegistrationStatusResponse, error)
}

RegistrationClient is the client API for Registration service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewRegistrationClient 

func NewRegistrationClient(cc *grpc.ClientConn) RegistrationClient

type RegistrationServer 

type RegistrationServer interface {
	GetInfo(context.Context, *InfoRequest) (*PluginInfo, error)
	NotifyRegistrationStatus(context.Context, *RegistrationStatus) (*RegistrationStatusResponse, error)
}

RegistrationServer is the server API for Registration service.

type RegistrationStatus 

type RegistrationStatus struct {
	// True if plugin gets registered successfully at Kubelet
	PluginRegistered bool `protobuf:"varint,1,opt,name=plugin_registered,json=pluginRegistered,proto3" json:"plugin_registered,omitempty"`
	// Error message in case plugin fails to register, empty string otherwise
	Error                string   `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

RegistrationStatus is the message sent from Kubelet pluginwatcher to the plugin for notification on registration status

func (*RegistrationStatus) Descriptor 

func (*RegistrationStatus) Descriptor() ([]byte, []int)

func (*RegistrationStatus) GetError 

func (m *RegistrationStatus) GetError() string

func (*RegistrationStatus) GetPluginRegistered 

func (m *RegistrationStatus) GetPluginRegistered() bool

func (*RegistrationStatus) Marshal 

func (m *RegistrationStatus) Marshal() (dAtA []byte, err error)

func (*RegistrationStatus) MarshalTo 

func (m *RegistrationStatus) MarshalTo(dAtA []byte) (int, error)

func (*RegistrationStatus) MarshalToSizedBuffer 

func (m *RegistrationStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RegistrationStatus) ProtoMessage 

func (*RegistrationStatus) ProtoMessage()

func (*RegistrationStatus) Reset 

func (m *RegistrationStatus) Reset()

func (*RegistrationStatus) Size 

func (m *RegistrationStatus) Size() (n int)

func (*RegistrationStatus) String 

func (this *RegistrationStatus) String() string

func (*RegistrationStatus) Unmarshal 

func (m *RegistrationStatus) Unmarshal(dAtA []byte) error

func (*RegistrationStatus) XXX_DiscardUnknown 

func (m *RegistrationStatus) XXX_DiscardUnknown()

func (*RegistrationStatus) XXX_Marshal 

func (m *RegistrationStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RegistrationStatus) XXX_Merge 

func (m *RegistrationStatus) XXX_Merge(src proto.Message)

func (*RegistrationStatus) XXX_Size 

func (m *RegistrationStatus) XXX_Size() int

func (*RegistrationStatus) XXX_Unmarshal 

func (m *RegistrationStatus) XXX_Unmarshal(b []byte) error

type RegistrationStatusResponse 

type RegistrationStatusResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

RegistrationStatusResponse is sent by plugin to kubelet in response to RegistrationStatus RPC

func (*RegistrationStatusResponse) Descriptor 

func (*RegistrationStatusResponse) Descriptor() ([]byte, []int)

func (*RegistrationStatusResponse) Marshal 

func (m *RegistrationStatusResponse) Marshal() (dAtA []byte, err error)

func (*RegistrationStatusResponse) MarshalTo 

func (m *RegistrationStatusResponse) MarshalTo(dAtA []byte) (int, error)

func (*RegistrationStatusResponse) MarshalToSizedBuffer 

func (m *RegistrationStatusResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RegistrationStatusResponse) ProtoMessage 

func (*RegistrationStatusResponse) ProtoMessage()

func (*RegistrationStatusResponse) Reset 

func (m *RegistrationStatusResponse) Reset()

func (*RegistrationStatusResponse) Size 

func (m *RegistrationStatusResponse) Size() (n int)

func (*RegistrationStatusResponse) String 

func (this *RegistrationStatusResponse) String() string

func (*RegistrationStatusResponse) Unmarshal 

func (m *RegistrationStatusResponse) Unmarshal(dAtA []byte) error

func (*RegistrationStatusResponse) XXX_DiscardUnknown 

func (m *RegistrationStatusResponse) XXX_DiscardUnknown()

func (*RegistrationStatusResponse) XXX_Marshal 

func (m *RegistrationStatusResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RegistrationStatusResponse) XXX_Merge 

func (m *RegistrationStatusResponse) XXX_Merge(src proto.Message)

func (*RegistrationStatusResponse) XXX_Size 

func (m *RegistrationStatusResponse) XXX_Size() int

func (*RegistrationStatusResponse) XXX_Unmarshal 

func (m *RegistrationStatusResponse) XXX_Unmarshal(b []byte) error

type UnimplementedRegistrationServer 

type UnimplementedRegistrationServer struct {
}

UnimplementedRegistrationServer can be embedded to have forward compatible implementations.

func (*UnimplementedRegistrationServer) GetInfo 

func (*UnimplementedRegistrationServer) GetInfo(ctx context.Context, req *InfoRequest) (*PluginInfo, error)

func (*UnimplementedRegistrationServer) NotifyRegistrationStatus 

func (*UnimplementedRegistrationServer) NotifyRegistrationStatus(ctx context.Context, req *RegistrationStatus) (*RegistrationStatusResponse, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.