Documentation

Overview

    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

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

    Functions

    func RegisterRegistrationServer

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

    Types

    type InfoRequest

    type InfoRequest struct {
    }

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

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

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

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

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

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

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

          type RegistrationStatusResponse

          type RegistrationStatusResponse struct {
          }

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