runtime

type Container interface {
	Name() string
	Start(ctx context.Context) error
	Info(ctx context.Context) (*ContainerInfo, error)
	Logs(ctx context.Context, since time.Time) (logging.LogReader, error)
	Stats(ctx context.Context) (*ContainerStats, error)
	Stop(ctx context.Context, timeout *time.Duration) error
	Remove(ctx context.Context) error
}

type ContainerInfo struct {
	Labels map[string]string

	CreatedAt time.Time
	StartedAt time.Time
	EndedAt   time.Time

	Status   ContainerStatus
	Message  string
	ExitCode *int

	// Resource limits
	Memory   int64 // In bytes
	CPUCount float64

	TCPPorts []TCPPortBinding
}

type ContainerOpts struct {
	// (optional) Name to give the container; randomly generated if absent.
	Name string

	Image     *DockerImage
	Command   []string
	Arguments []string
	Env       map[string]string
	Labels    map[string]string
	Mounts    []Mount

	// Attach STDIN/STDOUT/STDERR and shell into the container.
	Interactive bool

	// Memory is a hard limit on the amount of memory a container can use.
	// Expressed as a number of bytes.
	Memory int64

	// SharedMemory is the size of /dev/shm in bytes.
	SharedMemory int64

	// CPUCount is a hard limit on the number of CPUs a container can use.
	CPUCount float64

	// CPUShares limit the amount of CPU a container can use relative to other containers.
	// Each container defaults to 1024 shares. During periods of CPU contention, CPU is limited
	// in proportion to the number of shares a container has e.g. a container with 2048
	// shares can use twice as much CPU as one with 1024 shares.
	//
	// CPUShares are ignored in the Kubernetes runtime.
	// CPUShares take precedence over CPUCount in the Docker and CRI runtimes.
	CPUShares int64

	// GPUs assigned to the container as IDs or indices.
	GPUs []string

	// (optional) User that will run commands inside the container. Also supports "user:group".
	// If not provided, the container is run as root.
	User string

	// (optional) Groups the container will run as.
	Groups []string

	// (optional) WorkingDir where the command will be launched.
	WorkingDir string

	// (optional) Container ports to be exposed on the host. A random, ephemeral
	// host port will be bound to each. Supports TCP only.
	TCPPorts []TCPPort

	// (optional) Hostname to use. Otherwise the default per the runtime is used.
	Hostname string
}

type ContainerStats struct {
	// Time marks the system time at which stats were sampled.
	Time time.Time

	// Stats describes all tracked container statistics, keyed by type. Not all
	// keys are guaranteed to be present.
	Stats map[StatType]float64
}

type ContainerStatus int

type DockerImage struct {
	// (required) Tag is a docker image refspec, as a tag or resolvable image hash.
	Tag string

	// (optional) Auth contains credentials for private registry access.
	Auth *RegistryAuth
}

type Mount struct {
	HostPath      string
	ContainerPath string
	ReadOnly      bool
}

type PullPolicy string

type RegistryAuth struct {
	ServerAddress string
	Username      string
	Password      string
}

type Runtime interface {
	io.Closer

	PullImage(ctx context.Context, image *DockerImage, policy PullPolicy, quiet bool) error
	CreateContainer(ctx context.Context, opts *ContainerOpts) (Container, error)
	ListContainers(ctx context.Context) ([]Container, error)
}

type StatType string

type TCPPort = int32

type TCPPortBinding struct {
	HostPort      TCPPort
	ContainerPort TCPPort
}