Stack.Types.Docker

Docker types.

Documentation

data DockerException

Type representing exceptions thrown by functions exported by the Stack.Docker module.

Constructors

DockerMustBeEnabledException

Docker must be enabled to use the command.

OnlyOnHostException

Command must be run on host OS (not in a container).

InspectFailedException String

docker inspect failed.

NotPulledException String

Image does not exist.

InvalidImagesOutputException String

Invalid output from docker images.

InvalidPSOutputException String

Invalid output from docker ps.

InvalidInspectOutputException String

Invalid output from docker inspect.

PullFailedException String

Could not pull a Docker image.

DockerTooOldException Version Version

Installed version of docker below minimum version.

DockerVersionProhibitedException [Version] Version

Installed version of docker is prohibited.

BadDockerVersionException VersionRange Version

Installed version of docker is out of range specified in config file.

InvalidVersionOutputException

Invalid output from docker --version.

HostStackTooOldException Version (Maybe Version)

Version of stack on host is too old for version in image.

ContainerStackTooOldException Version Version

Version of stack in container/image is too old for version on host.

CannotDetermineProjectRootException

Can't determine the project root (where to put docker sandbox).

DockerNotInstalledException

docker --version failed.

UnsupportedStackExeHostPlatformException

Using host stack-exe on unsupported platform.

DockerStackExeParseException String

stack-exe option fails to parse.

Instances

Exception DockerException

Defined in Stack.Types.Docker

Methods

toException :: DockerException -> SomeException

fromException :: SomeException -> Maybe DockerException

displayException :: DockerException -> String

Show DockerException

Defined in Stack.Types.Docker

Methods

showsPrec :: Int -> DockerException -> ShowS

show :: DockerException -> String

showList :: [DockerException] -> ShowS

data DockerMonoidRepoOrImage

Options for Docker repository or image.

Constructors

DockerMonoidRepo String

DockerMonoidImage String

Instances

Show DockerMonoidRepoOrImage

Defined in Stack.Types.Docker

Methods

showsPrec :: Int -> DockerMonoidRepoOrImage -> ShowS

show :: DockerMonoidRepoOrImage -> String

showList :: [DockerMonoidRepoOrImage] -> ShowS

data DockerOpts

Docker configuration.

Constructors

DockerOpts

Fields

• enable :: !Bool

  Is using Docker enabled?

• image :: !(Either SomeException String)

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

• registryLogin :: !Bool

  Does registry require login for pulls?

• registryUsername :: !(Maybe String)

  Optional username for Docker registry.

• registryPassword :: !(Maybe String)

  Optional password for Docker registry.

• autoPull :: !Bool

  Automatically pull new images.

• detach :: !Bool

  Whether to run a detached container

• persist :: !Bool

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

• containerName :: !(Maybe String)

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

• network :: !(Maybe String)

  The network docker uses.

• runArgs :: ![String]

  Arguments to pass directly to docker run.

• mount :: ![Mount]

  Volumes to mount in the container.

• mountMode :: !(Maybe String)

  Volume mount mode

• env :: ![String]

  Environment variables to set in the container.

• stackExe :: !(Maybe DockerStackExe)

  Location of container-compatible Stack executable

• setUser :: !(Maybe Bool)

  Set in-container user to match host's

• requireDockerVersion :: !VersionRange

  Require a version of Docker within this range.

Instances

Show DockerOpts

Defined in Stack.Types.Docker

Methods

showsPrec :: Int -> DockerOpts -> ShowS

show :: DockerOpts -> String

showList :: [DockerOpts] -> ShowS

data DockerOptsMonoid

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

Constructors

DockerOptsMonoid

Fields

• defaultEnable :: !Any

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

• enable :: !(First Bool)

  Is using Docker enabled?

• repoOrImage :: !(First DockerMonoidRepoOrImage)

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

• registryLogin :: !(First Bool)

  Does registry require login for pulls?

• registryUsername :: !(First String)

  Optional username for Docker registry.

• registryPassword :: !(First String)

  Optional password for Docker registry.

• autoPull :: !FirstTrue

  Automatically pull new images.

• detach :: !FirstFalse

  Whether to run a detached container

• persist :: !FirstFalse

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

• containerName :: !(First String)

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

• network :: !(First String)

  See: dockerNetwork

• runArgs :: ![String]

  Arguments to pass directly to docker run

• mount :: ![Mount]

  Volumes to mount in the container

• mountMode :: !(First String)

  Volume mount mode

• env :: ![String]

  Environment variables to set in the container

• stackExe :: !(First DockerStackExe)

  Location of container-compatible Stack executable

• setUser :: !(First Bool)

  Set in-container user to match host's

• requireDockerVersion :: !IntersectingVersionRange

  See: dockerRequireDockerVersion

Instances

Monoid DockerOptsMonoid

Left-biased combine Docker options

Defined in Stack.Types.Docker

Methods

mempty :: DockerOptsMonoid

mappend :: DockerOptsMonoid -> DockerOptsMonoid -> DockerOptsMonoid

mconcat :: [DockerOptsMonoid] -> DockerOptsMonoid

Semigroup DockerOptsMonoid

Left-biased combine Docker options

Defined in Stack.Types.Docker

Methods

(<>) :: DockerOptsMonoid -> DockerOptsMonoid -> DockerOptsMonoid

sconcat :: NonEmpty DockerOptsMonoid -> DockerOptsMonoid

stimes :: Integral b => b -> DockerOptsMonoid -> DockerOptsMonoid

Generic DockerOptsMonoid

Defined in Stack.Types.Docker

