TestContainers.Docker.Network

Network

type NetworkId = Text

Identifies a network within the Docker runtime. Assigned by docker network create

Since: 0.5.0.0

data Network

Handle to a Docker network.

Since: 0.5.0.0

networkId :: Network -> NetworkId

Returns the id of the network.

Since: 0.5.0.0

Creating networks

fromExistingNetwork :: NetworkId -> TestContainer Network

Creates a Network from an existing NetworkId. Note that the Network is not managed by the TestContainer monad and as such is not being cleaned up afterwards.

Since: 0.5.1.0

createNetwork :: NetworkRequest -> TestContainer Network

Creates a new Network from a NetworkRequest.

Since: 0.5.0.0

data NetworkRequest

Parameters for creating a new Docker network.

Since: 0.5.0.0

Instances

WithoutReaper NetworkRequest

Defined in TestContainers.Docker.Network

Methods

withoutReaper :: NetworkRequest -> NetworkRequest

networkRequest :: NetworkRequest

Default parameters for creating a new Docker network.

Since: 0.5.0.0

withDriver :: Text -> NetworkRequest -> NetworkRequest

Driver to manage the Network (default "bridge").

Since: 0.5.0.0

withIpv6 :: NetworkRequest -> NetworkRequest

Enable IPv6 for the Docker network.

Since: 0.5.0.0

withoutReaper :: WithoutReaper request => request -> request

Do not register the docker resource (container, register, etc.) with the resource reaper. Careful, doing this will make your container leak on shutdown if not explicitly stopped.

Since: 0.5.1.0