Unverified Commit 8767e105 authored by alijawadfahs's avatar alijawadfahs Committed by GitHub
Browse files

adding the documentation of the new SSHInfrastructureV2 variables (#794)

adding the documentation of the new SSHInfrastructureV2 variables
parent acaaa653
......@@ -93,7 +93,7 @@ This infrastructure needs 10 arguments, described hereafter:
*Full name:* `org.ow2.proactive.resourcemanager.nodesource.infrastructure.SSHInfrastructureV2`
This infrastructure allows to deploy nodes over SSH.
This infrastructure needs 13 arguments, described hereafter:
This infrastructure needs 17 arguments, described hereafter:
- **hostsList** - Path to a file containing the hosts on which
resources should be acquired. This file should contain one host per
......@@ -133,6 +133,50 @@ This infrastructure needs 13 arguments, described hereafter:
- **javaOptions** - Java options appended to the command used to
start the node on the remote host.
- **deploymentMode** - Specifies how the ProActive node command is started.
The deploymentMode can take the following values:
*** _autoGenerated_: when this mode is selected the command to start the
ProActive node will be generated automatically. As a result, the ssh call to
the nodes will start the ProActive nodes on the infrastructure without modifications to
the startup command. This mode is selected by default.
*** _useStartupScript_: starts the ProActive node using the script in the variable
`%startupScriptStandard%`, allowing the user to modify the startup command of the hosts.
This mode uses the ProActive node agent identified in the `%schedulingPath%` variable
and the Java Runtime Environment identified in the `%javaPath%` variable.
*** _useNodeJarStartupScript_: enables connecting to the SSHInfrastructureV2
by launching _node.jar_. This mode uses `%nodeJarUrl%` and `%startupScriptWitNodeJarDownload%`
variables to generate the startup command.
+
TIP: if deploymentMode field was set to an empty string, the `autoGenerated` mode will be automatically selected.
+
- **nodeJarUrl** - The full URL path to download the ProActive _node.jar_
on each host added to the hostsList. The URL have to be accessible from the hosts.
For example, `try.activeeon.com/rest/node.jar`.
Used only when `useNodeJarStartupScript` is selected.
- **startupScriptStandard** - Nodes startup script to launch the ProActive nodes using a ProActive node agent.
The script by default locates Java Runtime Environment and node agent directory using `%javaPath%` and `%schedulingPath%` variables respectively.
The user can modify or extend this script to execute commands on the host before or after the Proactive node startup.
Used only when `useStartupScript` is selected.
- **startupScriptWitNodeJarDownload** - Nodes startup script to launch the ProActive nodes using _node.jar_.
To run ProActive nodes, this script is also expected to download and install the Java Runtime Environment,
then download and execute ProActive _node.jar_, if they are not already provided by the host.
It uses `%nodeJarUrl%` variable to get the full URL path for downloading the _node.jar_ file.
The user can modify or extend this script to execute commands on the host before or after the ProActive node startup.
Used only when `useNodeJarStartupScript` is selected.
+
WARNING: If the deployment mode `autoGenerated` is selected, the startup scripts will be disregarded.
+
==== CLI Infrastructure
*Full name:* `org.ow2.proactive.resourcemanager.nodesource.infrastructure.CLIInfrastructure`
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment