engine

type Auth struct {
	Address  string `json:"address,omitempty"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

type Docker struct {
	// contains filtered or unexported fields
}

type Engine interface {
	// Setup the pipeline environment.
	Setup(context.Context, *Spec) error

	// Destroy the pipeline environment.
	Destroy(context.Context, *Spec) error

	// Run runs the pipeline step.
	Run(context.Context, *Spec, *Step, io.Writer) (*State, error)
}

type ErrPolicy int

type Network struct {
	ID      string            `json:"id,omitempty"`
	Labels  map[string]string `json:"labels,omitempty"`
	Options map[string]string `json:"options,omitempty"`
}

type Opts struct {
	HidePull bool
}

type Platform struct {
	OS   string `json:"os,omitempty"`
	Arch string `json:"arch,omitempty"`
}

type PullPolicy int

type RunPolicy int

type Secret struct {
	Name string `json:"name,omitempty"`
	Env  string `json:"env,omitempty"`
	Data []byte `json:"data,omitempty"`
	Mask bool   `json:"mask,omitempty"`
}

type Spec struct {
	Platform Platform  `json:"platform,omitempty"`
	Steps    []*Step   `json:"steps,omitempty"`
	Internal []*Step   `json:"internal,omitempty"`
	Volumes  []*Volume `json:"volumes,omitempty"`
	Network  Network   `json:"network"`
}

type State struct {
	// ExitCode returns the exit code of the exited step.
	ExitCode int

	// GetExited reports whether the step has exited.
	Exited bool

	// OOMKilled reports whether the step has been
	// killed by the process manager.
	OOMKilled bool
}

type Step struct {
	ID           string            `json:"id,omitempty"`
	Auth         *Auth             `json:"auth,omitempty"`
	Command      []string          `json:"args,omitempty"`
	CPUPeriod    int64             `json:"cpu_period,omitempty"`
	CPUQuota     int64             `json:"cpu_quota,omitempty"`
	CPUShares    int64             `json:"cpu_shares,omitempty"`
	CPUSet       []string          `json:"cpu_set,omitempty"`
	Detach       bool              `json:"detach,omitempty"`
	DependsOn    []string          `json:"depends_on,omitempty"`
	Devices      []*VolumeDevice   `json:"devices,omitempty"`
	DNS          []string          `json:"dns,omitempty"`
	DNSSearch    []string          `json:"dns_search,omitempty"`
	Entrypoint   []string          `json:"entrypoint,omitempty"`
	Envs         map[string]string `json:"environment,omitempty"`
	ErrPolicy    ErrPolicy         `json:"err_policy,omitempty"`
	ExtraHosts   []string          `json:"extra_hosts,omitempty"`
	IgnoreStdout bool              `json:"ignore_stderr,omitempty"`
	IgnoreStderr bool              `json:"ignore_stdout,omitempty"`
	Image        string            `json:"image,omitempty"`
	Labels       map[string]string `json:"labels,omitempty"`
	MemSwapLimit int64             `json:"memswap_limit,omitempty"`
	MemLimit     int64             `json:"mem_limit,omitempty"`
	Name         string            `json:"name,omitempty"`
	Network      string            `json:"network,omitempty"`
	Networks     []string          `json:"networks,omitempty"`
	Privileged   bool              `json:"privileged,omitempty"`
	Pull         PullPolicy        `json:"pull,omitempty"`
	RunPolicy    RunPolicy         `json:"run_policy,omitempty"`
	Secrets      []*Secret         `json:"secrets,omitempty"`
	ShmSize      int64             `json:"shm_size,omitempty"`
	User         string            `json:"user,omitempty"`
	Volumes      []*VolumeMount    `json:"volumes,omitempty"`
	WorkingDir   string            `json:"working_dir,omitempty"`

	Display string
}

type Volume struct {
	EmptyDir *VolumeEmptyDir `json:"temp,omitempty"`
	HostPath *VolumeHostPath `json:"host,omitempty"`
}

type VolumeDevice struct {
	Name       string `json:"name,omitempty"`
	DevicePath string `json:"path,omitempty"`
}

type VolumeEmptyDir struct {
	ID        string            `json:"id,omitempty"`
	Name      string            `json:"name,omitempty"`
	Medium    string            `json:"medium,omitempty"`
	SizeLimit int64             `json:"size_limit,omitempty"`
	Labels    map[string]string `json:"labels,omitempty"`
}

type VolumeHostPath struct {
	ID       string            `json:"id,omitempty"`
	Name     string            `json:"name,omitempty"`
	Path     string            `json:"path,omitempty"`
	Labels   map[string]string `json:"labels,omitempty"`
	ReadOnly bool              `json:"read_only,omitempty"`
}

type VolumeMount struct {
	Name string `json:"name,omitempty"`
	Path string `json:"path,omitempty"`
}