Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for MemorySwappiness #1547

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/main/asciidoc/inc/external/_property_configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,9 @@ See <<list-properties>>.
| *docker.memorySwap*
| Total memory limit (memory + swap) in bytes. Set `docker.memorySwap` equal to `docker.memory` to disable swap. Set to `-1` to allow unlimited swap.

| *docker.memorySwappiness*
| Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.

| *docker.name*
| Image name

Expand Down
3 changes: 3 additions & 0 deletions src/main/asciidoc/inc/start/_configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ The `<run>` configuration element knows the following sub elements:
| *memorySwap*
| Total memory limit (memory + swap) in bytes. Set `memorySwap` equal to `memory` to disable swap. Set to `-1` to allow unlimited swap.

| *memorySwappiness*
| Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.

| *namingStrategy*
a| *This option is deprecated, please use a `containerNamePattern` instead* Naming strategy for how the container name is created:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@

import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import io.fabric8.maven.docker.config.LogConfiguration;
import io.fabric8.maven.docker.config.UlimitConfig;
import io.fabric8.maven.docker.util.EnvUtil;
import io.fabric8.maven.docker.util.JsonFactory;

import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import io.fabric8.maven.docker.config.LogConfiguration;
import io.fabric8.maven.docker.config.UlimitConfig;
import io.fabric8.maven.docker.util.EnvUtil;
import io.fabric8.maven.docker.util.JsonFactory;

