Package org.jclouds.openstack.nova.v2_0.compute.options

Class NovaTemplateOptions

java.lang.Object

org.jclouds.compute.options.RunScriptOptions

org.jclouds.compute.options.TemplateOptions

org.jclouds.openstack.nova.v2_0.compute.options.NovaTemplateOptions

All Implemented Interfaces:

Cloneable

public class NovaTemplateOptions
extends TemplateOptions
implements Cloneable

Contains options supported in the ComputeService#runNode operation on the "openstack-nova" provider.

Usage

The recommended way to instantiate a NovaTemplateOptions object is to statically import NovaTemplateOptions.* and invoke a static creation method followed by an instance mutator (if needed):

import static org.jclouds.aws.ec2.compute.options.NovaTemplateOptions.Builder.*;

ComputeService api = // get connection templateBuilder.options(inboundPorts(22, 80, 8080, 443)); Set set = api.createNodesInGroup(tag, 2, templateBuilder.build());

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NovaTemplateOptions.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

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	autoAssignFloatingIp
protected String	availabilityZone
protected Set<BlockDeviceMapping>	blockDeviceMappings
protected boolean	configDrive
protected String	diskConfig
protected com.google.common.base.Optional<Set<String>>	floatingIpPoolNames
protected boolean	generateKeyPair
protected String	keyPairName
protected Set<Network>	novaNetworks
protected byte[]	userData

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	Description
NovaTemplateOptions()

Method Summary

Modifier and Type	Method	Description
NovaTemplateOptions	authorizePublicKey(String publicKey)	authorize an rsa ssh key.
NovaTemplateOptions	autoAssignFloatingIp(boolean enable)
NovaTemplateOptions	availabilityZone(String availabilityZone)
NovaTemplateOptions	blockDeviceMappings(Iterable<BlockDeviceMapping> blockDeviceMappings)
NovaTemplateOptions	blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
NovaTemplateOptions	blockOnPort(int port, int seconds)	When the node is started, wait until the following port is active
NovaTemplateOptions	blockUntilRunning(boolean blockUntilRunning)	Note
NovaTemplateOptions	clone()
NovaTemplateOptions	configDrive(boolean configDrive)	OpenStack can be configured to write metadata to a special configuration drive that will be attached to the instance when it boots.
void	copyTo(TemplateOptions to)
NovaTemplateOptions	diskConfig(String diskConfig)
NovaTemplateOptions	dontAuthorizePublicKey()
boolean	equals(Object o)
NovaTemplateOptions	floatingIpPoolNames(Iterable<String> floatingIpPoolNames)
NovaTemplateOptions	floatingIpPoolNames(String... floatingIpPoolNames)
NovaTemplateOptions	generateKeyPair(boolean enable)
String	getAvailabilityZone()
Set<BlockDeviceMapping>	getBlockDeviceMappings()
boolean	getConfigDrive()
String	getDiskConfig()
com.google.common.base.Optional<Set<String>>	getFloatingIpPoolNames()	The floating IP pool name(s) to use when allocating a FloatingIP.
String	getKeyPairName()	Specifies the keypair used to run instances with
Set<Network>	getNovaNetworks()
byte[]	getUserData()
int	hashCode()
NovaTemplateOptions	inboundPorts(int... ports)	Opens the set of ports to public access.
NovaTemplateOptions	installPrivateKey(String privateKey)	replaces the rsa ssh key used at login.
NovaTemplateOptions	keyPairName(String keyPairName)
NovaTemplateOptions	nameTask(String name)
NovaTemplateOptions	networks(Iterable<String> networks)	Ensures NovaTemplateOptions can work with networks specified as Strings.
NovaTemplateOptions	networks(String... networks)	Ensures NovaTemplateOptions can work with networks specified as Strings.
NovaTemplateOptions	nodeNames(Iterable<String> nodeNames)	specifies names to be used for the created nodes.
NovaTemplateOptions	novaNetworks(Set<Network> novaNetworks)
NovaTemplateOptions	overrideAuthenticateSudo(boolean authenticateSudo)
NovaTemplateOptions	overrideLoginCredentials(LoginCredentials overridingCredentials)
NovaTemplateOptions	overrideLoginPassword(String password)
NovaTemplateOptions	overrideLoginPrivateKey(String privateKey)
NovaTemplateOptions	overrideLoginUser(String loginUser)
NovaTemplateOptions	runAsRoot(boolean runAsRoot)
NovaTemplateOptions	runScript(Statement script)	This script will be executed as the root user upon system startup.
boolean	shouldAutoAssignFloatingIp()	Note
boolean	shouldGenerateKeyPair()	Note
com.google.common.base.MoreObjects.ToStringHelper	string()
NovaTemplateOptions	userData(byte[] userData)	User data as bytes (not base64-encoded)
NovaTemplateOptions	userMetadata(String key, String value)
NovaTemplateOptions	userMetadata(Map<String,String> userMetadata)

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

