org.ow2.proactive.resourcemanager.nodesource.infrastructure

Class SSHInfrastructureV2

java.lang.Object

org.ow2.proactive.resourcemanager.nodesource.infrastructure.InfrastructureManager

org.ow2.proactive.resourcemanager.nodesource.infrastructure.HostsFileBasedInfrastructureManager

org.ow2.proactive.resourcemanager.nodesource.infrastructure.SSHInfrastructureV2

All Implemented Interfaces:

Serializable, NodeSourcePlugin

public class SSHInfrastructureV2
extends HostsFileBasedInfrastructureManager

Acquires nodes over SSH given a list of hosts, this implementation uses jsch.

Also assumes JRE and Scheduling installation paths are the same on all hosts.

If you need more control over you deployment, you may consider using CLIInfrastructure instead.

Since:

ProActive Scheduling 6.0.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.ow2.proactive.resourcemanager.nodesource.infrastructure.HostsFileBasedInfrastructureManager

HostsFileBasedInfrastructureManager.NodeNameBuilder

Nested classes/interfaces inherited from class org.ow2.proactive.resourcemanager.nodesource.infrastructure.InfrastructureManager

InfrastructureManager.PersistedInfraVariablesHandler<T>, InfrastructureManager.RMDeployingNodeAccessor

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_OUTPUT_BUFFER_LENGTH
static int	DEFAULT_SSH_PORT
protected String	deploymentMode
protected String	javaOptions
protected String	javaPath
protected String	nodeJarUrl
protected String	schedulingPath
protected Properties	sshOptions
protected String	sshPassword
protected int	sshPort
protected byte[]	sshPrivateKey
protected String	sshUsername
protected String	startupScriptStandard
protected String	startupScriptWithNodeJarDownload
protected String	targetOs

Fields inherited from class org.ow2.proactive.resourcemanager.nodesource.infrastructure.HostsFileBasedInfrastructureManager

DEFAULT_NODE_DEPLOYMENT_FAILURE_THRESHOLD, DEFAULT_NODE_TIMEOUT, DEFAULT_WAIT_TIME_BETWEEN_NODE_DEPLOYMENT_FAILURES, hostsList, maxDeploymentFailure, nodeNameBuilder, nodeTimeOut, waitBetweenDeploymentFailures

Fields inherited from class org.ow2.proactive.resourcemanager.nodesource.infrastructure.InfrastructureManager

ELASTIC, nodeSource, persistedInfraVariables, readLock, RM_URL_KEY, writeLock

Constructor Summary

Constructors

Constructor and Description
SSHInfrastructureV2()

Method Summary

Modifier and Type	Method and Description
void	configure(Object... parameters) Configures the Infrastructure
String	getDescription()
Map<Integer,String>	getSectionDescriptions()
protected void	initializePersistedInfraVariables() This method should initialize a value in the runtime variables map for all the runtime variables that will be used in the class.
protected void	killNodeImpl(org.objectweb.proactive.core.node.Node node, InetAddress host) Kills the node passed as parameter
void	shutDown() Notify this infrastructure it is going to be shut down along with its nodesource.
void	startNodeImpl(HostTracker hostTracker, int nbNodes, List<String> depNodeURLs) Internal node acquisition method
String	toString()

Methods inherited from class org.ow2.proactive.resourcemanager.nodesource.infrastructure.HostsFileBasedInfrastructureManager

acquireAllNodes, acquireNode, addTimeouts, anyTimedOut, notifyAcquiredNode, notifyDeployingNodeLost, notifyDownNode, onDownNodeReconnection, readHosts, removeNode, removeTimeouts, startNodeImplWithRetries

Methods inherited from class org.ow2.proactive.resourcemanager.nodesource.infrastructure.InfrastructureManager

