DockerTemplateOptions (Apache jclouds 2.0.0 API)

java.lang.Object
- org.jclouds.compute.options.RunScriptOptions
- - org.jclouds.compute.options.TemplateOptions
  - - org.jclouds.docker.compute.options.DockerTemplateOptions

All Implemented Interfaces:

Cloneable
```
public class DockerTemplateOptions
extends TemplateOptions
implements Cloneable
```
Contains options supported by the createNodes operation on the docker provider.
Usage
The recommended way to instantiate a DockerTemplateOptions object is to statically import DockerTemplateOptions.Builder.* and invoke one of the static creation methods, followed by an instance mutator if needed.
```
 import static org.jclouds.docker.compute.options.DockerTemplateOptions.Builder.*;

 ComputeService api = // get connection
 templateBuilder.options(inboundPorts(22, 80, 8080, 443));
 Set<? extends NodeMetadata> set = api.createNodesInGroup(tag, 2, templateBuilder.build());
 
```
Advanced Usage

In addition to basic configuration through its methods, this class also provides possibility to work directly with Docker API configuration object ( Config.Builder). When the configBuilder(org.jclouds.docker.domain.Config.Builder) is used to configure not-null configBuilder, then this configuration object takes precedence over the other configuration in this class (i.e. the other config entries are not used)