as, blockOnComplete, getGroups, getInboundPorts, getNetworks, getNodeNames, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, runScript, securityGroups, securityGroups, shouldBlockUntilRunning, 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, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

autoAssignFloatingIp

protected boolean autoAssignFloatingIp

floatingIpPoolNames

protected com.google.common.base.Optional<Set<String>> floatingIpPoolNames

generateKeyPair

protected boolean generateKeyPair

keyPairName

protected String keyPairName

userData

protected byte[] userData

diskConfig

protected String diskConfig

configDrive

protected boolean configDrive

novaNetworks

protected Set<Network> novaNetworks

availabilityZone

protected String availabilityZone

blockDeviceMappings

protected Set<BlockDeviceMapping> blockDeviceMappings

Constructor Detail

NovaTemplateOptions

public NovaTemplateOptions()

Method Detail

clone

public NovaTemplateOptions 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

string

public com.google.common.base.MoreObjects.ToStringHelper string()

Overrides:

string in class TemplateOptions

autoAssignFloatingIp

public NovaTemplateOptions autoAssignFloatingIp(boolean enable)

See Also:

getFloatingIpPoolNames()

floatingIpPoolNames

public NovaTemplateOptions floatingIpPoolNames(String... floatingIpPoolNames)

See Also:

getFloatingIpPoolNames()

floatingIpPoolNames

public NovaTemplateOptions floatingIpPoolNames(Iterable<String> floatingIpPoolNames)

See Also:

getFloatingIpPoolNames()

generateKeyPair

public NovaTemplateOptions generateKeyPair(boolean enable)

See Also:

shouldGenerateKeyPair()

keyPairName

public NovaTemplateOptions keyPairName(String keyPairName)

See Also:

shouldGenerateKeyPair()

shouldAutoAssignFloatingIp

public boolean shouldAutoAssignFloatingIp()

Note

This requires that NovaApi.getExtensionApi(String) to return present

Returns:

true if auto assignment of a floating ip to each vm is enabled

availabilityZone

public NovaTemplateOptions availabilityZone(String availabilityZone)

See Also:

CreateServerOptions.getAvailabilityZone()

blockDeviceMappings

public NovaTemplateOptions blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)

See Also:

getBlockDeviceMappings()

blockDeviceMappings

public NovaTemplateOptions blockDeviceMappings(Iterable<BlockDeviceMapping> blockDeviceMappings)

See Also:

getBlockDeviceMappings()

getFloatingIpPoolNames

public com.google.common.base.Optional<Set<String>> getFloatingIpPoolNames()

The floating IP pool name(s) to use when allocating a FloatingIP. Applicable only if #shouldAutoAssignFloatingIp() returns true. If not set will attempt to use whatever FloatingIP(s) can be found regardless of which pool they originated from

Returns:

floating-ip-pool names to use

getKeyPairName

public String getKeyPairName()

Specifies the keypair used to run instances with

Returns:

the keypair to be used

shouldGenerateKeyPair

public boolean shouldGenerateKeyPair()

Note

This requires that NovaApi.getKeyPairApi(String) to return present

Returns:

true if auto generation of keypairs is enabled

getUserData

public byte[] getUserData()

getDiskConfig

public String getDiskConfig()

See Also:

CreateServerOptions.getDiskConfig()

getConfigDrive

