org.eclipse.jkube.kit.config.image

Class RunImageConfiguration.RunImageConfigurationBuilder

java.lang.Object

org.eclipse.jkube.kit.config.image.RunImageConfiguration.RunImageConfigurationBuilder

Enclosing class:

RunImageConfiguration

public static class RunImageConfiguration.RunImageConfigurationBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
RunImageConfiguration.RunImageConfigurationBuilder	autoRemove(Boolean autoRemove) Automatically remove the container when it exists.
RunImageConfiguration	build()
RunImageConfiguration.RunImageConfigurationBuilder	capAdd(List<String> capAdd)
RunImageConfiguration.RunImageConfigurationBuilder	capDrop(List<String> capDrop)
RunImageConfiguration.RunImageConfigurationBuilder	cmd(Arguments cmd) Command to execute in container.
RunImageConfiguration.RunImageConfigurationBuilder	containerNamePattern(String containerNamePattern) A pattern to define the naming of the container where: %a for the "alias" mode %n for the image name %t for a timestamp %i for an increasing index of container names
RunImageConfiguration.RunImageConfigurationBuilder	cpus(Long cpus)
RunImageConfiguration.RunImageConfigurationBuilder	cpuSet(String cpuSet)
RunImageConfiguration.RunImageConfigurationBuilder	cpuShares(Long cpuShares)
RunImageConfiguration.RunImageConfigurationBuilder	dependsOn(List<String> dependsOn)
RunImageConfiguration.RunImageConfigurationBuilder	dns(List<String> dns)
RunImageConfiguration.RunImageConfigurationBuilder	dnsSearch(List<String> dnsSearch)
RunImageConfiguration.RunImageConfigurationBuilder	domainname(String domainname) Container domain name.
RunImageConfiguration.RunImageConfigurationBuilder	entrypoint(Arguments entrypoint) Container entry point.
RunImageConfiguration.RunImageConfigurationBuilder	env(Map<String,String> env) Environment variables to set when starting the container.
RunImageConfiguration.RunImageConfigurationBuilder	envPropertyFile(String envPropertyFile) Path to a property file holding environment variables.
RunImageConfiguration.RunImageConfigurationBuilder	exposedPropertyKey(String exposedPropertyKey) Property key part used to expose the container ip when running.
RunImageConfiguration.RunImageConfigurationBuilder	extraHosts(List<String> extraHosts)
RunImageConfiguration.RunImageConfigurationBuilder	hostname(String hostname) Container hostname.
RunImageConfiguration.RunImageConfigurationBuilder	imagePullPolicy(String imagePullPolicy) Policy for pulling the image to start
RunImageConfiguration.RunImageConfigurationBuilder	labels(Map<String,String> labels)
RunImageConfiguration.RunImageConfigurationBuilder	links(List<String> links) Links to other container started.
RunImageConfiguration.RunImageConfigurationBuilder	log(LogConfiguration log)
RunImageConfiguration.RunImageConfigurationBuilder	memory(Long memory) Memory in bytes.
RunImageConfiguration.RunImageConfigurationBuilder	memorySwap(Long memorySwap) Total memory (swap + ram) in bytes, -1 to disable.
RunImageConfiguration.RunImageConfigurationBuilder	net(String net) For simple network setups.
RunImageConfiguration.RunImageConfigurationBuilder	network(NetworkConfig network)
RunImageConfiguration.RunImageConfigurationBuilder	portPropertyFile(String portPropertyFile) Path to a file where the dynamically mapped properties are written to.
RunImageConfiguration.RunImageConfigurationBuilder	ports(List<String> ports) Port mapping.
RunImageConfiguration.RunImageConfigurationBuilder	privileged(Boolean privileged)
RunImageConfiguration.RunImageConfigurationBuilder	readOnly(Boolean readOnly) Mount the container's root filesystem as read only.
RunImageConfiguration.RunImageConfigurationBuilder	restartPolicy(RestartPolicy restartPolicy)
RunImageConfiguration.RunImageConfigurationBuilder	securityOpts(List<String> securityOpts)
RunImageConfiguration.RunImageConfigurationBuilder	shmSize(Long shmSize) Size of /dev/shm in bytes.
RunImageConfiguration.RunImageConfigurationBuilder	skip(Boolean skip)
RunImageConfiguration.RunImageConfigurationBuilder	tmpfs(List<String> tmpfs) Mountpath for tmps.
String	toString()
RunImageConfiguration.RunImageConfigurationBuilder	ulimits(List<UlimitConfig> ulimits)
RunImageConfiguration.RunImageConfigurationBuilder	user(String user) Container user.
RunImageConfiguration.RunImageConfigurationBuilder	volumes(RunVolumeConfiguration volumes) Mount volumes from the given image's started containers.
RunImageConfiguration.RunImageConfigurationBuilder	wait(WaitConfiguration wait) Configuration for how to wait during startup of the container.
RunImageConfiguration.RunImageConfigurationBuilder	workingDir(String workingDir) Working directory.

Methods inherited from class java.lang.Object

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

Method Detail

env

public RunImageConfiguration.RunImageConfigurationBuilder env(Map<String,String> env)

Environment variables to set when starting the container. key: variable name, value: env value.

Returns:

this.

labels

public RunImageConfiguration.RunImageConfigurationBuilder labels(Map<String,String> labels)

envPropertyFile

public RunImageConfiguration.RunImageConfigurationBuilder envPropertyFile(String envPropertyFile)