Note: The image property in the provided Config.Builder is rewritten by a placeholder value. The real value is configured by ComputeServiceAdapter.
```
 import static org.jclouds.docker.compute.options.DockerTemplateOptions.Builder.*;

 ComputeService api = // get connection
 DockerTemplateOptions options = DockerTemplateOptions.Builder
       .configBuilder(
                Config.builder().env(ImmutableList.<String> of("SSH_PORT=8822"))
                      .hostConfig(HostConfig.builder().networkMode("host").build()));
 templateBuilder.options(options);
 Set<? extends NodeMetadata> set = api.createNodesInGroup("sample-group", 1, templateBuilder.build());
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DockerTemplateOptions.Builder
- Nested classes/interfaces inherited from class org.jclouds.compute.options.TemplateOptions
  TemplateOptions.ImmutableTemplateOptions
- Nested classes/interfaces inherited from class org.jclouds.compute.options.RunScriptOptions
  RunScriptOptions.ImmutableRunScriptOptions

Nested Classes
Modifier and Type	Class and Description
`static class`	`DockerTemplateOptions.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Config.Builder`	`configBuilder`
`protected Integer`	`cpuShares`
`protected List<String>`	`dns`
`protected List<String>`	`env`
`protected Map<String,String>`	`extraHosts`
`protected String`	`hostname`
`protected Integer`	`memory`
`protected String`	`networkMode`
`protected boolean`	`openStdin`
`protected Map<Integer,Integer>`	`portBindings`
`protected boolean`	`privileged`
`protected Map<String,String>`	`volumes`
`protected List<String>`	`volumesFrom`

Fields inherited from class org.jclouds.compute.options.TemplateOptions
blockUntilRunning, inboundPorts, networks, nodeNames, NONE, privateKey, publicKey, script, securityGroups, tags, userMetadata

Fields inherited from class org.jclouds.compute.options.RunScriptOptions
authenticateSudo, blockOnComplete, loginPassword, loginPrivateKey, loginUser, port, runAsRoot, seconds, taskName, wrapInInitScript

Constructor Summary

Constructors
Constructor and Description

DockerTemplateOptions()

Constructors
Constructor and Description
`DockerTemplateOptions()`

Method Summary

Methods
Modifier and Type	Method and Description
`DockerTemplateOptions`	`authorizePublicKey(String publicKey)` authorize an rsa ssh key.
`DockerTemplateOptions`	`blockOnPort(int port, int seconds)` When the node is started, wait until the following port is active
`DockerTemplateOptions`	`blockUntilRunning(boolean blockUntilRunning)` Note
`DockerTemplateOptions`	`clone()`
`DockerTemplateOptions`	`commands(Iterable<String> commands)`
`DockerTemplateOptions`	`commands(String... commands)`
`DockerTemplateOptions`	`configBuilder(Config.Builder configBuilder)` This method sets Config.Builder configuration object, which can be used as a replacement for all the other settings from this class.
`void`	`copyTo(TemplateOptions to)`
`DockerTemplateOptions`	`cpuShares(Integer cpuShares)`
`DockerTemplateOptions`	`dns(Iterable<String> dns)`
`DockerTemplateOptions`	`dns(String... dns)`
`DockerTemplateOptions`	`dontAuthorizePublicKey()`
`DockerTemplateOptions`	`entrypoint(Iterable<String> entrypoint)`
`DockerTemplateOptions`	`entrypoint(String... entrypoint)`
`DockerTemplateOptions`	`env(Iterable<String> env)`
`DockerTemplateOptions`	`env(String... env)`
`boolean`	`equals(Object o)`
`DockerTemplateOptions`	`extraHosts(Map<String,String> extraHosts)` Set extra hosts file entries for a container.
`List<String>`	`getCommands()`
`Config.Builder`	`getConfigBuilder()`
`Integer`	`getCpuShares()`
`List<String>`	`getDns()`
`List<String>`	`getEntrypoint()`
`List<String>`	`getEnv()`
`Map<String,String>`	`getExtraHosts()`
`String`	`getHostname()`
`Integer`	`getMemory()`
`String`	`getNetworkMode()`
`boolean`	`getOpenStdin()`
`Map<Integer,Integer>`	`getPortBindings()`
`boolean`	`getPrivileged()`
`Map<String,String>`	`getVolumes()`
`List<String>`	`getVolumesFrom()`
`int`	`hashCode()`
`DockerTemplateOptions`	`hostname(String hostname)`
`DockerTemplateOptions`	`inboundPorts(int... ports)` Opens the set of ports to public access.
`DockerTemplateOptions`	`installPrivateKey(String privateKey)` replaces the rsa ssh key used at login.
`DockerTemplateOptions`	`memory(Integer memory)`
`DockerTemplateOptions`	`nameTask(String name)`
`DockerTemplateOptions`	`networkMode(String networkMode)` Sets the networking mode for the container.
`DockerTemplateOptions`	`networks(Iterable<String> networks)` Assigns the created nodes to these networks
`DockerTemplateOptions`	`nodeNames(Iterable<String> nodeNames)` specifies names to be used for the created nodes.
`DockerTemplateOptions`	`openStdin(boolean openStdin)` Keep `STDIN` open when running interactive workloads in the container.
`DockerTemplateOptions`	`overrideAuthenticateSudo(boolean authenticateSudo)`
`DockerTemplateOptions`	`overrideLoginCredentials(LoginCredentials overridingCredentials)`
`DockerTemplateOptions`	`overrideLoginPassword(String password)`
`DockerTemplateOptions`	`overrideLoginPrivateKey(String privateKey)`
`DockerTemplateOptions`	`overrideLoginUser(String loginUser)`
`DockerTemplateOptions`	`portBindings(Map<Integer,Integer> portBindings)` Set port bindings between the Docker host and a container.
`DockerTemplateOptions`	`privileged(boolean privileged)` By default, Docker containers are unprivileged and cannot execute privileged operations or access certain host devices.
`DockerTemplateOptions`	`runAsRoot(boolean runAsRoot)`
`DockerTemplateOptions`	`runScript(Statement script)` This script will be executed as the root user upon system startup.
`String`	`toString()`
`DockerTemplateOptions`	`userMetadata(Map<String,String> userMetadata)`
`DockerTemplateOptions`	`userMetadata(String key, String value)`
`DockerTemplateOptions`	`volumes(Map<String,String> volumes)`
`DockerTemplateOptions`	`volumesFrom(Iterable<String> volumesFrom)` Set list of containers to mount volumes from onto this container.

Methods inherited from class org.jclouds.compute.options.TemplateOptions
as, blockOnComplete, getGroups, getInboundPorts, getNetworks, getNodeNames, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, networks, runScript, securityGroups, securityGroups, shouldBlockUntilRunning, string, tags, wrapInInitScript

Methods inherited from class org.jclouds.compute.options.RunScriptOptions
copyTo, getLoginPassword, getLoginPrivateKey, getLoginUser, getPort, getSeconds, getTaskName, hasLoginPassword, hasLoginPasswordOption, hasLoginPrivateKey, hasLoginPrivateKeyOption, overrideLoginPassword, overrideLoginPrivateKey, shouldAuthenticateSudo, shouldBlockOnComplete, shouldRunAsRoot, shouldWrapInInitScript

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - dns
```
protected List<String> dns
```
  - hostname
```
@Nullable
protected String hostname
```
  - memory
```
@Nullable
protected Integer memory
```
  - cpuShares
```
@Nullable
protected Integer cpuShares
```
  - volumes
```
protected Map<String,String> volumes
```
  - env
```
@Nullable
protected List<String> env
```
  - portBindings
```
protected Map<Integer,Integer> portBindings
```
  - networkMode
```
@Nullable
protected String networkMode
```
  - extraHosts
```
protected Map<String,String> extraHosts
```
  - volumesFrom
```
protected List<String> volumesFrom
```
  - privileged
```
protected boolean privileged
```
  - openStdin
```
protected boolean openStdin
```
  - configBuilder
```
protected Config.Builder configBuilder
```
- Constructor Detail
  - DockerTemplateOptions
```
public DockerTemplateOptions()
```
- Method Detail
  - clone
```
public DockerTemplateOptions clone()
```
    Overrides:
    
    clone in class TemplateOptions
  - copyTo
```
public void copyTo(TemplateOptions to)
```
    Overrides:
    
    copyTo in class TemplateOptions
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class TemplateOptions
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class TemplateOptions
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class RunScriptOptions
  - volumes
```
public DockerTemplateOptions volumes(Map<String,String> volumes)
```
  - dns
```
public DockerTemplateOptions dns(Iterable<String> dns)
```
  - dns
```
public DockerTemplateOptions dns(String... dns)
```
  - hostname
```
public DockerTemplateOptions hostname(@Nullable
                             String hostname)
