models

Type Members

1. sealed trait BuildMessage extends AnyRef

   

2. case class ContainerConfig(image: ImageName, entryPoint: Option[Seq[String]] = None, command: Seq[String] = Seq.empty, environmentVariables: Seq[String] = Seq.empty, exposedPorts: Seq[Port] = Seq.empty, volumes: Seq[String] = Seq.empty, workingDir: Option[String] = None, user: Option[String] = None, hostname: Option[String] = None, domainName: Option[String] = None, resourceLimits: ContainerResourceLimits = ContainerResourceLimits(), standardStreams: StandardStreamsConfig = StandardStreamsConfig(), labels: Map[String, String] = Map.empty, networkDisabled: Boolean = false) extends Product with Serializable

   

   Configuration for a container.

   Configuration for a container.

   image

   Image to run.

   entryPoint

   Entry point for the container.

   command

   Command to run.

   environmentVariables

   Environment variables.

   exposedPorts

   Ports that the container should expose.

   volumes

   Paths inside the container that should be exposed.

   workingDir

   Working directory for commands to run in.

   user

   Username or UID.

   hostname

   Container hostname.

   domainName

   Container domain name.

   resourceLimits

   Resource limits.

   standardStreams

   Configuration for standard streams.

   labels

   Labels for the container.

   networkDisabled

   Disable network for the container.

3. case class ContainerHashId(hash: String) extends ContainerId with Product with Serializable

   

4. sealed trait ContainerId extends AnyRef

   

5. case class ContainerInfo(id: ContainerHashId, created: DateTime, path: String, args: Seq[String], config: ContainerConfig, state: ContainerState, image: String, networkSettings: NetworkSettings, resolvConfPath: String, hostnamePath: String, hostsPath: String, name: String, driver: String, execDriver: String, mountLabel: Option[String] = None, processLabel: Option[String] = None, volumes: Seq[VolumeBinding] = Seq.empty, hostConfig: HostConfig) extends Product with Serializable

   

6. case class ContainerLink(containerName: String, aliasName: Option[String] = None) extends Product with Serializable

   

7. case class ContainerName(name: String) extends ContainerId with Product with Serializable

   

8. case class ContainerResourceLimits(memory: Long = 0, memorySwap: Long = 0, cpuShares: Long = 0, cpuset: Option[String] = None) extends Product with Serializable

   

   Resource limitations on a container.

   Resource limitations on a container.

   memory

   Memory limit, in bytes.

   memorySwap

   Total memory limit (memory + swap), in bytes. Set -1 to disable swap.

   cpuShares

   CPU shares (relative weight vs. other containers)

   cpuset

   CPUs in which to allow execution, examples: "0-2", "0,1".

9. case class ContainerState(running: Boolean, paused: Boolean, restarting: Boolean, pid: Int, exitCode: Int, startedAt: Option[DateTime] = None, finishedAt: Option[DateTime] = None) extends Product with Serializable

   

10. case class ContainerStatus(command: String, created: DateTime, id: ContainerHashId, image: ImageName, names: Seq[String], ports: Map[Port, Seq[PortBinding]] = Map.empty, labels: Map[String, String] = Map.empty, status: String) extends Product with Serializable

    

11. case class CreateContainerResponse(id: ContainerHashId, warnings: Seq[String]) extends Product with Serializable

    

12. case class DeviceMapping(pathOnHost: String, pathInContainer: String, cgroupPermissions: String) extends Product with Serializable

    

13. case class HostConfig(portBindings: Map[Port, Seq[PortBinding]] = Map.empty, publishAllPorts: Boolean = false, links: Seq[ContainerLink] = Seq.empty, volumeBindings: Seq[VolumeBinding] = Seq.empty, volumesFrom: Seq[String] = Seq.empty, devices: Seq[DeviceMapping] = Seq.empty, readOnlyRootFilesystem: Boolean = false, dnsServers: Seq[String] = Seq.empty, dnsSearchDomains: Seq[String] = Seq.empty, networkMode: Option[String] = None, privileged: Boolean = false, capabilities: LinuxCapabilities = LinuxCapabilities(), restartPolicy: RestartPolicy = NeverRestart) extends Product with Serializable

    

    Host configuration for a container.

    Host configuration for a container.

    portBindings

    A map of exposed container ports to bindings on the host.

    publishAllPorts

    Allocate a random port for each exposed container port.

    links

    Container links.

    volumeBindings

    Volume bindings.

    volumesFrom

    Volumes to inherit from other containers.

    devices

    Devices to add to the container.

    readOnlyRootFilesystem

    Mount the container's root filesystem as read only.

    dnsServers

    DNS servers for the container to use.

    dnsSearchDomains

    DNS search domains.

    networkMode

    Networking mode for the container

    privileged

    Gives the container full access to the host.

    capabilities

    Change Linux kernel capabilities for the container.

    restartPolicy

    Behavior to apply when the container exits.

14. case class Image(created: DateTime, id: ImageId, parentId: ImageId, repoTags: Seq[ImageName], labels: Map[String, String], size: Long, virtualSize: Long) extends Product with Serializable

    

15. case class ImageId(hash: String) extends ImageIdentifier with Product with Serializable

    

16. sealed trait ImageIdentifier extends AnyRef

    

17. case class ImageName(registry: Option[String] = None, namespace: Option[String] = None, repository: String, tag: String = "latest") extends ImageIdentifier with Product with Serializable

    

18. sealed trait ImageTransferMessage extends AnyRef

    

19. case class LinuxCapabilities(add: Seq[String] = Seq.empty, drop: Seq[String] = Seq.empty) extends Product with Serializable

    
    add

    Kernel capabilities to add to the container

    drop

    Kernel capabilities to drop from the container.

20. case class NetworkSettings(ipAddress: String, ipPrefixLength: Int, gateway: String, bridge: String, ports: Map[Port, Seq[PortBinding]]) extends Product with Serializable

    

21. sealed trait Port extends AnyRef

    

22. case class PortBinding(hostIp: String = "0.0.0.0", hostPort: Int) extends Product with Serializable

    

23. case class RegistryAuth(url: Uri, username: String, password: String) extends Product with Serializable

    

24. case class RegistryAuthConfig(username: String, password: String) extends Product with Serializable

    

25. case class RegistryAuthEntry(auth: String) extends Product with Serializable

    

26. sealed trait RemoveImageMessage extends AnyRef

    

27. case class RestartOnFailure(maximumRetryCount: Int = 0) extends RestartPolicy with Product with Serializable

    

28. trait RestartPolicy extends AnyRef

    

29. sealed trait RunMessage extends AnyRef

    

30. case class StandardStreamsConfig(attachStdIn: Boolean = false, attachStdOut: Boolean = false, attachStdErr: Boolean = false, tty: Boolean = false, openStdin: Boolean = false, stdinOnce: Boolean = false) extends Product with Serializable

    

    Configuration options for standard streams.

    Configuration options for standard streams.

    attachStdIn

    Attach to standard input.

    attachStdOut

    Attach to standard output.

    attachStdErr

    Attach to standard error.

    tty

    Attach standard streams to a tty.

    openStdin

    Keep stdin open even if not attached.

    stdinOnce

    Close stdin when one attached client disconnects.

31. case class VolumeBinding(hostPath: String, containerPath: String, rw: Boolean = true) extends Product with Serializable