Stack.Types.Docker

Docker types.

Documentation

data DockerOpts

Docker configuration.

Constructors

DockerOpts

Fields

dockerEnable :: !Bool

Is using Docker enabled?

dockerImage :: !String

Exact Docker image tag or ID. Overrides docker-repo-*/tag.

dockerRegistryLogin :: !Bool

Does registry require login for pulls?

dockerRegistryUsername :: !(Maybe String)

Optional username for Docker registry.

dockerRegistryPassword :: !(Maybe String)

Optional password for Docker registry.

dockerAutoPull :: !Bool

Automatically pull new images.

dockerDetach :: !Bool

Whether to run a detached container

dockerPersist :: !Bool

Create a persistent container (don't remove it when finished). Implied by dockerDetach.

dockerContainerName :: !(Maybe String)

Container name to use, only makes sense from command-line with dockerPersist or dockerDetach.

dockerRunArgs :: ![String]

Arguments to pass directly to docker run.

dockerMount :: ![Mount]

Volumes to mount in the container.

dockerEnv :: ![String]

Environment variables to set in the container.

dockerDatabasePath :: !(Path Abs File)

Location of image usage database.

dockerStackExe :: !(Maybe DockerStackExe)

Location of container-compatible stack executable

dockerSetUser :: !(Maybe Bool)

Set in-container user to match host's

dockerRequireDockerVersion :: !VersionRange

Require a version of Docker within this range.

Instances

Show DockerOpts

data DockerOptsMonoid

An uninterpreted representation of docker options. Configurations may be "cascaded" using mappend (left-biased).

Constructors

DockerOptsMonoid

Fields

dockerMonoidDefaultEnable :: !Bool

Should Docker be defaulted to enabled (does docker: section exist in the config)?

dockerMonoidEnable :: !(Maybe Bool)

Is using Docker enabled?

dockerMonoidRepoOrImage :: !(Maybe DockerMonoidRepoOrImage)

Docker repository name (e.g. fpco/stack-build or fpco/stack-full:lts-2.8)

dockerMonoidRegistryLogin :: !(Maybe Bool)

Does registry require login for pulls?

dockerMonoidRegistryUsername :: !(Maybe String)

Optional username for Docker registry.

dockerMonoidRegistryPassword :: !(Maybe String)

Optional password for Docker registry.

dockerMonoidAutoPull :: !(Maybe Bool)

Automatically pull new images.

dockerMonoidDetach :: !(Maybe Bool)

Whether to run a detached container

dockerMonoidPersist :: !(Maybe Bool)

Create a persistent container (don't remove it when finished). Implied by dockerDetach.

dockerMonoidContainerName :: !(Maybe String)

Container name to use, only makes sense from command-line with dockerPersist or dockerDetach.

dockerMonoidRunArgs :: ![String]

Arguments to pass directly to docker run

dockerMonoidMount :: ![Mount]

Volumes to mount in the container

dockerMonoidEnv :: ![String]

Environment variables to set in the container

dockerMonoidDatabasePath :: !(Maybe String)

Location of image usage database.

dockerMonoidStackExe :: !(Maybe String)

Location of container-compatible stack executable

dockerMonoidSetUser :: !(Maybe Bool)

Set in-container user to match host's

dockerMonoidRequireDockerVersion :: !VersionRange

See: dockerRequireDockerVersion

Instances

Show DockerOptsMonoid

Monoid DockerOptsMonoid

Left-biased combine Docker options

FromJSON (WithJSONWarnings DockerOptsMonoid)

Decode uninterpreted docker options from JSON/YAML.

data DockerStackExe

Where to get the stack executable to run in Docker containers

Constructors

DockerStackExeDownload

Download from official bindist

DockerStackExeHost

Host's stack (linux-x86_64 only)

DockerStackExeImage

Docker image's stack (versions must match)

DockerStackExePath (Path Abs File)

Executable at given path

Instances

Show DockerStackExe

parseDockerStackExe :: MonadThrow m => String -> m DockerStackExe

Parse DockerStackExe.

data Mount

Docker volume mount.

Constructors

Mount String String

Instances

Read Mount

For optparse-applicative.

Show Mount

Show instance.

FromJSON Mount

For YAML.

data DockerMonoidRepoOrImage

Options for Docker repository or image.

Constructors

DockerMonoidRepo String

DockerMonoidImage String

Instances

Show DockerMonoidRepoOrImage

newtype VersionRangeJSON

Newtype for non-orphan FromJSON instance.

Constructors

VersionRangeJSON

Fields

unVersionRangeJSON :: VersionRange

Instances

FromJSON VersionRangeJSON

Parse VersionRange.

dockerEnableArgName :: Text

Docker enable argument name.

dockerRepoArgName :: Text

Docker repo arg argument name.

dockerImageArgName :: Text

Docker image argument name.

dockerRegistryLoginArgName :: Text

Docker registry login argument name.

dockerRegistryUsernameArgName :: Text

Docker registry username argument name.

dockerRegistryPasswordArgName :: Text

Docker registry password argument name.

dockerAutoPullArgName :: Text

Docker auto-pull argument name.

dockerDetachArgName :: Text

Docker detach argument name.

dockerRunArgsArgName :: Text

Docker run args argument name.

dockerMountArgName :: Text

Docker mount argument name.

dockerEnvArgName :: Text

Docker environment variable argument name.

dockerContainerNameArgName :: Text

Docker container name argument name.

dockerPersistArgName :: Text

Docker persist argument name.

dockerDatabasePathArgName :: Text

Docker database path argument name.

dockerStackExeArgName :: Text

Docker database path argument name.

dockerStackExeDownloadVal :: String

Value for --docker-stack-exe=download

dockerStackExeHostVal :: String

Value for --docker-stack-exe=host

dockerStackExeImageVal :: String

Value for --docker-stack-exe=image

dockerSetUserArgName :: Text

Docker set-user argument name

dockerRequireDockerVersionArgName :: Text

Docker require-version argument name

dockerEntrypointArgName :: String

Argument name used to pass docker entrypoint data (only used internally)