Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthIntrospection        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowIntrospection          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupIntrospection = fmt.Errorf("proto: unexpected end of group")
)

Functions

func RegisterIntrospectionServer

func RegisterIntrospectionServer(s *grpc.Server, srv IntrospectionServer)

Types

type IntrospectionClient

type IntrospectionClient interface {
	// Plugins returns a list of plugins in containerd.
	//
	// Clients can use this to detect features and capabilities when using
	// containerd.
	Plugins(ctx context.Context, in *PluginsRequest, opts ...grpc.CallOption) (*PluginsResponse, error)
	// Server returns information about the containerd server
	Server(ctx context.Context, in *types1.Empty, opts ...grpc.CallOption) (*ServerResponse, error)
}

    IntrospectionClient is the client API for Introspection service.

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

    func NewIntrospectionClient

    func NewIntrospectionClient(cc *grpc.ClientConn) IntrospectionClient

    type IntrospectionServer

    type IntrospectionServer interface {
    	// Plugins returns a list of plugins in containerd.
    	//
    	// Clients can use this to detect features and capabilities when using
    	// containerd.
    	Plugins(context.Context, *PluginsRequest) (*PluginsResponse, error)
    	// Server returns information about the containerd server
    	Server(context.Context, *types1.Empty) (*ServerResponse, error)
    }

      IntrospectionServer is the server API for Introspection service.

      type Plugin

      type Plugin struct {
      	// Type defines the type of plugin.
      	//
      	// See package plugin for a list of possible values. Non core plugins may
      	// define their own values during registration.
      	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
      	// ID identifies the plugin uniquely in the system.
      	ID string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
      	// Requires lists the plugin types required by this plugin.
      	Requires []string `protobuf:"bytes,3,rep,name=requires,proto3" json:"requires,omitempty"`
      	// Platforms enumerates the platforms this plugin will support.
      	//
      	// If values are provided here, the plugin will only be operable under the
      	// provided platforms.
      	//
      	// If this is empty, the plugin will work across all platforms.
      	//
      	// If the plugin prefers certain platforms over others, they should be
      	// listed from most to least preferred.
      	Platforms []types.Platform `protobuf:"bytes,4,rep,name=platforms,proto3" json:"platforms"`
      	// Exports allows plugins to provide values about state or configuration to
      	// interested parties.
      	//
      	// One example is exposing the configured path of a snapshotter plugin.
      	Exports map[string]string `` /* 155-byte string literal not displayed */
      	// Capabilities allows plugins to communicate feature switches to allow
      	// clients to detect features that may not be on be default or may be
      	// different from version to version.
      	//
      	// Use this sparingly.
      	Capabilities []string `protobuf:"bytes,6,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
      	// InitErr will be set if the plugin fails initialization.
      	//
      	// This means the plugin may have been registered but a non-terminal error
      	// was encountered during initialization.
      	//
      	// Plugins that have this value set cannot be used.
      	InitErr              *rpc.Status `protobuf:"bytes,7,opt,name=init_err,json=initErr,proto3" json:"init_err,omitempty"`
      	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
      	XXX_unrecognized     []byte      `json:"-"`
      	XXX_sizecache        int32       `json:"-"`
      }

      func (*Plugin) Descriptor

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

      func (*Plugin) Marshal

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

      func (*Plugin) MarshalTo

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

      func (*Plugin) MarshalToSizedBuffer

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

      func (*Plugin) ProtoMessage

      func (*Plugin) ProtoMessage()

      func (*Plugin) Reset

      func (m *Plugin) Reset()

      func (*Plugin) Size

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

      func (*Plugin) String

      func (this *Plugin) String() string

      func (*Plugin) Unmarshal

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

      func (*Plugin) XXX_DiscardUnknown

      func (m *Plugin) XXX_DiscardUnknown()

      func (*Plugin) XXX_Marshal

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

      func (*Plugin) XXX_Merge

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

      func (*Plugin) XXX_Size

      func (m *Plugin) XXX_Size() int

      func (*Plugin) XXX_Unmarshal

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

      type PluginsRequest

      type PluginsRequest struct {
      	// Filters contains one or more filters using the syntax defined in the
      	// containerd filter package.
      	//
      	// The returned result will be those that match any of the provided
      	// filters. Expanded, plugins that match the following will be
      	// returned:
      	//
      	//   filters[0] or filters[1] or ... or filters[n-1] or filters[n]
      	//
      	// If filters is zero-length or nil, all items will be returned.
      	Filters              []string `protobuf:"bytes,1,rep,name=filters,proto3" json:"filters,omitempty"`
      	XXX_NoUnkeyedLiteral struct{} `json:"-"`
      	XXX_unrecognized     []byte   `json:"-"`
      	XXX_sizecache        int32    `json:"-"`
      }

      func (*PluginsRequest) Descriptor

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

      func (*PluginsRequest) Marshal

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

      func (*PluginsRequest) MarshalTo

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

      func (*PluginsRequest) MarshalToSizedBuffer

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

      func (*PluginsRequest) ProtoMessage

      func (*PluginsRequest) ProtoMessage()

      func (*PluginsRequest) Reset

      func (m *PluginsRequest) Reset()

      func (*PluginsRequest) Size

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

      func (*PluginsRequest) String

      func (this *PluginsRequest) String() string

      func (*PluginsRequest) Unmarshal

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

      func (*PluginsRequest) XXX_DiscardUnknown

      func (m *PluginsRequest) XXX_DiscardUnknown()

      func (*PluginsRequest) XXX_Marshal

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

      func (*PluginsRequest) XXX_Merge

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

      func (*PluginsRequest) XXX_Size

      func (m *PluginsRequest) XXX_Size() int

      func (*PluginsRequest) XXX_Unmarshal

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

      type PluginsResponse

      type PluginsResponse struct {
      	Plugins              []Plugin `protobuf:"bytes,1,rep,name=plugins,proto3" json:"plugins"`
      	XXX_NoUnkeyedLiteral struct{} `json:"-"`
      	XXX_unrecognized     []byte   `json:"-"`
      	XXX_sizecache        int32    `json:"-"`
      }

      func (*PluginsResponse) Descriptor

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

      func (*PluginsResponse) Marshal

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

      func (*PluginsResponse) MarshalTo

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

      func (*PluginsResponse) MarshalToSizedBuffer

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

      func (*PluginsResponse) ProtoMessage

      func (*PluginsResponse) ProtoMessage()

      func (*PluginsResponse) Reset

      func (m *PluginsResponse) Reset()

      func (*PluginsResponse) Size

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

      func (*PluginsResponse) String

      func (this *PluginsResponse) String() string

      func (*PluginsResponse) Unmarshal

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

      func (*PluginsResponse) XXX_DiscardUnknown

      func (m *PluginsResponse) XXX_DiscardUnknown()

      func (*PluginsResponse) XXX_Marshal

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

      func (*PluginsResponse) XXX_Merge

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

      func (*PluginsResponse) XXX_Size

      func (m *PluginsResponse) XXX_Size() int

      func (*PluginsResponse) XXX_Unmarshal

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

      type ServerResponse

      type ServerResponse struct {
      	UUID                 string   `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
      	XXX_NoUnkeyedLiteral struct{} `json:"-"`
      	XXX_unrecognized     []byte   `json:"-"`
      	XXX_sizecache        int32    `json:"-"`
      }

      func (*ServerResponse) Descriptor

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

      func (*ServerResponse) Marshal

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

      func (*ServerResponse) MarshalTo

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

      func (*ServerResponse) MarshalToSizedBuffer

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

      func (*ServerResponse) ProtoMessage

      func (*ServerResponse) ProtoMessage()

      func (*ServerResponse) Reset

      func (m *ServerResponse) Reset()

      func (*ServerResponse) Size

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

      func (*ServerResponse) String

      func (this *ServerResponse) String() string

      func (*ServerResponse) Unmarshal

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

      func (*ServerResponse) XXX_DiscardUnknown

      func (m *ServerResponse) XXX_DiscardUnknown()

      func (*ServerResponse) XXX_Marshal

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

      func (*ServerResponse) XXX_Merge

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

      func (*ServerResponse) XXX_Size

      func (m *ServerResponse) XXX_Size() int

      func (*ServerResponse) XXX_Unmarshal

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

      type UnimplementedIntrospectionServer

      type UnimplementedIntrospectionServer struct {
      }

        UnimplementedIntrospectionServer can be embedded to have forward compatible implementations.

        func (*UnimplementedIntrospectionServer) Plugins

        func (*UnimplementedIntrospectionServer) Server