Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

containerd

package module

Go to main page

Versions in this module

v1

v1.3.4

Apr 16, 2020

v1.0.0

May 17, 2020

Changes in this version

+ const DefaultSnapshotter — darwin/amd64, linux/amd64, windows/amd64

+ const StopSignalLabel

+ const UnknownExitStatus

+ var ErrCheckpointRWUnsupported = errors.New("rw checkpoint is only supported on v2 runtimes")

+ var ErrImageNameNotFoundInIndex = errors.New("image name not found in index")

+ var ErrMediaTypeNotFound = errors.New("media type not found")

+ var ErrRuntimeNameNotFoundInIndex = errors.New("runtime not found in index")

+ var ErrSnapshotterNameNotFoundInIndex = errors.New("snapshotter not found in index")

+ func CheckRuntime(current, expected string) bool

+ func GetIndexByMediaType(index *imagespec.Index, mt string) (*imagespec.Descriptor, error)

+ func GetOCIStopSignal(ctx context.Context, image Image, defaultSignal string) (string, error)

+ func GetStopSignal(ctx context.Context, container Container, defaultSignal syscall.Signal) (syscall.Signal, error)

+ func NewImageStoreFromClient(client imagesapi.ImagesClient) images.Store

+ func NewNamespaceStoreFromClient(client api.NamespacesClient) namespaces.Store

+ func NewRemoteContainerStore(client containersapi.ContainersClient) containers.Store

+ func ParseSignal(rawSignal string) (syscall.Signal, error) — darwin/amd64, linux/amd64, windows/amd64

+ func WithCheckpointImage(ctx context.Context, client *Client, c *containers.Container, ...) error

+ func WithCheckpointRW(ctx context.Context, client *Client, c *containers.Container, ...) error

+ func WithCheckpointRuntime(ctx context.Context, client *Client, c *containers.Container, ...) error

+ func WithCheckpointTask(ctx context.Context, client *Client, c *containers.Container, ...) error

+ func WithCheckpointTaskExit(ctx context.Context, client *Client, c *containers.Container, ...) error

+ func WithInstallLibs(c *InstallConfig)

+ func WithInstallReplace(c *InstallConfig)

+ func WithKillAll(ctx context.Context, i *KillInfo) error

+ func WithNoNewKeyring(ctx context.Context, c *Client, ti *TaskInfo) error — darwin/amd64, js/wasm, linux/amd64

+ func WithNoPivotRoot(_ context.Context, _ *Client, ti *TaskInfo) error — darwin/amd64, js/wasm, linux/amd64

+ func WithProcessKill(ctx context.Context, p Process) error

+ func WithPullUnpack(_ *Client, c *RemoteContext) error

+ func WithSchema1Conversion(client *Client, c *RemoteContext) error

+ func WithSnapshotCleanup(ctx context.Context, client *Client, c containers.Container) error

+ func WithStdinCloser(r *IOCloseInfo)

+ func WithoutRefreshedMetadata(i *InfoConfig)

+ type CheckpointOpts func(context.Context, *Client, *containers.Container, *imagespec.Index, ...) error

+ type CheckpointTaskInfo struct

+ Name string

+ Options interface{}

+ ParentCheckpoint digest.Digest

+ func (i *CheckpointTaskInfo) Runtime() string

+ type CheckpointTaskOpts func(*CheckpointTaskInfo) error

+ func WithCheckpointImagePath(path string) CheckpointTaskOpts

+ func WithCheckpointName(name string) CheckpointTaskOpts

+ type Client struct

+ func New(address string, opts ...ClientOpt) (*Client, error)

+ func NewWithConn(conn *grpc.ClientConn, opts ...ClientOpt) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) Conn() *grpc.ClientConn

+ func (c *Client) ContainerService() containers.Store

+ func (c *Client) Containers(ctx context.Context, filters ...string) ([]Container, error)

+ func (c *Client) ContentStore() content.Store

+ func (c *Client) DiffService() DiffService

+ func (c *Client) EventService() EventService

+ func (c *Client) Export(ctx context.Context, w io.Writer, opts ...archive.ExportOpt) error

+ func (c *Client) Fetch(ctx context.Context, ref string, opts ...RemoteOpt) (images.Image, error)

