engine

Documentation

Index

• type Client
• type Container
• type ContainerMount
• type ContainerPort
• type CreateOptions
• type DeleteOptions
• type ListOptions
• type LogsOptions
• type Protocol
• type PullOptions

Types

type Client

type Client interface {
	List(ctx context.Context, options ListOptions) ([]Container, error)

	Pull(ctx context.Context, image string, options PullOptions) error

	Create(ctx context.Context, spec Container, options CreateOptions) (string, error)
	Delete(ctx context.Context, container string, options DeleteOptions) error

	Inspect(ctx context.Context, container string) (Container, error)

	Logs(ctx context.Context, container string, options LogsOptions) error
}

type Container

type Container struct {
	ID   string
	Name string

	Labels map[string]string

	Image string

	Privileged bool

	RunAsUser  string
	RunAsGroup string

	MaxFiles     int64
	MaxProcesses int64

	Env map[string]string
	Dir string

	Command []string
	Args    []string

	Hostname  string
	IPAddress net.IP

	Ports  []*ContainerPort
	Mounts []*ContainerMount
}

type ContainerMount

type ContainerMount struct {
	Path string

	Volume   string
	HostPath string
}

type ContainerPort

type ContainerPort struct {
	Name string

	Port  int
	Proto Protocol

	HostIP   string
	HostPort *int
}

type CreateOptions

type CreateOptions struct {
	Platform string

	Stdout io.Writer
	Stderr io.Writer
}

type DeleteOptions

type DeleteOptions struct {
}

type ListOptions

type ListOptions struct {
	All bool

	LabelSelector map[string]string
}

type LogsOptions

type LogsOptions struct {
	Follow bool

	Stdout io.Writer
	Stderr io.Writer
}

type Protocol

type Protocol string

const (
	ProtocolTCP Protocol = "tcp"
	ProtocolUDP Protocol = "udp"
)

type PullOptions

type PullOptions struct {
	Platform string

	Stdout io.Writer
	Stderr io.Writer
}