```
  - memory
```
public DockerTemplateOptions memory(@Nullable
                           Integer memory)
```
  - entrypoint
```
public DockerTemplateOptions entrypoint(Iterable<String> entrypoint)
```
  - entrypoint
```
public DockerTemplateOptions entrypoint(String... entrypoint)
```
  - commands
```
public DockerTemplateOptions commands(Iterable<String> commands)
```
  - commands
```
public DockerTemplateOptions commands(String... commands)
```
  - cpuShares
```
public DockerTemplateOptions cpuShares(@Nullable
                              Integer cpuShares)
```
  - env
```
public DockerTemplateOptions env(Iterable<String> env)
```
  - env
```
public DockerTemplateOptions env(String... env)
```
  - portBindings
```
public DockerTemplateOptions portBindings(Map<Integer,Integer> portBindings)
```
    Set port bindings between the Docker host and a container.
    The Map keys are host ports number, and the value for an entry is the container port number. This is the same order as the arguments for the --publish command-line option to docker run which is hostPort:containerPort.
    
    Parameters:
    portBindings - the map of host to container port bindings
  - networkMode
```
public DockerTemplateOptions networkMode(@Nullable
                                String networkMode)
```
    Sets the networking mode for the container.
    Supported values are: bridge, none, host, networkname, networkid or container:[name|id]
    
    Parameters:
    networkMode -
    
    Returns:
    this instance
  - extraHosts
```
public DockerTemplateOptions extraHosts(Map<String,String> extraHosts)
```
    Set extra hosts file entries for a container.
    The Map keys are host names, and the value is an IP address that can be accessed by the container. This is the same order as the arguments for the --add-host command-line option to docker run.
    
    Parameters:
    extraHosts - the map of host names to IP addresses
  - volumesFrom
```
public DockerTemplateOptions volumesFrom(Iterable<String> volumesFrom)
```
    Set list of containers to mount volumes from onto this container.
    
    Parameters:
    volumesFrom - the list of container names
  - privileged
```
public DockerTemplateOptions privileged(boolean privileged)
```
    By default, Docker containers are unprivileged and cannot execute privileged operations or access certain host devices.
    
    Parameters:
    privileged - Whether the container should run in privileged mode or not
    
    Returns:
    this instance
  - openStdin
```
public DockerTemplateOptions openStdin(boolean openStdin)
```
    Keep STDIN open when running interactive workloads in the container.
    
    Parameters:
    openStdin - Whether the container should keep STDIN open
    
    Returns:
    this instance
  - configBuilder
```
public DockerTemplateOptions configBuilder(Config.Builder configBuilder)
```
    This method sets Config.Builder configuration object, which can be used as a replacement for all the other settings from this class. Some values in the provided Config.Builder instance (the image name for instance) can be ignored or their value can be changed.
    
    Parameters:
    configBuilder - Config.Builder instance. This instance can be changed in this method!
  - getVolumes
```
public Map<String,String> getVolumes()
```
  - getDns
```
public List<String> getDns()
```
  - getVolumesFrom
```
public List<String> getVolumesFrom()
```
  - getHostname
```
public String getHostname()
```
  - getMemory
```
public Integer getMemory()
```
  - getEntrypoint
```
public List<String> getEntrypoint()
```
  - getCommands
```
public List<String> getCommands()
```
  - getCpuShares
```
public Integer getCpuShares()
```
  - getEnv
```
public List<String> getEnv()
```
  - getPortBindings
```
public Map<Integer,Integer> getPortBindings()
```
  - getNetworkMode
```
public String getNetworkMode()
```
  - getExtraHosts
```
public Map<String,String> getExtraHosts()
```
  - getPrivileged
```
public boolean getPrivileged()
```
  - getOpenStdin
```
public boolean getOpenStdin()
```
  - getConfigBuilder
```
public Config.Builder getConfigBuilder()
```
  - blockOnPort
```
public DockerTemplateOptions blockOnPort(int port,
                                int seconds)