+ func (c *Client) GetImage(ctx context.Context, ref string) (Image, error)

+ func (c *Client) GetLabel(ctx context.Context, label string) (string, error)

+ func (c *Client) HealthService() grpc_health_v1.HealthClient

+ func (c *Client) ImageService() images.Store

+ func (c *Client) Import(ctx context.Context, reader io.Reader, opts ...ImportOpt) ([]images.Image, error)

+ func (c *Client) Install(ctx context.Context, image Image, opts ...InstallOpts) error

+ func (c *Client) IntrospectionService() introspection.Service

+ func (c *Client) IsServing(ctx context.Context) (bool, error)

+ func (c *Client) LeasesService() leases.Manager

+ func (c *Client) ListImages(ctx context.Context, filters ...string) ([]Image, error)

+ func (c *Client) LoadContainer(ctx context.Context, id string) (Container, error)

+ func (c *Client) NamespaceService() namespaces.Store

+ func (c *Client) NewContainer(ctx context.Context, id string, opts ...NewContainerOpts) (Container, error)

+ func (c *Client) Pull(ctx context.Context, ref string, opts ...RemoteOpt) (_ Image, retErr error)

+ func (c *Client) Push(ctx context.Context, ref string, desc ocispec.Descriptor, opts ...RemoteOpt) error

+ func (c *Client) Reconnect() error

+ func (c *Client) Restore(ctx context.Context, id string, checkpoint Image, opts ...RestoreOpts) (Container, error)

+ func (c *Client) Server(ctx context.Context) (ServerInfo, error)

+ func (c *Client) SnapshotService(snapshotterName string) snapshots.Snapshotter

+ func (c *Client) Subscribe(ctx context.Context, filters ...string) (ch <-chan *events.Envelope, errs <-chan error)

+ func (c *Client) TaskService() tasks.TasksClient

+ func (c *Client) Version(ctx context.Context) (Version, error)

+ func (c *Client) VersionService() versionservice.VersionClient

+ func (c *Client) WithLease(ctx context.Context, opts ...leases.Opt) (context.Context, func(context.Context) error, error)

+ type ClientOpt func(c *clientOpts) error

+ func WithDefaultNamespace(ns string) ClientOpt

+ func WithDefaultPlatform(platform platforms.MatchComparer) ClientOpt

+ func WithDefaultRuntime(rt string) ClientOpt

+ func WithDialOpts(opts []grpc.DialOption) ClientOpt

+ func WithServices(opts ...ServicesOpt) ClientOpt

+ func WithTimeout(d time.Duration) ClientOpt

+ type Container interface

+ Checkpoint func(context.Context, string, ...CheckpointOpts) (Image, error)

+ Delete func(context.Context, ...DeleteOpts) error

+ Extensions func(context.Context) (map[string]prototypes.Any, error)

+ ID func() string

+ Image func(context.Context) (Image, error)

+ Info func(context.Context, ...InfoOpts) (containers.Container, error)

+ Labels func(context.Context) (map[string]string, error)

+ NewTask func(context.Context, cio.Creator, ...NewTaskOpts) (Task, error)

+ SetLabels func(context.Context, map[string]string) (map[string]string, error)

+ Spec func(context.Context) (*oci.Spec, error)

+ Task func(context.Context, cio.Attach) (Task, error)

+ Update func(context.Context, ...UpdateContainerOpts) error

+ type DeleteOpts func(ctx context.Context, client *Client, c containers.Container) error

+ type DiffService interface

+ func NewDiffServiceFromClient(client diffapi.DiffClient) DiffService

+ type EventService interface

+ func NewEventServiceFromClient(client eventsapi.EventsClient) EventService

+ type ExitStatus struct

+ func NewExitStatus(code uint32, t time.Time, err error) *ExitStatus

+ func (s ExitStatus) Error() error

+ func (s ExitStatus) ExitCode() uint32

+ func (s ExitStatus) ExitTime() time.Time

+ func (s ExitStatus) Result() (uint32, time.Time, error)

+ type IOCloseInfo struct

+ Stdin bool

+ type IOCloserOpts func(*IOCloseInfo)

+ type Image interface

+ Config func(ctx context.Context) (ocispec.Descriptor, error)

+ ContentStore func() content.Store

+ IsUnpacked func(context.Context, string) (bool, error)