acquireAllNodes, acquireNodes, acquireNodes, addDeployingNode, addDeployingNodeWithLockAndPersist, addLostNodeWithLockAndPersist, addMultipleDeployingNodes, buildDeployingNodeURL, checkAllNodesAreAcquiredAndDo, checkNodeIsAcquiredAndDo, declareDeployingNodeLost, getDefaultCommandLineBuilder, getDeployingAndLostNodes, getDeployingNodesWithLock, getDeployingOrLostNode, getEmptyCommandLineBuilder, getLostNodesWithLock, getMeta, getPersistedDeployingNodesUrl, getPersistedInfraVariable, getPersistedLostNodesUrl, getRmUrl, internalConfigure, internalNotifyDownNode, internalRegisterAcquiredNode, internalRemoveDeployingNode, internalRemoveNode, internalShutDown, isShutDown, isUsingDeployingNode, multipleDeclareDeployingNodeLost, persistInfrastructureVariables, reconfigure, recoverPersistedInfraVariables, removeDownNodePriorToNotify, searchForNotAcquiredRmNode, setNodeSource, setPersistedInfraVariable, setPersistedNodeSourceData, setRmDbManager, setRmUrl, update, updateDeployingNodeDescription

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OUTPUT_BUFFER_LENGTH

public static final int DEFAULT_OUTPUT_BUFFER_LENGTH

See Also:

Constant Field Values

DEFAULT_SSH_PORT

public static final int DEFAULT_SSH_PORT

See Also:

Constant Field Values

sshPort

protected int sshPort

sshUsername

protected String sshUsername

sshPassword

protected String sshPassword

sshPrivateKey

protected byte[] sshPrivateKey

sshOptions

protected Properties sshOptions

javaPath

protected String javaPath

schedulingPath

protected String schedulingPath

targetOs

protected String targetOs

javaOptions

protected String javaOptions

deploymentMode

protected String deploymentMode

nodeJarUrl

protected String nodeJarUrl

startupScriptStandard

protected String startupScriptStandard

startupScriptWithNodeJarDownload

protected String startupScriptWithNodeJarDownload

Constructor Detail

SSHInfrastructureV2

public SSHInfrastructureV2()

Method Detail

startNodeImpl

public void startNodeImpl(HostTracker hostTracker,
                          int nbNodes,
                          List<String> depNodeURLs)
                   throws RMException

Internal node acquisition method

Starts a PA runtime on remote host using SSH, register it manually in the nodesource.

Specified by:

startNodeImpl in class HostsFileBasedInfrastructureManager

Parameters:

hostTracker - The host on which one the node will be started

nbNodes - number of nodes to deploy

depNodeURLs - list of deploying or lost nodes urls created

Throws:

RMException - acquisition failed

configure

public void configure(Object... parameters)

Configures the Infrastructure

Overrides:

configure in class HostsFileBasedInfrastructureManager

Parameters:

parameters - parameters[4] : ssh server port parameters[5] : ssh username parameters[6] : ssh password parameters[7] : ssh private key parameters[8] : optional ssh options file parameters[9] : java path on the remote machines parameters[10] : Scheduling path on remote machines parameters[11] : target OS' type (Linux, Windows or Cygwin) parameters[12] : extra java options parameters[13] : deployment mode parameters[14] : node.jar URL parameters[15] : the standard startupScript parameters[16] : the node.jar startupScript

Throws:

IllegalArgumentException - configuration failed

killNodeImpl

protected void killNodeImpl(org.objectweb.proactive.core.node.Node node,
                            InetAddress host)

Description copied from class: HostsFileBasedInfrastructureManager

Kills the node passed as parameter

Specified by:

killNodeImpl in class HostsFileBasedInfrastructureManager

Parameters:

node - The node to kill

host - The host of the node

getDescription

public String getDescription()

Specified by:

getDescription in class InfrastructureManager

Returns:

short description of the IM

toString

public String toString()

Overrides:

toString in class HostsFileBasedInfrastructureManager

shutDown

public void shutDown()

Description copied from class: InfrastructureManager

Notify this infrastructure it is going to be shut down along with its nodesource. All necessary cleanup should be done here.

Overrides:

shutDown in class InfrastructureManager

initializePersistedInfraVariables

protected void initializePersistedInfraVariables()

Description copied from class: InfrastructureManager

This method should initialize a value in the runtime variables map for all the runtime variables that will be used in the class. It is called at initialization time of the infrastructure, just before the InfrastructureManager.configure(Object...) method. This method runs with the write lock acquired.

Overrides:

initializePersistedInfraVariables in class HostsFileBasedInfrastructureManager

getSectionDescriptions

public Map<Integer,String> getSectionDescriptions()

Specified by:

getSectionDescriptions in interface NodeSourcePlugin

Overrides:

getSectionDescriptions in class HostsFileBasedInfrastructureManager