public class ContainerHostConfig {

final JsonObject startConfig = new JsonObject();
Expand Down Expand Up @@ -63,6 +62,10 @@ public ContainerHostConfig memorySwap(Long memorySwap) {
return add("MemorySwap", memorySwap);
}

public ContainerHostConfig memorySwappiness(Long memorySwappiness) {
return add("MemorySwappiness", memorySwappiness);
}

public ContainerHostConfig dns(List<String> dns) {
return addAsArray("Dns", dns);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ public class RunImageConfiguration implements Serializable {
@Parameter
private Long memorySwap;

// Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
@Parameter
private Long memorySwappiness;

// Path to a file where the dynamically mapped properties are written to
@Parameter
private String portPropertyFile;
Expand Down Expand Up @@ -274,6 +278,10 @@ public Long getMemorySwap() {
return memorySwap;
}

public Long getMemorySwappiness() {
return memorySwappiness;
}

public String getIsolation() {
return isolation;
}
Expand Down Expand Up @@ -537,6 +545,11 @@ public Builder memorySwap(Long memorySwap) {
return this;
}

public Builder memorySwappiness(Long memorySwappiness) {
config.memorySwappiness = memorySwappiness;
return this;
}

public Builder capAdd(List<String> capAdd) {
config.capAdd = capAdd;
return this;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
package io.fabric8.maven.docker.config.handler.compose;

import java.io.*;
import java.util.*;

import io.fabric8.maven.docker.config.*;
import io.fabric8.maven.docker.config.BuildImageConfiguration;
import io.fabric8.maven.docker.config.ImageConfiguration;
import io.fabric8.maven.docker.config.RunImageConfiguration;
import io.fabric8.maven.docker.config.handler.ExternalConfigHandler;
import io.fabric8.maven.docker.config.handler.ExternalConfigHandlerException;
import io.fabric8.maven.docker.util.DeepCopy;
Expand All @@ -14,6 +13,15 @@
import org.apache.maven.shared.filtering.MavenReaderFilterRequest;
import org.yaml.snakeyaml.Yaml;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.Reader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import static io.fabric8.maven.docker.config.handler.compose.ComposeUtils.resolveAbsolutely;
import static io.fabric8.maven.docker.config.handler.compose.ComposeUtils.resolveComposeFileAbsolutely;

Expand Down Expand Up @@ -205,6 +213,7 @@ private RunImageConfiguration createRunConfiguration(DockerComposeServiceWrapper
// mac_address n.s.
.memory(wrapper.getMemory())
.memorySwap(wrapper.getMemorySwap())
.memorySwappiness(wrapper.getMemorySwappiness())
.privileged(wrapper.getPrivileged())
// read_only n.s.
.restartPolicy(wrapper.getRestartPolicy())
Expand Down
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
package io.fabric8.maven.docker.config.handler.compose;

import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import io.fabric8.maven.docker.config.Arguments;
import io.fabric8.maven.docker.config.ImageConfiguration;
import io.fabric8.maven.docker.config.LogConfiguration;
import io.fabric8.maven.docker.config.NetworkConfig;
import io.fabric8.maven.docker.config.RestartPolicy;
import io.fabric8.maven.docker.config.RunVolumeConfiguration;
import io.fabric8.maven.docker.config.UlimitConfig;
import io.fabric8.maven.docker.config.*;
import io.fabric8.maven.docker.util.VolumeBindingUtil;

import java.io.File;
import java.util.*;


class DockerComposeServiceWrapper {

Expand Down Expand Up @@ -309,6 +298,10 @@ Long getMemorySwap() {
return asLong("memswap_limit");
}

Long getMemorySwappiness() {
return asLong("mem_swappiness");
}

Boolean getPrivileged() {
return asBoolean("privileged");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ public enum ConfigKey {
MAINTAINER,
MEMORY,
MEMORY_SWAP,
MEMORY_SWAPPINESS,
NAME,
NAMING_STRATEGY,
NET,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,35 +15,17 @@
* limitations under the License.
*/

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.function.Supplier;

import io.fabric8.maven.docker.config.Arguments;
import io.fabric8.maven.docker.config.AssemblyConfiguration;
import io.fabric8.maven.docker.config.BuildImageConfiguration;
import io.fabric8.maven.docker.config.BuildXConfiguration;
import io.fabric8.maven.docker.config.CopyConfiguration;
import io.fabric8.maven.docker.config.HealthCheckConfiguration;
import io.fabric8.maven.docker.config.ImageConfiguration;
import io.fabric8.maven.docker.config.LogConfiguration;
import io.fabric8.maven.docker.config.NetworkConfig;
import io.fabric8.maven.docker.config.RestartPolicy;
import io.fabric8.maven.docker.config.RunImageConfiguration;
import io.fabric8.maven.docker.config.RunVolumeConfiguration;
import io.fabric8.maven.docker.config.UlimitConfig;
import io.fabric8.maven.docker.config.WaitConfiguration;
import io.fabric8.maven.docker.config.WatchImageConfiguration;
import io.fabric8.maven.docker.config.*;
import io.fabric8.maven.docker.config.handler.ExternalConfigHandler;
import io.fabric8.maven.docker.util.EnvUtil;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.CollectionUtils;

import java.io.File;
import java.util.*;
import java.util.function.Supplier;

import static io.fabric8.maven.docker.config.handler.property.ConfigKey.*;

/**
Expand Down Expand Up @@ -216,6 +198,7 @@ private RunImageConfiguration extractRunConfiguration(ImageConfiguration fromCon
.links(valueProvider.getList(LINKS, config.getLinks()))
.memory(valueProvider.getLong(MEMORY, config.getMemory()))
.memorySwap(valueProvider.getLong(MEMORY_SWAP, config.getMemorySwap()))
.memorySwappiness(valueProvider.getLong(MEMORY_SWAPPINESS, config.getMemorySwappiness()))
.namingStrategy(valueProvider.getString(NAMING_STRATEGY, config.getNamingStrategy() == null ? null : config.getNamingStrategy().name()))
.exposedPropertyKey(valueProvider.getString(EXPOSED_PROPERTY_KEY, config.getExposedPropertyKey()))
.portPropertyFile(valueProvider.getString(PORT_PROPERTY_FILE, config.getPortPropertyFile()))
Expand Down
74 changes: 13 additions & 61 deletions src/main/java/io/fabric8/maven/docker/service/RunService.java
Original file line number Diff line number Diff line change
@@ -1,73 +1,24 @@
package io.fabric8.maven.docker.service;

import static io.fabric8.maven.docker.util.VolumeBindingUtil.resolveRelativeVolumeBindings;

/*
*
* Copyright 2014 Roland Huss
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import java.io.File;
import java.time.temporal.ChronoUnit;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.StringJoiner;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;

import io.fabric8.maven.docker.access.ContainerCreateConfig;
import io.fabric8.maven.docker.access.ContainerHostConfig;
import io.fabric8.maven.docker.access.ContainerNetworkingConfig;
import io.fabric8.maven.docker.access.DockerAccess;
import io.fabric8.maven.docker.access.DockerAccessException;
import io.fabric8.maven.docker.access.ExecException;
import io.fabric8.maven.docker.access.NetworkCreateConfig;
import io.fabric8.maven.docker.access.PortMapping;
import io.fabric8.maven.docker.config.Arguments;
import io.fabric8.maven.docker.config.ImageConfiguration;
import io.fabric8.maven.docker.config.NetworkConfig;
import io.fabric8.maven.docker.config.RestartPolicy;
import io.fabric8.maven.docker.config.RunImageConfiguration;
import io.fabric8.maven.docker.config.RunVolumeConfiguration;
import io.fabric8.maven.docker.config.StopMode;
import io.fabric8.maven.docker.config.VolumeConfiguration;
import io.fabric8.maven.docker.access.*;
import io.fabric8.maven.docker.config.*;
import io.fabric8.maven.docker.log.LogOutputSpecFactory;
import io.fabric8.maven.docker.model.Container;
import io.fabric8.maven.docker.model.ContainerDetails;
import io.fabric8.maven.docker.model.ExecDetails;
import io.fabric8.maven.docker.model.Network;
import io.fabric8.maven.docker.model.PortBindingException;
import io.fabric8.maven.docker.model.*;
import io.fabric8.maven.docker.service.ContainerTracker.ContainerShutdownDescriptor;
import io.fabric8.maven.docker.util.ContainerNamingUtil;
import io.fabric8.maven.docker.util.EnvUtil;
import io.fabric8.maven.docker.util.GavLabel;
import io.fabric8.maven.docker.util.Logger;
import io.fabric8.maven.docker.util.StartOrderResolver;
import io.fabric8.maven.docker.util.*;
import io.fabric8.maven.docker.wait.WaitTimeoutException;
import io.fabric8.maven.docker.wait.WaitUtil;
import net.jodah.failsafe.Failsafe;
import net.jodah.failsafe.RetryPolicy;

import java.io.File;
import java.time.temporal.ChronoUnit;
import java.util.*;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;

import static io.fabric8.maven.docker.util.VolumeBindingUtil.resolveRelativeVolumeBindings;

/**
* Service class for helping in running containers.
*
Expand Down Expand Up @@ -430,6 +381,7 @@ ContainerHostConfig createContainerHostConfig(RunImageConfiguration runConfig, P
.securityOpts(runConfig.getSecurityOpts())
.memory(runConfig.getMemory())
.memorySwap(runConfig.getMemorySwap())
.memorySwappiness(runConfig.getMemorySwappiness())
.restartPolicy(restartPolicy.getName(), restartPolicy.getRetry())
.logConfig(runConfig.getLogConfiguration())
.tmpfs(runConfig.getTmpfs())
Expand Down
20 changes: 12 additions & 8 deletions src/test/java/io/fabric8/maven/docker/UrlBuilderTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,19 @@
* limitations under the License.
*/

import java.io.UnsupportedEncodingException;
import java.net.*;
import java.util.HashMap;

import io.fabric8.maven.docker.access.BuildOptions;
import io.fabric8.maven.docker.access.CreateImageOptions;
import io.fabric8.maven.docker.access.UrlBuilder;
import io.fabric8.maven.docker.util.ImageName;
import org.junit.Test;

import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URLEncoder;
import java.util.HashMap;

import static org.junit.Assert.*;

/**
Expand All @@ -49,14 +52,15 @@ public void buildImage() throws URISyntaxException {
HashMap<String, String> options = new HashMap<>();
options.put("cpusetcpus", "1");
options.put("memswap", "-1");
assertEquals("/1.0/build?buildargs=%7B%22k1%22%3A%22v1%22%2C%22k2%22%3A%22v2%22%7D&cpusetcpus=1&memswap=-1&t=image1",
options.put("memswappiness", "-1"); // TODO is this right?
assertEquals("/1.0/build?buildargs=%7B%22k1%22%3A%22v1%22%2C%22k2%22%3A%22v2%22%7D&cpusetcpus=1&memswap=-1&memswappiness=-1&t=image1",
builder.buildImage("image1", new BuildOptions(options).buildArgs(m)));
options.put("dockerfile","blub");
assertEquals("/1.0/build?cpusetcpus=1&dockerfile=bla&memswap=-1&t=image1",
assertEquals("/1.0/build?cpusetcpus=1&dockerfile=bla&memswap=-1&memswappiness=-1&t=image1",
builder.buildImage("image1", new BuildOptions(options).dockerfile("bla")));
assertEquals("/1.0/build?cpusetcpus=1&dockerfile=holla&memswap=-1&t=image1",
assertEquals("/1.0/build?cpusetcpus=1&dockerfile=holla&memswap=-1&memswappiness=-1&t=image1",
builder.buildImage("image1", new BuildOptions(options).dockerfile("bla").addOption("dockerfile","holla")));
assertEquals("/1.0/build?cpusetcpus=1&dockerfile=bla&memswap=-1&squash=1&t=image1",
assertEquals("/1.0/build?cpusetcpus=1&dockerfile=bla&memswap=-1&memswappiness=-1&squash=1&t=image1",
builder.buildImage("image1", new BuildOptions(options).dockerfile("bla").squash(true)));

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ protected void validateRunConfiguration(RunImageConfiguration runConfig) {
assertEquals(a("redis"), runConfig.getLinks());
assertEquals((Long) 1L, runConfig.getMemory());
assertEquals((Long) 1L, runConfig.getMemorySwap());
assertEquals((Long) 1L, runConfig.getMemorySwappiness());
assertEquals((Long) 1000000000L, runConfig.getCpus());
assertEquals("default", runConfig.getIsolation());
assertEquals((Long) 1L, runConfig.getCpuShares());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ void validateRunConfiguration(RunImageConfiguration runConfig) {
assertEquals(a("redis","link1"), runConfig.getLinks());
assertEquals((Long) 1L, runConfig.getMemory());
assertEquals((Long) 1L, runConfig.getMemorySwap());
assertEquals((Long) 1L, runConfig.getMemorySwappiness());
assertEquals("0,1", runConfig.getCpuSet());
assertEquals((Long)1000000000L, runConfig.getCpus());
assertEquals("default", runConfig.getIsolation());
Expand Down
Loading