public boolean getConfigDrive()

See Also:

CreateServerOptions.getConfigDrive()

getNovaNetworks

public Set<Network> getNovaNetworks()

See Also:

CreateServerOptions.getNetworks()

getAvailabilityZone

public String getAvailabilityZone()

See Also:

CreateServerOptions.getAvailabilityZone()

getBlockDeviceMappings

public Set<BlockDeviceMapping> getBlockDeviceMappings()

blockOnPort

public NovaTemplateOptions blockOnPort(int port,
                                       int seconds)

When the node is started, wait until the following port is active

Overrides:

blockOnPort in class TemplateOptions

inboundPorts

public NovaTemplateOptions inboundPorts(int... ports)

Opens the set of ports to public access.

Overrides:

inboundPorts in class TemplateOptions

authorizePublicKey

public NovaTemplateOptions authorizePublicKey(String publicKey)

authorize an rsa ssh key.

Overrides:

authorizePublicKey in class TemplateOptions

installPrivateKey

public NovaTemplateOptions installPrivateKey(String privateKey)

replaces the rsa ssh key used at login.

Overrides:

installPrivateKey in class TemplateOptions

blockUntilRunning

public NovaTemplateOptions 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 NovaTemplateOptions dontAuthorizePublicKey()

Overrides:

dontAuthorizePublicKey in class TemplateOptions

nameTask

public NovaTemplateOptions 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 NovaTemplateOptions runAsRoot(boolean runAsRoot)

Overrides:

runAsRoot in class TemplateOptions

runScript

public NovaTemplateOptions 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 NovaTemplateOptions overrideLoginCredentials(LoginCredentials overridingCredentials)

Overrides:

overrideLoginCredentials in class TemplateOptions

overrideLoginPassword

public NovaTemplateOptions overrideLoginPassword(String password)

Overrides:

overrideLoginPassword in class TemplateOptions

overrideLoginPrivateKey

public NovaTemplateOptions overrideLoginPrivateKey(String privateKey)

Overrides:

overrideLoginPrivateKey in class TemplateOptions

overrideLoginUser

public NovaTemplateOptions overrideLoginUser(String loginUser)

Overrides:

overrideLoginUser in class TemplateOptions

overrideAuthenticateSudo

public NovaTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)

Overrides:

overrideAuthenticateSudo in class TemplateOptions

userMetadata

public NovaTemplateOptions userMetadata(Map<String,String> userMetadata)

Overrides:

userMetadata in class TemplateOptions

Parameters:

userMetadata - user-defined metadata to assign to this server

userMetadata

public NovaTemplateOptions 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 NovaTemplateOptions 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 NovaTemplateOptions networks(Iterable<String> networks)

Ensures NovaTemplateOptions can work with networks specified as Strings. Also provides for compatibility with the abstraction layer.

Overrides:

networks in class TemplateOptions

networks

public NovaTemplateOptions networks(String... networks)

Ensures NovaTemplateOptions can work with networks specified as Strings. Also provides for compatibility with the abstraction layer.

Overrides:

networks in class TemplateOptions

See Also:

TemplateOptions.networks(Iterable)

userData

public NovaTemplateOptions userData(byte[] userData)

User data as bytes (not base64-encoded)

diskConfig

public NovaTemplateOptions diskConfig(String diskConfig)

See Also:

CreateServerOptions.getDiskConfig()

configDrive

public NovaTemplateOptions configDrive(boolean configDrive)

OpenStack can be configured to write metadata to a special configuration drive that will be attached to the instance when it boots. The instance can retrieve any information that would normally be available through the metadata service by mounting this disk and reading files from it. To enable the config drive, set this parameter to "true". This has to be enabled for user data cases.

See Also:

CreateServerOptions.getConfigDrive()

novaNetworks

public NovaTemplateOptions novaNetworks(Set<Network> novaNetworks)

Parameters:

novaNetworks - The list of network declarations. Nova-specific network declarations allow for specifying network UUIDs, port UUIDs, and fixed IPs. Unline networks(Iterable) this supports setting additional network parameters and not just network UUIDs.

See Also:

CreateServerOptions.getNetworks()