containers

type Container struct {
	ID          string
	Status      string
	Image       string
	Command     string
	CPUTime     uint64
	MemoryUsage uint64
	PidsCurrent uint64
	PidsLimit   uint64
	Config      *RuntimeConfig `json:",omitempty"`
	HostConfig  *HostConfig    `json:",omitempty"`
	Ports       []Port         `json:",omitempty"`
	Platform    string
}

type ContainerConfig struct {
	// ID uniquely identifies the container
	ID string
	// Image specifies the iamge reference used for a container
	Image string
	// Command are the arguments passed to the container's entrypoint
	Command []string
	// Ports provide a list of published ports
	Ports []Port
	// Labels set labels to the container
	Labels map[string]string
	// Volumes to be mounted
	Volumes []string
	// Memlimit
	MemLimit formatter.MemBytes
	// CPUlimit
	CPULimit float64
	// Environment variables
	Environment []string
	// Restart policy condition
	RestartPolicyCondition string
	// DomainName Container NIS domain name
	DomainName string
}

type DeleteRequest struct {
	Force bool
}

type ExecRequest struct {
	Stdin       io.Reader
	Stdout      io.Writer
	Stderr      io.Writer
	Command     string
	Interactive bool
	Tty         bool
}

type HostConfig struct {
	RestartPolicy     string
	CPUReservation    float64
	CPULimit          float64
	MemoryReservation uint64
	MemoryLimit       uint64
}

type LogsRequest struct {
	Follow bool
	Tail   string
	Width  int
	Writer io.Writer
}

type Port struct {
	// HostPort is the port number on the host
	HostPort uint32
	// ContainerPort is the port number inside the container
	ContainerPort uint32
	// Protocol is the protocol of the port mapping
	Protocol string
	// HostIP is the host ip to use
	HostIP string
}

type RuntimeConfig struct {
	Labels []string          `json:",omitempty"`
	Env    map[string]string `json:",omitempty"`
	// FQDN is the fqdn to use
	FQDN string `json:"fqdn,omitempty"`
}

type Service interface {
	// List returns all the containers
	List(ctx context.Context, all bool) ([]Container, error)
	// Start starts a stopped container
	Start(ctx context.Context, containerID string) error
	// Stop stops the running container
	Stop(ctx context.Context, containerID string, timeout *uint32) error
	// Kill stops the running container
	Kill(ctx context.Context, containerID string, signal string) error
	// Run creates and starts a container
	Run(ctx context.Context, config ContainerConfig) error
	// Exec executes a command inside a running container
	Exec(ctx context.Context, containerName string, request ExecRequest) error
	// Logs returns all the logs of a container
	Logs(ctx context.Context, containerName string, request LogsRequest) error
	// Delete removes containers
	Delete(ctx context.Context, containerID string, request DeleteRequest) error
	// Inspect get a specific container
	Inspect(ctx context.Context, id string) (Container, error)
}