Stack.Docker

Run commands in Docker containers

Documentation

dockerCmdName :: String

Command-line argument for "docker"

dockerHelpOptName :: String

dockerPullCmdName :: String

Command-line argument for docker pull.

entrypoint :: (HasProcessContext env, HasLogFunc env) => Config -> DockerEntrypoint -> RIO env ()

The Docker container "entrypoint": special actions performed when first entering a container, such as switching the UID/GID to the "outside-Docker" user's.

preventInContainer :: MonadIO m => m () -> m ()

Error if running in a container.

pull :: HasConfig env => RIO env ()

Pull latest version of configured Docker image from registry.

reset :: HasConfig env => Bool -> RIO env ()

Remove the project's Docker sandbox.

reExecArgName :: String

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

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

getProjectRoot :: HasConfig env => RIO env (Path Abs Dir)

Fail with friendly error if project root not set.

runContainerAndExit :: HasConfig env => RIO env void

Run a command in a new Docker container, then exit the process.