Associated Types

type Rep DockerOptsMonoid :: Type -> Type

Methods

from :: DockerOptsMonoid -> Rep DockerOptsMonoid x

to :: Rep DockerOptsMonoid x -> DockerOptsMonoid

Show DockerOptsMonoid

Defined in Stack.Types.Docker

Methods

showsPrec :: Int -> DockerOptsMonoid -> ShowS

show :: DockerOptsMonoid -> String

showList :: [DockerOptsMonoid] -> ShowS

FromJSON (WithJSONWarnings DockerOptsMonoid)

Decode uninterpreted docker options from JSON/YAML.

Defined in Stack.Types.Docker

Methods

parseJSON :: Value -> Parser (WithJSONWarnings DockerOptsMonoid)

parseJSONList :: Value -> Parser [WithJSONWarnings DockerOptsMonoid]

type Rep DockerOptsMonoid

Defined in Stack.Types.Docker

type Rep DockerOptsMonoid = D1 ('MetaData "DockerOptsMonoid" "Stack.Types.Docker" "stack-3.1.1-I5OI2i8TUoz1thruFO0H72" 'False) (C1 ('MetaCons "DockerOptsMonoid" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "defaultEnable") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Any) :*: S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First Bool))) :*: (S1 ('MetaSel ('Just "repoOrImage") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First DockerMonoidRepoOrImage)) :*: S1 ('MetaSel ('Just "registryLogin") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First Bool)))) :*: ((S1 ('MetaSel ('Just "registryUsername") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First String)) :*: S1 ('MetaSel ('Just "registryPassword") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First String))) :*: (S1 ('MetaSel ('Just "autoPull") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FirstTrue) :*: (S1 ('MetaSel ('Just "detach") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FirstFalse) :*: S1 ('MetaSel ('Just "persist") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FirstFalse))))) :*: (((S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First String)) :*: S1 ('MetaSel ('Just "network") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First String))) :*: (S1 ('MetaSel ('Just "runArgs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [String]) :*: S1 ('MetaSel ('Just "mount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Mount]))) :*: ((S1 ('MetaSel ('Just "mountMode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First String)) :*: S1 ('MetaSel ('Just "env") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [String])) :*: (S1 ('MetaSel ('Just "stackExe") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First DockerStackExe)) :*: (S1 ('MetaSel ('Just "setUser") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First Bool)) :*: S1 ('MetaSel ('Just "requireDockerVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IntersectingVersionRange)))))))

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

FromJSON DockerStackExe

Defined in Stack.Types.Docker

Methods

parseJSON :: Value -> Parser DockerStackExe

parseJSONList :: Value -> Parser [DockerStackExe]

Show DockerStackExe

Defined in Stack.Types.Docker

Methods

showsPrec :: Int -> DockerStackExe -> ShowS

show :: DockerStackExe -> String

showList :: [DockerStackExe] -> ShowS

data Mount

Docker volume mount.

Constructors

Mount String String

Instances

FromJSON Mount

For YAML.

Defined in Stack.Types.Docker

Methods

parseJSON :: Value -> Parser Mount

parseJSONList :: Value -> Parser [Mount]

Read Mount

For optparse-applicative.

Defined in Stack.Types.Docker

Methods

readsPrec :: Int -> ReadS Mount

readList :: ReadS [Mount]

readPrec :: ReadPrec Mount

readListPrec :: ReadPrec [Mount]

Show Mount

Show instance.

Defined in Stack.Types.Docker

Methods

showsPrec :: Int -> Mount -> ShowS

show :: Mount -> String

showList :: [Mount] -> ShowS

newtype VersionRangeJSON

Newtype for non-orphan FromJSON instance.

Constructors

VersionRangeJSON

Fields

• versionRangeJSON :: VersionRange

Instances

FromJSON VersionRangeJSON

Parse VersionRange.

Defined in Stack.Types.Docker

Methods

parseJSON :: Value -> Parser VersionRangeJSON

parseJSONList :: Value -> Parser [VersionRangeJSON]

dockerAutoPullArgName :: Text

Docker auto-pull argument name.

dockerCmdName :: String

Command-line argument for "docker"

dockerContainerNameArgName :: Text

Docker container name argument name.

dockerContainerPlatform :: Platform

Platform that Docker containers run

dockerDetachArgName :: Text

Docker detach argument name.

dockerEnableArgName :: Text

Docker enable argument name.

dockerEntrypointArgName :: String

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

dockerEnvArgName :: Text

Docker environment variable argument name.

dockerHelpOptName :: String

dockerImageArgName :: Text

Docker image argument name.

dockerMountArgName :: Text

Docker mount argument name.

dockerMountModeArgName :: Text

Docker mount mode argument name.

dockerNetworkArgName :: Text

Docker container name argument name.

dockerPersistArgName :: Text

Docker persist argument name.

dockerPullCmdName :: String

Command-line argument for docker pull.

dockerRegistryLoginArgName :: Text

Docker registry login argument name.

dockerRegistryPasswordArgName :: Text

Docker registry password argument name.

dockerRegistryUsernameArgName :: Text

Docker registry username argument name.

dockerRepoArgName :: Text

Docker repo arg argument name.

dockerRequireDockerVersionArgName :: Text

Docker require-version argument name

dockerRunArgsArgName :: Text

Docker run args argument name.

dockerSetUserArgName :: Text

Docker set-user argument name

dockerStackExeArgName :: Text

Docker Stack executable 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

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

Parse DockerStackExe.

reExecArgName :: String

Command-line option for --internal-re-exec-version.