config

type AliasConfig struct {
	// Tasks The list of tasks
	// type: list of tasks
	Tasks []string `config:"required"`
	Annotations
}

type AnnotationFields struct {
	// Description Description of the resource. Adding a description to a
	// resource makes it visible from “dobi list“.
	Description string
	// Tags Tags can be used to group resources. There can be configured
	// multiple tags per resource. Adding a tag to a resource outputs a
	// grouped list from “dobi list -g“.
	Tags []string
}

type Annotations struct {
	// Description of a resource
	// Deprecated use Annotations.Description
	Description string `config:"validate"`
	Annotations AnnotationFields
}

type ComposeConfig struct {
	// Files The Compose files to use. This field supports :doc:`variables`.
	// type: list of filenames
	Files []string
	// Project The project name used by Compose. This field supports
	// :doc:`variables`.
	Project string `config:"required"`
	// StopGrace Seconds to wait for containers to stop before killing them.
	// default: “5“
	StopGrace int
	Dependent
	Annotations
}

type Config struct {
	FilePath   string
	Meta       *MetaConfig
	Resources  map[string]Resource
	WorkingDir string
}

type Dependent struct {
	// Depends The list of task dependencies.
	// type: list of tasks
	Depends []string
}

type Device struct {
	Host        string
	Container   string
	Permissions string
}

type EnvConfig struct {
	// Files List of files which contain environment variables
	// type: list of filenames
	Files []string
	// Variables List of environment variable “key=value“ pairs
	// type: list of environment variables
	Variables []string
	Annotations
}

type ImageConfig struct {
	// Image The name of the **image** without a tag. Tags must be specified
	// in the **tags** field. This field supports :doc:`variables`.
	Image string `config:"required,validate"`
	// Dockerfile The path to the “Dockerfile“ used to build the image. This
	// path is relative to “context“. Can not be used with “steps“
	Dockerfile string
	// Steps An inline Dockerfile used to build  the image. “steps“ can not
	// be used with the “dockerfile“ field.
	Steps string
	// Context The build context used to build the image.
	// default: “.“
	Context string
	// Args Build args used to build the image. Values in the mapping support
	// :doc:`variables`.
	// type: mapping “key: value“
	Args map[string]string
	// Target The target stage to build in a multi-stage Dockerfile. Defaults to
	// the last stage.
	Target string
	// PullBaseImageOnBuild If **true** the base image used in the
	// “Dockerfile“ will be pulled before building the image.
	PullBaseImageOnBuild bool
	// Pull Pull an image instead of building it. The value may be one of:
	// * “once“ - only pull if the image:tag does not exist
	// * “always“ - always pull the image
	// * “never“ - don't pull or build the image. Use one that is already present locally
	// * “<duration>“ - pull if the image hasn't been pulled in at least
	//   “duration“. The format of duration is a number followed by a single
	//   character time unit (ex: “40s“, “2h“, “30min“)
	// type: string
	// default: “always“
	Pull pull
	// Tags The image tags applied to the image before pushing the image to a
	// registry.  The first tag in the list is used when the image is built.
	// Each item in the list supports :doc:`variables`.
	// default: “['{unique}']“
	// type: list of tags
	Tags []string `config:"validate"`
	// NetworkMode The network mode to use for each step in the Dockerfile.
	NetworkMode string
	// CacheFrom A list of images to use as the cache for a build.
	CacheFrom []string
	Dependent
	Annotations
}

type JobConfig struct {
	// Use The name of an `image`_ resource. The referenced image is used
	// to created the container for the **job**.
	Use string `config:"required"`
	// Artifact File paths or globs identifying the files created by the **job**.
	// Paths to directories must end with a path separator (“/“).
	// Paths are relative to the “dobi.yaml“
	// type: list of file paths or glob patterns
	Artifact PathGlobs
	// Command The command to run in the container.
	// type: shell quoted string
	// example: “"bash -c 'echo something'"“
	Command ShlexSlice
	// Entrypoint Override the image entrypoint
	// type: shell quoted string
	Entrypoint ShlexSlice
	// Sources File paths or globs of the files used to create the
	// artifact. The modified time of these files are compared to the modified time
	// of the artifact to determine if the **job** is stale. If the **sources**
	// list is defined the modified time of **mounts** and the **use** image are
	// ignored.
	// type: list of file paths or glob patterns
	Sources PathGlobs
	// Mounts A list of `mount`_ resources to use when creating the container.
	// type: list of mount resources
	Mounts []string
	// Privileged Gives extended privileges to the container
	Privileged bool
	// Interactive Makes the container interative and enables a tty.
	Interactive bool
	// Env Environment variables to pass to the container. This field
	// supports :doc:`variables`.
	// type: list of “key=value“ strings
	Env []string
	// ProvideDocker Exposes the docker engine to the container by either
	// mounting the unix socket or setting the “DOCKER_HOST“ environment
	// variable. All environment variables with a  “DOCKER_“ prefix in the
	// environment are set on the container.
	ProvideDocker bool
	// NetMode The network mode to use. This field supports :doc:`variables`.
	NetMode string
	// WorkingDir The directory to set as the active working directory in the
	// container. This field supports :doc:`variables`.
	WorkingDir string
	// User Username or UID to use in the container. Format “user[:group]“.
	User string
	// Ports Publish ports to the host
	// type: list of 'host_port:container_port'
	Ports []string
	// Devices Maps the host devices you want to connect to a container
	// type: list of device specs
	// example: “{Host: /dev/fb0, Container: /dev/fb0, Permissions: rwm}“
	Devices []Device
	// Labels sets the labels of the running job container
	// type: map of string keys to string values
	Labels map[string]string
	Dependent
	Annotations
}

type MetaConfig struct {
	// Default The name of a task from the “dobi.yml“ to run when no
	// task name is specified on the command line.
	Default string

	// Project The name of the project. Used to create unique identifiers for
	// image tags and container names.
	// default: *basename of “dobi.yml“*
	Project string

	// Include A list of dobi configuration files to include. Paths are
	// relative to the current working directory. Includs can be partial
	// configs that depend on resources in any of the other included files.
	// type: list of file paths or glob patterns
	Include PathGlobs

	// ExecID A template value used as part of unique identifiers for image tags
	// and container names. This field supports :doc:`variables`. This value can
	// be overridden with the “$DOBI_EXEC_ID“ environment variable.
	// default: “{user.name}“
	ExecID string `config:"exec-id"`
}

type MountConfig struct {
	// Bind The host path to create and mount. This field supports expansion of
	// `~` to the current users home directory.
	Bind string
	// Path The container path of the mount
	Path string `config:"required"`
	// Name The name of a named volume
	Name string
	// ReadOnly Set the mount to be read-only
	ReadOnly bool
	// File When true create an empty file instead of a directory
	File bool
	// Mode The file mode to set on the host file or directory when it is
	// created.
	// default: “0755“ *(for directories)*, “0644“ *(for files)*
	Mode int `config:"validate"`
	Annotations
}

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

type Resolver interface {
	Resolve(tmpl string) (string, error)
	ResolveSlice(tmpls []string) ([]string, error)
}

type Resource interface {
	Dependencies() []string
	Validate(pth.Path, *Config) *pth.Error
	Resolve(Resolver) (Resource, error)
	Describe() string
	CategoryTags() []string
	String() string
}

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