Path to a property file holding environment variables.

Returns:

this.

cmd

public RunImageConfiguration.RunImageConfigurationBuilder cmd(Arguments cmd)

Command to execute in container.

Returns:

this.

domainname

public RunImageConfiguration.RunImageConfigurationBuilder domainname(String domainname)

Container domain name.

Returns:

this.

dependsOn

public RunImageConfiguration.RunImageConfigurationBuilder dependsOn(List<String> dependsOn)

entrypoint

public RunImageConfiguration.RunImageConfigurationBuilder entrypoint(Arguments entrypoint)

Container entry point.

Returns:

this.

hostname

public RunImageConfiguration.RunImageConfigurationBuilder hostname(String hostname)

Container hostname.

Returns:

this.

user

public RunImageConfiguration.RunImageConfigurationBuilder user(String user)

Container user.

Returns:

this.

workingDir

public RunImageConfiguration.RunImageConfigurationBuilder workingDir(String workingDir)

Working directory.

Returns:

this.

shmSize

public RunImageConfiguration.RunImageConfigurationBuilder shmSize(Long shmSize)

Size of /dev/shm in bytes.

Returns:

this.

memory

public RunImageConfiguration.RunImageConfigurationBuilder memory(Long memory)

Memory in bytes.

Returns:

this.

memorySwap

public RunImageConfiguration.RunImageConfigurationBuilder memorySwap(Long memorySwap)

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

Returns:

this.

portPropertyFile

public RunImageConfiguration.RunImageConfigurationBuilder portPropertyFile(String portPropertyFile)

Path to a file where the dynamically mapped properties are written to.

Returns:

this.

net

public RunImageConfiguration.RunImageConfigurationBuilder net(String net)

For simple network setups. For complex stuff use "network".

Returns:

this.

network

public RunImageConfiguration.RunImageConfigurationBuilder network(NetworkConfig network)

dns

public RunImageConfiguration.RunImageConfigurationBuilder dns(List<String> dns)

dnsSearch

public RunImageConfiguration.RunImageConfigurationBuilder dnsSearch(List<String> dnsSearch)

capAdd

public RunImageConfiguration.RunImageConfigurationBuilder capAdd(List<String> capAdd)

capDrop

public RunImageConfiguration.RunImageConfigurationBuilder capDrop(List<String> capDrop)

securityOpts

public RunImageConfiguration.RunImageConfigurationBuilder securityOpts(List<String> securityOpts)

privileged

public RunImageConfiguration.RunImageConfigurationBuilder privileged(Boolean privileged)

extraHosts

public RunImageConfiguration.RunImageConfigurationBuilder extraHosts(List<String> extraHosts)

cpuShares

public RunImageConfiguration.RunImageConfigurationBuilder cpuShares(Long cpuShares)

cpus

public RunImageConfiguration.RunImageConfigurationBuilder cpus(Long cpus)

cpuSet

public RunImageConfiguration.RunImageConfigurationBuilder cpuSet(String cpuSet)

ports

public RunImageConfiguration.RunImageConfigurationBuilder ports(List<String> ports)

Port mapping. Can contain symbolic names in which case dynamic ports are used.

Returns:

this.

containerNamePattern

public RunImageConfiguration.RunImageConfigurationBuilder containerNamePattern(String containerNamePattern)

A pattern to define the naming of the container where:

• %a for the "alias" mode
• %n for the image name
• %t for a timestamp
• %i for an increasing index of container names

Returns:

this.

exposedPropertyKey

public RunImageConfiguration.RunImageConfigurationBuilder exposedPropertyKey(String exposedPropertyKey)

Property key part used to expose the container ip when running.

Returns:

this.

volumes

public RunImageConfiguration.RunImageConfigurationBuilder volumes(RunVolumeConfiguration volumes)

Mount volumes from the given image's started containers.

Returns:

this.

links

public RunImageConfiguration.RunImageConfigurationBuilder links(List<String> links)

Links to other container started.

Returns:

this.

wait

public RunImageConfiguration.RunImageConfigurationBuilder wait(WaitConfiguration wait)

Configuration for how to wait during startup of the container.

Returns:

this.

tmpfs

public RunImageConfiguration.RunImageConfigurationBuilder tmpfs(List<String> tmpfs)

Mountpath for tmps.

Returns:

this.

log

public RunImageConfiguration.RunImageConfigurationBuilder log(LogConfiguration log)

restartPolicy

public RunImageConfiguration.RunImageConfigurationBuilder restartPolicy(RestartPolicy restartPolicy)

ulimits

public RunImageConfiguration.RunImageConfigurationBuilder ulimits(List<UlimitConfig> ulimits)

skip

public RunImageConfiguration.RunImageConfigurationBuilder skip(Boolean skip)

imagePullPolicy

public RunImageConfiguration.RunImageConfigurationBuilder imagePullPolicy(String imagePullPolicy)

Policy for pulling the image to start

Returns:

this.

readOnly

public RunImageConfiguration.RunImageConfigurationBuilder readOnly(Boolean readOnly)

Mount the container's root filesystem as read only.

Returns:

this.

autoRemove

public RunImageConfiguration.RunImageConfigurationBuilder autoRemove(Boolean autoRemove)

Automatically remove the container when it exists.

Returns:

this.

build

public RunImageConfiguration build()

toString

public String toString()

Overrides:

toString in class Object