introspection

package
v1.7.0-rc.3 Latest Latest
Warning

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

 Go to latest Published: Mar 9, 2023 License: Apache-2.0 Imports: 11 Imported by: 339

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_github_com_containerd_containerd_api_services_introspection_v1_introspection_proto protoreflect.FileDescriptor
View Source 
var Introspection_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "containerd.services.introspection.v1.Introspection",
	HandlerType: (*IntrospectionServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Plugins",
			Handler:    _Introspection_Plugins_Handler,
		},
		{
			MethodName: "Server",
			Handler:    _Introspection_Server_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "github.com/containerd/containerd/api/services/introspection/v1/introspection.proto",
}

Introspection_ServiceDesc is the grpc.ServiceDesc for Introspection service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterIntrospectionServer 

func RegisterIntrospectionServer(s grpc.ServiceRegistrar, 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 *emptypb.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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewIntrospectionClient 

func NewIntrospectionClient(cc grpc.ClientConnInterface) 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, *emptypb.Empty) (*ServerResponse, error)
	// contains filtered or unexported methods
}

IntrospectionServer is the server API for Introspection service. All implementations must embed UnimplementedIntrospectionServer for forward compatibility

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,omitempty"`
	// 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 *status.Status `protobuf:"bytes,7,opt,name=init_err,json=initErr,proto3" json:"init_err,omitempty"`
	// contains filtered or unexported fields
}

func (*Plugin) Descriptor deprecated 

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

Deprecated: Use Plugin.ProtoReflect.Descriptor instead.

func (*Plugin) GetCapabilities added in v1.7.0 

func (x *Plugin) GetCapabilities() []string

func (*Plugin) GetExports added in v1.7.0 

func (x *Plugin) GetExports() map[string]string

func (*Plugin) GetID added in v1.7.0 

func (x *Plugin) GetID() string

func (*Plugin) GetInitErr added in v1.7.0 

func (x *Plugin) GetInitErr() *status.Status

func (*Plugin) GetPlatforms added in v1.7.0 

func (x *Plugin) GetPlatforms() []*types.Platform

func (*Plugin) GetRequires added in v1.7.0 

func (x *Plugin) GetRequires() []string

func (*Plugin) GetType added in v1.7.0 

func (x *Plugin) GetType() string

func (*Plugin) ProtoMessage 

func (*Plugin) ProtoMessage()

func (*Plugin) ProtoReflect added in v1.7.0 

func (x *Plugin) ProtoReflect() protoreflect.Message

func (*Plugin) Reset 

func (x *Plugin) Reset()

func (*Plugin) String 

func (x *Plugin) String() string

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"`
	// contains filtered or unexported fields
}

func (*PluginsRequest) Descriptor deprecated 

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

Deprecated: Use PluginsRequest.ProtoReflect.Descriptor instead.

func (*PluginsRequest) GetFilters added in v1.7.0 

func (x *PluginsRequest) GetFilters() []string

func (*PluginsRequest) ProtoMessage 

func (*PluginsRequest) ProtoMessage()

func (*PluginsRequest) ProtoReflect added in v1.7.0 

func (x *PluginsRequest) ProtoReflect() protoreflect.Message

func (*PluginsRequest) Reset 

func (x *PluginsRequest) Reset()

func (*PluginsRequest) String 

func (x *PluginsRequest) String() string

type PluginsResponse 

type PluginsResponse struct {
	Plugins []*Plugin `protobuf:"bytes,1,rep,name=plugins,proto3" json:"plugins,omitempty"`
	// contains filtered or unexported fields
}

func (*PluginsResponse) Descriptor deprecated 

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

Deprecated: Use PluginsResponse.ProtoReflect.Descriptor instead.

func (*PluginsResponse) GetPlugins added in v1.7.0 

func (x *PluginsResponse) GetPlugins() []*Plugin

func (*PluginsResponse) ProtoMessage 

func (*PluginsResponse) ProtoMessage()

func (*PluginsResponse) ProtoReflect added in v1.7.0 

func (x *PluginsResponse) ProtoReflect() protoreflect.Message

func (*PluginsResponse) Reset 

func (x *PluginsResponse) Reset()

func (*PluginsResponse) String 

func (x *PluginsResponse) String() string

type ServerResponse added in v1.3.0 

type ServerResponse struct {
	UUID  string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	Pid   uint64 `protobuf:"varint,2,opt,name=pid,proto3" json:"pid,omitempty"`
	Pidns uint64 `protobuf:"varint,3,opt,name=pidns,proto3" json:"pidns,omitempty"` // PID namespace, such as 4026531836
	// contains filtered or unexported fields
}

func (*ServerResponse) Descriptor deprecated added in v1.3.0 

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

Deprecated: Use ServerResponse.ProtoReflect.Descriptor instead.

func (*ServerResponse) GetPid added in v1.7.0 

func (x *ServerResponse) GetPid() uint64

func (*ServerResponse) GetPidns added in v1.7.0 

func (x *ServerResponse) GetPidns() uint64

func (*ServerResponse) GetUUID added in v1.7.0 

func (x *ServerResponse) GetUUID() string

func (*ServerResponse) ProtoMessage added in v1.3.0 

func (*ServerResponse) ProtoMessage()

func (*ServerResponse) ProtoReflect added in v1.7.0 

func (x *ServerResponse) ProtoReflect() protoreflect.Message

func (*ServerResponse) Reset added in v1.3.0 

func (x *ServerResponse) Reset()

func (*ServerResponse) String added in v1.3.0 

func (x *ServerResponse) String() string

type UnimplementedIntrospectionServer added in v1.4.0 

type UnimplementedIntrospectionServer struct {
}

UnimplementedIntrospectionServer must be embedded to have forward compatible implementations.

func (UnimplementedIntrospectionServer) Plugins added in v1.4.0 

func (UnimplementedIntrospectionServer) Plugins(context.Context, *PluginsRequest) (*PluginsResponse, error)

func (UnimplementedIntrospectionServer) Server added in v1.4.0 

func (UnimplementedIntrospectionServer) Server(context.Context, *emptypb.Empty) (*ServerResponse, error)

type UnsafeIntrospectionServer added in v1.7.0 

type UnsafeIntrospectionServer interface {
	// contains filtered or unexported methods
}

UnsafeIntrospectionServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to IntrospectionServer will result in compilation errors.

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.