containerd/plugin/runtime.go
Samuel Ortiz ddea395572 plugin: Fix runtime interface documentation
Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
2017-06-19 18:47:26 +02:00

49 lines
1.2 KiB
Go

package plugin
import (
"context"
"time"
"github.com/containerd/containerd/mount"
)
type IO struct {
Stdin string
Stdout string
Stderr string
Terminal bool
}
type CreateOpts struct {
// Spec is the OCI runtime spec
Spec []byte
// Rootfs mounts to perform to gain access to the container's filesystem
Rootfs []mount.Mount
// IO for the container's main process
IO IO
Checkpoint string
}
type Exit struct {
Status uint32
Timestamp time.Time
}
// Runtime is responsible for the creation of containers for a certain platform,
// arch, or custom usage.
type Runtime interface {
// ID of the runtime
ID() string
// Create creates a task with the provided id and options.
Create(ctx context.Context, id string, opts CreateOpts) (Task, error)
// Get returns a task.
Get(context.Context, string) (Task, error)
// Tasks returns all the current tasks for the runtime.
// Any container runs at most one task at a time.
Tasks(context.Context) ([]Task, error)
// Delete removes the task in the runtime.
Delete(context.Context, Task) (*Exit, error)
// Events returns events for the runtime and all tasks created by the runtime
Events(context.Context) <-chan *Event
}