```
    When the node is started, wait until the following port is active
    
    Overrides:
    
    blockOnPort in class TemplateOptions
  - inboundPorts
```
public DockerTemplateOptions inboundPorts(int... ports)
```
    Opens the set of ports to public access.
    
    Overrides:
    
    inboundPorts in class TemplateOptions
  - authorizePublicKey
```
public DockerTemplateOptions authorizePublicKey(String publicKey)
```
    authorize an rsa ssh key.
    
    Overrides:
    
    authorizePublicKey in class TemplateOptions
  - installPrivateKey
```
public DockerTemplateOptions installPrivateKey(String privateKey)
```
    replaces the rsa ssh key used at login.
    
    Overrides:
    
    installPrivateKey in class TemplateOptions
  - blockUntilRunning
```
public DockerTemplateOptions blockUntilRunning(boolean blockUntilRunning)
```
    Note
    As of version 1.1.0, this option is incompatible with TemplateOptions.runScript(Statement) and RunScriptOptions.blockOnComplete(boolean), as all current implementations utilize ssh in order to execute scripts.
    
    Overrides:
    
    blockUntilRunning in class TemplateOptions
    
    Parameters:
    blockUntilRunning - (default true) whether to block until the nodes in this template are in Status#RUNNING state
  - dontAuthorizePublicKey
```
public DockerTemplateOptions dontAuthorizePublicKey()
```
    Overrides:
    
    dontAuthorizePublicKey in class TemplateOptions
  - nameTask
```
public DockerTemplateOptions nameTask(String name)
```
    Overrides:
    
    nameTask in class TemplateOptions
    
    Returns:
    What to call the task relating to this script; default jclouds-script-timestamp where timestamp is millis since epoch
  - runAsRoot
```
public DockerTemplateOptions runAsRoot(boolean runAsRoot)
```
    Overrides:
    
    runAsRoot in class TemplateOptions
  - runScript
```
public DockerTemplateOptions runScript(Statement script)
```
    This script will be executed as the root user upon system startup. This script gets a prologue, so no #!/bin/bash required, path set up, etc
    
    Overrides:
    
    runScript in class TemplateOptions
  - overrideLoginCredentials
```
public DockerTemplateOptions overrideLoginCredentials(LoginCredentials overridingCredentials)
```
    Overrides:
    
    overrideLoginCredentials in class TemplateOptions
  - overrideLoginPassword
```
public DockerTemplateOptions overrideLoginPassword(String password)
```
    Overrides:
    
    overrideLoginPassword in class TemplateOptions
  - overrideLoginPrivateKey
```
public DockerTemplateOptions overrideLoginPrivateKey(String privateKey)
```
    Overrides:
    
    overrideLoginPrivateKey in class TemplateOptions
  - overrideLoginUser
```
public DockerTemplateOptions overrideLoginUser(String loginUser)
```
    Overrides:
    
    overrideLoginUser in class TemplateOptions
  - overrideAuthenticateSudo
```
public DockerTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)
```
    Overrides:
    
    overrideAuthenticateSudo in class TemplateOptions
  - userMetadata
```
public DockerTemplateOptions userMetadata(Map<String,String> userMetadata)
```
    Overrides:
    
    userMetadata in class TemplateOptions
    
    Parameters:
    userMetadata - user-defined metadata to assign to this server
  - userMetadata
```
public DockerTemplateOptions userMetadata(String key,
                                 String value)
