stack-1.3.2: The Haskell Tool Stack

Safe HaskellNone
LanguageHaskell2010

Stack.Types.Docker

Description

Docker types.

Synopsis

Documentation

data DockerOpts #

Docker configuration.

Constructors

DockerOpts 

Fields

data DockerOptsMonoid #

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

Constructors

DockerOptsMonoid 

Fields

Instances

Show DockerOptsMonoid # 
Generic DockerOptsMonoid # 
Monoid DockerOptsMonoid #

Left-biased combine Docker options

FromJSON (WithJSONWarnings DockerOptsMonoid) #

Decode uninterpreted docker options from JSON/YAML.

type Rep DockerOptsMonoid # 
type Rep DockerOptsMonoid = D1 (MetaData "DockerOptsMonoid" "Stack.Types.Docker" "stack-1.3.2-H9eUSuCMcHMCG52xX8jGAi" False) (C1 (MetaCons "DockerOptsMonoid" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "dockerMonoidDefaultEnable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Any)) (S1 (MetaSel (Just Symbol "dockerMonoidEnable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "dockerMonoidRepoOrImage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First DockerMonoidRepoOrImage))) (S1 (MetaSel (Just Symbol "dockerMonoidRegistryLogin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "dockerMonoidRegistryUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First String))) (S1 (MetaSel (Just Symbol "dockerMonoidRegistryPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First String)))) ((:*:) (S1 (MetaSel (Just Symbol "dockerMonoidAutoPull") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) (S1 (MetaSel (Just Symbol "dockerMonoidDetach") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "dockerMonoidPersist") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) (S1 (MetaSel (Just Symbol "dockerMonoidContainerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First String)))) ((:*:) (S1 (MetaSel (Just Symbol "dockerMonoidRunArgs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [String])) (S1 (MetaSel (Just Symbol "dockerMonoidMount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Mount])))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "dockerMonoidEnv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [String])) (S1 (MetaSel (Just Symbol "dockerMonoidDatabasePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First (Path Abs File))))) ((:*:) (S1 (MetaSel (Just Symbol "dockerMonoidStackExe") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First DockerStackExe))) ((:*:) (S1 (MetaSel (Just Symbol "dockerMonoidSetUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) (S1 (MetaSel (Just Symbol "dockerMonoidRequireDockerVersion") 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

data Mount #

Docker volume mount.

Constructors

Mount String String 

Instances

Read Mount #

For optparse-applicative.

Show Mount #

Show instance.

Methods

showsPrec :: Int -> Mount -> ShowS #

show :: Mount -> String #

showList :: [Mount] -> ShowS #

FromJSON Mount #

For YAML.

newtype VersionRangeJSON #

Newtype for non-orphan FromJSON instance.

data StackDockerException #

Exceptions thrown by Stack.Docker.

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.

InvalidCleanupCommandException String

Input to docker cleanup has invalid command.

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.

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)

dockerCmdName :: String #

Command-line argument for "docker"

dockerPullCmdName :: String #

Command-line argument for docker pull.

dockerCleanupCmdName :: String #

Command-line argument for docker cleanup.

reExecArgName :: String #

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

dockerContainerPlatform :: Platform #

Platform that Docker containers run