kubernetes: k8s.io/kubernetes/pkg/kubelet/apis/pluginregistration/v1 Index | Files

package pluginregistration

import "k8s.io/kubernetes/pkg/kubelet/apis/pluginregistration/v1"

Package pluginregistration is a generated protocol buffer package.

It is generated from these files:

api.proto

It has these top-level messages:

PluginInfo
RegistrationStatus
RegistrationStatusResponse
InfoRequest

Index

Package Files

api.pb.go constants.go

Constants

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

Variables

var (
    ErrInvalidLengthApi = fmt.Errorf("proto: negative length found during unmarshaling")
    ErrIntOverflowApi   = fmt.Errorf("proto: integer overflow")
)

func RegisterRegistrationServer Uses

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

type InfoRequest Uses

type InfoRequest struct {
}

InfoRequest is the empty request message from Kubelet

func (*InfoRequest) Descriptor Uses

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

func (*InfoRequest) Marshal Uses

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

func (*InfoRequest) MarshalTo Uses

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

func (*InfoRequest) ProtoMessage Uses

func (*InfoRequest) ProtoMessage()

func (*InfoRequest) Reset Uses

func (m *InfoRequest) Reset()

func (*InfoRequest) Size Uses

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

func (*InfoRequest) String Uses

func (this *InfoRequest) String() string

func (*InfoRequest) Unmarshal Uses

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

type PluginInfo Uses

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" json:"supported_versions,omitempty"`
}

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

func (*PluginInfo) Descriptor Uses

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

func (*PluginInfo) GetEndpoint Uses

func (m *PluginInfo) GetEndpoint() string

func (*PluginInfo) GetName Uses

func (m *PluginInfo) GetName() string

func (*PluginInfo) GetSupportedVersions Uses

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

func (*PluginInfo) GetType Uses

func (m *PluginInfo) GetType() string

func (*PluginInfo) Marshal Uses

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

func (*PluginInfo) MarshalTo Uses

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

func (*PluginInfo) ProtoMessage Uses

func (*PluginInfo) ProtoMessage()

func (*PluginInfo) Reset Uses

func (m *PluginInfo) Reset()

func (*PluginInfo) Size Uses

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

func (*PluginInfo) String Uses

func (this *PluginInfo) String() string

func (*PluginInfo) Unmarshal Uses

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

type RegistrationClient Uses

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)
}

func NewRegistrationClient Uses

func NewRegistrationClient(cc *grpc.ClientConn) RegistrationClient

type RegistrationServer Uses

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

type RegistrationStatus Uses

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"`
}

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

func (*RegistrationStatus) Descriptor Uses

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

func (*RegistrationStatus) GetError Uses

func (m *RegistrationStatus) GetError() string

func (*RegistrationStatus) GetPluginRegistered Uses

func (m *RegistrationStatus) GetPluginRegistered() bool

func (*RegistrationStatus) Marshal Uses

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

func (*RegistrationStatus) MarshalTo Uses

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

func (*RegistrationStatus) ProtoMessage Uses

func (*RegistrationStatus) ProtoMessage()

func (*RegistrationStatus) Reset Uses

func (m *RegistrationStatus) Reset()

func (*RegistrationStatus) Size Uses

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

func (*RegistrationStatus) String Uses

func (this *RegistrationStatus) String() string

func (*RegistrationStatus) Unmarshal Uses

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

type RegistrationStatusResponse Uses

type RegistrationStatusResponse struct {
}

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

func (*RegistrationStatusResponse) Descriptor Uses

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

func (*RegistrationStatusResponse) Marshal Uses

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

func (*RegistrationStatusResponse) MarshalTo Uses

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

func (*RegistrationStatusResponse) ProtoMessage Uses

func (*RegistrationStatusResponse) ProtoMessage()

func (*RegistrationStatusResponse) Reset Uses

func (m *RegistrationStatusResponse) Reset()

func (*RegistrationStatusResponse) Size Uses

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

func (*RegistrationStatusResponse) String Uses

func (this *RegistrationStatusResponse) String() string

func (*RegistrationStatusResponse) Unmarshal Uses

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

Package pluginregistration imports 9 packages (graph) and is imported by 17 packages. Updated 2019-03-16. Refresh now. Tools for package owners.