```
    Overrides:
    
    userMetadata in class TemplateOptions
    
    Parameters:
    key - key to place into the metadata map
    value - value to associate with that key
  - nodeNames
```
public DockerTemplateOptions nodeNames(Iterable<String> nodeNames)
```
    specifies names to be used for the created nodes. Note that this does not guarantee uniqueness - if there are already existing nodes with a name specified here, there will still be a new node created with the same name. Also, if more nodes are to be created than there are names, subsequent names will use the default naming strategy for that cloud.
    
    Overrides:
    
    nodeNames in class TemplateOptions
  - networks
```
public DockerTemplateOptions networks(Iterable<String> networks)
```
    Assigns the created nodes to these networks
    
    Overrides:
    
    networks in class TemplateOptions

Class DockerTemplateOptions

Usage

Advanced Usage

Nested Class Summary

Nested classes/interfaces inherited from class org.jclouds.compute.options.TemplateOptions

Nested classes/interfaces inherited from class org.jclouds.compute.options.RunScriptOptions

Field Summary

Fields inherited from class org.jclouds.compute.options.TemplateOptions

Fields inherited from class org.jclouds.compute.options.RunScriptOptions

Constructor Summary

Method Summary

Methods inherited from class org.jclouds.compute.options.TemplateOptions

Methods inherited from class org.jclouds.compute.options.RunScriptOptions

Methods inherited from class java.lang.Object

Field Detail

dns

hostname

memory

cpuShares

volumes

env

portBindings

networkMode

extraHosts

volumesFrom

privileged

openStdin

configBuilder

Constructor Detail

DockerTemplateOptions

Method Detail

clone

copyTo

equals

hashCode

toString

volumes

dns

dns

hostname

memory

entrypoint

entrypoint

commands

commands

cpuShares

env

env

portBindings

networkMode

extraHosts

volumesFrom

privileged

openStdin

configBuilder

getVolumes

getDns

getVolumesFrom

getHostname

getMemory

getEntrypoint

getCommands

getCpuShares

getEnv

getPortBindings

getNetworkMode

getExtraHosts

getPrivileged

getOpenStdin

getConfigBuilder

blockOnPort

inboundPorts

authorizePublicKey

installPrivateKey

blockUntilRunning

Note

dontAuthorizePublicKey

nameTask

runAsRoot

runScript