+ Labels func() map[string]string

+ Metadata func() images.Image

+ Name func() string

+ RootFS func(ctx context.Context) ([]digest.Digest, error)

+ Size func(ctx context.Context) (int64, error)

+ Target func() ocispec.Descriptor

+ Unpack func(context.Context, string, ...UnpackOpt) error

+ Usage func(context.Context, ...UsageOpt) (int64, error)

+ func NewImage(client *Client, i images.Image) Image

+ func NewImageWithPlatform(client *Client, i images.Image, platform platforms.MatchComparer) Image

+ type ImportOpt func(*importOpts) error

+ func WithAllPlatforms(allPlatforms bool) ImportOpt

+ func WithDigestRef(f func(digest.Digest) string) ImportOpt

+ func WithImageRefTranslator(f func(string) string) ImportOpt

+ func WithImportCompression() ImportOpt

+ func WithIndexName(name string) ImportOpt

+ type InfoConfig struct

+ Refresh bool

+ type InfoOpts func(*InfoConfig)

+ type InstallConfig struct

+ Libs bool

+ Path string

+ Replace bool

+ type InstallOpts func(*InstallConfig)

+ func WithInstallPath(path string) InstallOpts

+ type KillInfo struct

+ All bool

+ ExecID string

+ type KillOpts func(context.Context, *KillInfo) error

+ func WithKillExecID(execID string) KillOpts

+ type NewContainerOpts func(ctx context.Context, client *Client, c *containers.Container) error

+ func WithContainerExtension(name string, extension interface{}) NewContainerOpts

+ func WithContainerLabels(labels map[string]string) NewContainerOpts

+ func WithImage(i Image) NewContainerOpts

+ func WithImageName(n string) NewContainerOpts

+ func WithImageStopSignal(image Image, defaultSignal string) NewContainerOpts

+ func WithNewSnapshot(id string, i Image, opts ...snapshots.Opt) NewContainerOpts

+ func WithNewSnapshotView(id string, i Image, opts ...snapshots.Opt) NewContainerOpts

+ func WithNewSpec(opts ...oci.SpecOpts) NewContainerOpts

+ func WithRemappedSnapshot(id string, i Image, uid, gid uint32) NewContainerOpts

+ func WithRemappedSnapshotView(id string, i Image, uid, gid uint32) NewContainerOpts

+ func WithRestoreImage(ctx context.Context, id string, client *Client, checkpoint Image, ...) NewContainerOpts

+ func WithRestoreRW(ctx context.Context, id string, client *Client, checkpoint Image, ...) NewContainerOpts

+ func WithRestoreRuntime(ctx context.Context, id string, client *Client, checkpoint Image, ...) NewContainerOpts

+ func WithRestoreSpec(ctx context.Context, id string, client *Client, checkpoint Image, ...) NewContainerOpts

+ func WithRuntime(name string, options interface{}) NewContainerOpts

+ func WithSnapshot(id string) NewContainerOpts

+ func WithSnapshotter(name string) NewContainerOpts

+ func WithSpec(s *oci.Spec, opts ...oci.SpecOpts) NewContainerOpts

+ type NewTaskOpts func(context.Context, *Client, *TaskInfo) error

+ func WithGIDOwner(gid uint32) NewTaskOpts

+ func WithRestoreImagePath(path string) NewTaskOpts

+ func WithRootFS(mounts []mount.Mount) NewTaskOpts

+ func WithShimCgroup(path string) NewTaskOpts

+ func WithTaskCheckpoint(im Image) NewTaskOpts

+ func WithUIDOwner(uid uint32) NewTaskOpts

+ type Process interface

+ CloseIO func(context.Context, ...IOCloserOpts) error

+ Delete func(context.Context, ...ProcessDeleteOpts) (*ExitStatus, error)

+ ID func() string

+ IO func() cio.IO

+ Kill func(context.Context, syscall.Signal, ...KillOpts) error

+ Pid func() uint32

+ Resize func(ctx context.Context, w, h uint32) error

+ Start func(context.Context) error

+ Status func(context.Context) (Status, error)

+ Wait func(context.Context) (<-chan ExitStatus, error)

+ type ProcessDeleteOpts func(context.Context, Process) error

+ type ProcessInfo struct

