org.ow2.proactive.resourcemanager.nodesource.infrastructure

Class SSHInfrastructure

java.lang.Object

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

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

org.ow2.proactive.resourcemanager.nodesource.infrastructure.SSHInfrastructure

All Implemented Interfaces:

Serializable, NodeSourcePlugin

public class SSHInfrastructure
extends HostsFileBasedInfrastructureManager

Acquires nodes over SSH given a list of hosts

Assumes all necessary ProActive configuration has already been performed: ssh username, key directory, etc. This class won't handle it, see SSHClient.

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 GCMInfrastructure instead, which contains the functionalities of this Infrastructure, but requires more configuration.

Since:

ProActive Scheduling 2.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
protected String	javaOptions Additional java options to append to the command executed on the remote host
protected String	javaPath Path to the Java executable on the remote hosts
protected File	rmCredentialsPath Path to the credentials file user for RM authentication
protected String	schedulingPath Path to the Scheduling installation on the remote hosts
protected String	sshOptions SshClient options (@see SSHClient)
protected String	targetOs The type of the OS on the remote machine, 'Linux', 'Windows' or 'Cygwin'

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
SSHInfrastructure()

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.
protected 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

sshOptions

protected String sshOptions

SshClient options (@see SSHClient)

javaPath

protected String javaPath

Path to the Java executable on the remote hosts

schedulingPath

protected String schedulingPath

Path to the Scheduling installation on the remote hosts

targetOs

protected String targetOs

The type of the OS on the remote machine, 'Linux', 'Windows' or 'Cygwin'

javaOptions

protected String javaOptions

Additional java options to append to the command executed on the remote host

rmCredentialsPath

protected File rmCredentialsPath

Path to the credentials file user for RM authentication

Constructor Detail

SSHInfrastructure

public SSHInfrastructure()

Method Detail

startNodeImpl

protected 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 Options, see SSHClient parameters[5] : java path on the remote machines parameters[6] : Scheduling path on remote machines parameters[7] : target OS' type (Linux, Windows or Cygwin) parameters[8] : extra java options parameters[9] : rm cred

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