Package com.bmuschko.gradle.docker.tasks.container

Class DockerCreateContainer.HostConfig

java.lang.Object

com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig

Enclosing class:

DockerCreateContainer

public static class DockerCreateContainer.HostConfig
extends Object

Since:

6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockerCreateContainer.HostConfig.LogConfig

Constructor Summary

Constructors

Constructor	Description
HostConfig(ObjectFactory objectFactory)

Method Summary

Modifier and Type	Method	Description
Property<Boolean>	getAutoRemove()	Automatically remove the container when the container's process exits.
MapProperty<String,String>	getBinds()
ListProperty<String>	getCapAdd()
ListProperty<String>	getCapDrop()
Property<String>	getCpuset()
ListProperty<String>	getDevices()
ListProperty<String>	getDns()
ListProperty<String>	getExtraHosts()
ListProperty<String>	getGroups()	A list of additional groups that the container process will run as.
Property<String>	getIpcMode()	The IPC mode for the container.
ListProperty<String>	getLinks()
Property<DockerCreateContainer.HostConfig.LogConfig>	getLogConfig()
Property<Long>	getMemory()
Property<Long>	getMemorySwap()
Property<String>	getNetwork()
ListProperty<String>	getPortBindings()
Property<Boolean>	getPrivileged()
Property<Boolean>	getPublishAll()
Property<String>	getRestartPolicy()
Property<Long>	getShmSize()	Size of /dev/shm in bytes.
MapProperty<String,String>	getSysctls()	The namespaced kernel parameters (sysctls) in the container.
MapProperty<String,String>	getTmpFs()	Docker container tmpfs support.
ListProperty<String>	getVolumesFrom()
void	logConfig(String type, Map<String,String> config)
void	restartPolicy(String name, int maximumRetryCount)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HostConfig

@Inject
public HostConfig(ObjectFactory objectFactory)

Method Detail

getGroups

@Input
@Optional
public final ListProperty<String> getGroups()

A list of additional groups that the container process will run as.

getMemory

@Input
@Optional
public final Property<Long> getMemory()

getMemorySwap

@Input
@Optional
public final Property<Long> getMemorySwap()

getCpuset

@Input
@Optional
public final Property<String> getCpuset()

getDns

@Input
@Optional
public final ListProperty<String> getDns()

getNetwork

@Input
@Optional
public final Property<String> getNetwork()

getLinks

@Input
@Optional
public final ListProperty<String> getLinks()

getVolumesFrom

@Input
@Optional
public final ListProperty<String> getVolumesFrom()

getPortBindings

@Input
@Optional
public final ListProperty<String> getPortBindings()

getPublishAll

@Input
@Optional
public final Property<Boolean> getPublishAll()

getBinds

@Input
@Optional
public final MapProperty<String,String> getBinds()

getTmpFs

@Input
@Optional
public final MapProperty<String,String> getTmpFs()

Docker container tmpfs support.

The key of this map is the container target path, the value stores the tmpfs comma-separated options.

For example, to create a temporary 50MB writeable non executable filesystem mounted under /data in the container: tmpFs = ['/data': 'rw,noexec,size=50m']

Original documentation

Since:

8.0.0

getExtraHosts

@Input
@Optional
public final ListProperty<String> getExtraHosts()

getLogConfig

@Input
@Optional
public final Property<DockerCreateContainer.HostConfig.LogConfig> getLogConfig()

getPrivileged

@Input
@Optional
public final Property<Boolean> getPrivileged()

getRestartPolicy

@Input
@Optional
public final Property<String> getRestartPolicy()

getDevices

@Input
@Optional
public final ListProperty<String> getDevices()

getCapAdd

@Input
@Optional
public final ListProperty<String> getCapAdd()

Since:

8.1.0

getCapDrop

@Input
@Optional
public final ListProperty<String> getCapDrop()

Since:

8.1.0

getShmSize

@Input
@Optional
public final Property<Long> getShmSize()

Size of /dev/shm in bytes.

The size must be greater than 0. If omitted the system uses 64MB.

getAutoRemove

@Input
@Optional
public final Property<Boolean> getAutoRemove()

Automatically remove the container when the container's process exits.

This has no effect if restartPolicy is set.

getIpcMode

@Input
@Optional
public final Property<String> getIpcMode()

The IPC mode for the container.

1. none - Own private IPC namespace, with /dev/shm not mounted.
2. private - Own private IPC namespace.
3. shareable" - Own private IPC namespace, with a possibility to share it with other containers.
4. container <_name-or-ID_> - Join another ("shareable") container’s IPC namespace.
5. host - Use the host system’s IPC namespace.

getSysctls

@Input
@Optional
public final MapProperty<String,String> getSysctls()

The namespaced kernel parameters (sysctls) in the container.

For example, to turn on IP forwarding in the containers network namespace: sysctls = ['net.ipv4.ip_forward':'1']

Note:

1. Not all sysctls are namespaced.
2. Docker does not support changing sysctls inside of a container that also modify the host system.

logConfig

public void logConfig(String type,
                      Map<String,String> config)

restartPolicy

public void restartPolicy(String name,
                          int maximumRetryCount)