+ Info *google_protobuf.Any

+ Pid uint32

+ type ProcessStatus string

+ const Created

+ const Paused

+ const Pausing

+ const Running

+ const Stopped

+ const Unknown

+ type RemoteContext struct

+ AllMetadata bool

+ BaseHandlers []images.Handler

+ ConvertSchema1 bool

+ HandlerWrapper func(images.Handler) images.Handler

+ Labels map[string]string

+ MaxConcurrentDownloads int

+ PlatformMatcher platforms.MatchComparer

+ Platforms []string

+ Resolver remotes.Resolver

+ Snapshotter string

+ SnapshotterOpts []snapshots.Opt

+ Unpack bool

+ UnpackOpts []UnpackOpt

+ type RemoteOpt func(*Client, *RemoteContext) error

+ func WithAllMetadata() RemoteOpt

+ func WithImageHandler(h images.Handler) RemoteOpt

+ func WithImageHandlerWrapper(w func(images.Handler) images.Handler) RemoteOpt

+ func WithMaxConcurrentDownloads(max int) RemoteOpt

+ func WithPlatform(platform string) RemoteOpt

+ func WithPlatformMatcher(m platforms.MatchComparer) RemoteOpt

+ func WithPullLabel(key, value string) RemoteOpt

+ func WithPullLabels(labels map[string]string) RemoteOpt

+ func WithPullSnapshotter(snapshotterName string, opts ...snapshots.Opt) RemoteOpt

+ func WithResolver(resolver remotes.Resolver) RemoteOpt

+ func WithUnpackOpts(opts []UnpackOpt) RemoteOpt

+ type RestoreOpts func(context.Context, string, *Client, Image, *imagespec.Index) NewContainerOpts

+ type ServerInfo struct

+ UUID string

+ type ServicesOpt func(c *services)

+ func WithContainerService(containerService containersapi.ContainersClient) ServicesOpt

+ func WithContentStore(contentStore content.Store) ServicesOpt

+ func WithDiffService(diffService diff.DiffClient) ServicesOpt

+ func WithEventService(eventService EventService) ServicesOpt

+ func WithImageService(imageService imagesapi.ImagesClient) ServicesOpt

+ func WithIntrospectionService(in introspectionapi.IntrospectionClient) ServicesOpt

+ func WithLeasesService(leasesService leases.Manager) ServicesOpt

+ func WithNamespaceService(namespaceService namespacesapi.NamespacesClient) ServicesOpt

+ func WithSnapshotters(snapshotters map[string]snapshots.Snapshotter) ServicesOpt

+ func WithTaskService(taskService tasks.TasksClient) ServicesOpt

+ type Status struct

+ ExitStatus uint32

+ ExitTime time.Time

+ Status ProcessStatus

+ type Task interface

+ Checkpoint func(context.Context, ...CheckpointTaskOpts) (Image, error)

+ Exec func(context.Context, string, *specs.Process, cio.Creator) (Process, error)

+ LoadProcess func(context.Context, string, cio.Attach) (Process, error)

+ Metrics func(context.Context) (*types.Metric, error)

+ Pause func(context.Context) error

+ Pids func(context.Context) ([]ProcessInfo, error)

+ Resume func(context.Context) error

+ Update func(context.Context, ...UpdateTaskOpts) error

+ type TaskInfo struct

+ Checkpoint *types.Descriptor

+ Options interface{}

+ RootFS []mount.Mount

+ func (i *TaskInfo) Runtime() string

+ type UnpackConfig struct

+ ApplyOpts []diff.ApplyOpt

+ SnapshotOpts []snapshots.Opt

+ type UnpackOpt func(context.Context, *UnpackConfig) error

+ type UpdateContainerOpts func(ctx context.Context, client *Client, c *containers.Container) error

+ type UpdateTaskInfo struct

+ Resources interface{}

+ type UpdateTaskOpts func(context.Context, *Client, *UpdateTaskInfo) error

+ func WithResources(resources interface{}) UpdateTaskOpts

+ type UsageOpt func(*usageOptions) error

+ func WithManifestUsage() UsageOpt

+ func WithSnapshotUsage() UsageOpt

+ func WithUsageManifestLimit(i int) UsageOpt

+ type Version struct

+ Revision string

+ Version string