config

type CPU interface {
	// RequestedMillicores returns the requested number of CPU millicores for use
	// by the container.
	RequestedMillicores() int
	// MaxMillicores returns the maximum number of CPU millicores usable by
	// the container.
	MaxMillicores() int
}

type CPUArch string

type Config interface {
	// AllJobs returns a list of all Jobs
	AllJobs() []Job
	// Jobs returns an ordered list of Jobs given the provided jobNames.
	Jobs(jobNames ...string) ([]Job, error)
	// AllPipelines returns a list of all Pipelines
	AllPipelines() []Pipeline
	// Pipelines returns an ordered list of Pipelines given the provided
	// pipelineNames.
	Pipelines(pipelineNames ...string) ([]Pipeline, error)
}

type Container interface {
	// Name returns the container's name
	Name() string
	// Image returns the name of the OCI image used by the container
	Image() string
	// ImagePullPolicy returns the name of the pull policy, which indicates
	// whether to settle for existing images (if they already exist) or attempt
	// to refresh them by re-pulling
	ImagePullPolicy() ImagePullPolicy
	// Environment returns container-specific environment variables
	Environment() map[string]string
	// WorkingDirectory returns the container's working directory
	WorkingDirectory() string
	// Command returns the command (entrypoint) that should be run in the
	// container
	Command() []string
	// Args returns the arguments for the command
	Args() []string
	// TTY returns an indicator of whether the container should use TTY or not
	TTY() bool
	// Privileged returns an indicator of whether the container should be
	// privileged
	Privileged() bool
	// MountDockerSocket returns an indicator of whether the container should
	// mount the Docker socket or not
	MountDockerSocket() bool
	// SourceMountPath returns a path to where project source should be mounted
	// into the container
	SourceMountPath() string
	// SharedStorageMountPath returns a path to where shared storage should be
	// mounted into the container
	SharedStorageMountPath() string
	// Returns the resource configuration (CPU and memory) for the container
	Resources() Resources
}

type ImagePullPolicy string

type Job interface {
	// Name returns the job's name
	Name() string
	// PrimaryContainer returns this job's primary container
	PrimaryContainer() Container
	// SidecarContainers returns this job's sidecar containers
	SidecarContainers() []Container
	// SourceMountMode returns the job's SourceMountMode
	SourceMountMode() SourceMountMode
	// OSFamily returns the job's OSFamily
	OSFamily() OSFamily
	// CPUArch returns the job's CPU architecture
	CPUArch() CPUArch
	// TimeoutSeconds returns the maximum number of seconds to wait for the job to complete.
	// An empty (zero) value disables the timeout.
	TimeoutSeconds() int64
}

type Memory interface {
	// RequestedMegabytes returns the requested amount of memory (in megabytes)
	// for use by the container.
	RequestedMegabytes() int
	// MaxMegabytes returns the maximum amount of memory (in megabytes) usable
	// by the container.
	MaxMegabytes() int
}

type OSFamily string

type Pipeline interface {
	// Name returns the pipeline's name
	Name() string
	// Triggers returns all the triggers that can trigger the pipeline
	Triggers() []PipelineTrigger
	// Jobs returns all the jobs that comprise the pipeline
	Jobs() []PipelineJob
}

type PipelineJob interface {
	Job() Job
	Dependencies() []PipelineJob
}

type PipelineTrigger interface {
	SpecURI() string
	SpecVersion() string
	Config() []byte
}

type Resources interface {
	// CPU returns container CPU configuration
	CPU() CPU
	// Memory returns container memory configuration
	Memory() Memory
}

type SourceMountMode string