Support for specifying hard and soft memory limits

Author: Chris Birchall

config/src/main/scala/com/whisk/docker/config/DockerTypesafeConfig.scala

@@ -50,7 +50,9 @@ object DockerTypesafeConfig extends DockerKitDockerJava {
                           `environmental-variables`: Seq[String] = Seq.empty,
                           `port-maps`: Option[Map[String, DockerConfigPortMap]],
                           `ready-checker`: Option[DockerConfigReadyChecker],
-                          `volume-maps`: Seq[VolumeMapping] = Seq.empty) {
+                          `volume-maps`: Seq[VolumeMapping] = Seq.empty,
+                          memory: Option[Long],
+                          `memory-reservation`: Option[Long]) {
 
     def toDockerContainer(): DockerContainer = {
       val bindPorts = `port-maps`.fold(EmptyPortBindings) { _.values.map(_.asTuple).toMap } mapValues {
@@ -68,7 +70,9 @@ object DockerTypesafeConfig extends DockerKitDockerJava {
         bindPorts = bindPorts,
         env = `environmental-variables`,
         readyChecker = readyChecker,
-        volumeMappings = `volume-maps`
+        volumeMappings = `volume-maps`,
+        memory = memory,
+        memoryReservation = `memory-reservation`
       )
     }
   }

config/src/test/resources/application.conf

@@ -84,6 +84,8 @@ docker {
   elasticsearch {
     image-name = "elasticsearch:1.7.1"
     entrypoint = [ "my", "custom", "entrypoint" ]
+    memory = 536870912 # 512MB
+    memory-reservation = 268435456 # 256MB
     ready-checker {
       http-response-code {
         port = 9200

config/src/test/scala/com/whisk/docker/config/test/DockerConfigSpec.scala

@@ -40,6 +40,8 @@ class DockerConfigSpec extends FlatSpec with Matchers with DockerKitConfig {
     val elasticExpected = DockerContainer("elasticsearch:1.7.1")
       .withEntrypoint("my", "custom", "entrypoint")
       .withPorts(9200 -> None, 9300 -> None)
+      .withMemory(536870912)
+      .withMemoryReservation(268435456)
       .withReadyChecker(
         DockerReadyChecker
           .HttpResponseCode(9200, "/")

core/src/main/scala/com/whisk/docker/DockerContainer.scala

@@ -30,6 +30,8 @@ case class DockerContainer(image: String,
                            logLineReceiver: Option[LogLineReceiver] = None,
                            user: Option[String] = None,
                            hostname: Option[String] = None,
+                           memory: Option[Long] = None,
+                           memoryReservation: Option[Long] = None,
                            hostConfig: Option[HostConfig] = None) {
 
   def withCommand(cmd: String*) = copy(command = Some(cmd))
@@ -63,5 +65,16 @@ case class DockerContainer(image: String,
 
   def withHostname(hostname: String) = copy(hostname = Some(hostname))
 
+  /**
+    * Set the hard limit on memory usage (in bytes)
+    */
+  def withMemory(memory: Long) = copy(memory = Some(memory))
+
+  /**
+    * Set the soft limit on memory usage (in bytes)
+    */
+  def withMemoryReservation(memoryReservation: Long) = copy(memoryReservation = Some(memoryReservation))
+
   def withHostConfig(hostConfig: HostConfig) = copy(hostConfig = Some(hostConfig))
+
 }

impl/docker-java/src/main/scala/com/whisk/docker/impl/dockerjava/DockerJavaExecutor.scala

@@ -61,6 +61,10 @@ class DockerJavaExecutor(override val host: String, client: DockerClient)
       .withOption(spec.name) { case (config, name) => config.withName(name) }
       .withOption(spec.command) { case (config, c) => config.withCmd(c: _*) }
       .withOption(spec.entrypoint) { case (config, entrypoint) => config.withEntrypoint(entrypoint: _*) }
+      .withOption(spec.memory) { case (config, memory) => config.withMemory(memory) }
+      .withOption(spec.memoryReservation) { case (config, memoryReservation) =>
+        config.withHostConfig(config.getHostConfig.withMemoryReservation(memoryReservation))
+      }
 
     Future(cmd.exec()).map { resp =>
       if (resp.getId != null && resp.getId != "") {

impl/spotify/src/main/scala/com/whisk/docker/impl/spotify/SpotifyDockerCommandExecutor.scala

@@ -12,8 +12,7 @@ import com.spotify.docker.client.exceptions.ContainerNotFoundException
 import com.spotify.docker.client.messages.{
   ContainerConfig,
   HostConfig,
-  PortBinding,
-  AttachedNetwork
+  PortBinding
 }
 import com.spotify.docker.client.{DockerClient, LogMessage}
 import com.whisk.docker._
@@ -49,12 +48,12 @@ class SpotifyDockerCommandExecutor(override val host: String, client: DockerClie
       val hostConfigBuilder =
         if (links.isEmpty) hostConfigBase else hostConfigBase.links(links.asJava)
       hostConfigBuilder
-        .withOption(spec.networkMode) {
-          case (config, networkMode) => config.networkMode(networkMode)
-        }
         .withOption(spec.hostConfig.flatMap(_.tmpfs)) {
           case (config, value) => config.tmpfs(value.asJava)
         }
+        .withOption(spec.networkMode) { case (config, networkMode) => config.networkMode(networkMode) }
+        .withOption(spec.memory) { case (config, memory) => config.memory(memory) }
+        .withOption(spec.memoryReservation) { case (config, reservation) => config.memoryReservation(reservation) }
         .build()
     }