org.gridgain.visor.commands

start

package start

Overview

Contains Visor command start implementation.

Help

+-----------------------------------------------------+
| start | Starts one or more nodes on remote host(s). |
|       | Uses SSH protocol to execute commands.      |
+-----------------------------------------------------+
Specification
start "-f= {-m=} {-r}"
start "-h= {-p=} {-u=} {-pw=} {-k=}
    {-n=} {-g=} {-c=} {-s=} {-m=} {-r}"
Arguments
-f=<path>
    Path to INI file that contains topology specification.
-h=<hostname>
    Hostname where to start nodes.

    Can define several hosts if their IPs are sequential.
    Example of range is 192.168.1.100~150,
    which means all IPs from 192.168.1.100 to 192.168.1.150 inclusively.
-p=<num>
    Port number (default is 22).
-u=<username>
    Username (if not defined, current local username will be used).
-pw=<password>
    Password (if not defined, private key file must be defined).
-k=<path>
    Path to private key file. Define if key authentication is used.
-n=<num>
    Expected number of nodes on the host.
    If some nodes are started already, then only remaining nodes will be started.
    If current count of nodes is equal to this number and '-r' flag is not set, then nothing will happen.
-g=<path>
    Path to GridGain installation folder.
    If not defined, GRIDGAIN_HOME environment variable must be set on remote hosts.
-c=<path>
    Path to configuration file (relative to GridGain home).
    If not provided, default GridGain configuration is used.
-s=<path>
    Path to start script (relative to GridGain home).
    Default is "bin/ggstart.sh" for Unix or
    "bin\ggstart.bat" for Windows.
-m=<num>
    Defines maximum number of nodes that can be started in parallel on one host.
    This actually means number of parallel SSH connections to each SSH server.
    Default is 5.
-r
    Indicates that existing nodes on the host will be restarted.
    By default, if flag is not present, existing nodes will be left as is.
Examples
start "-h=10.1.1.10 -u=uname -pw=passwd -n=3"
    Starts three nodes with default configuration (password authentication).
start "-h=192.168.1.100~104 -u=uname -k=/home/uname/.ssh/is_rsa -n=5"
    Starts 25 nodes on 5 hosts (5 nodes per host) with default configuration (key-based authentication).
start "-f=start-nodes.ini -r"
    Starts topology defined in 'start-nodes.ini' file. Existing nodes are stopped.
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. start
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class VisorStartCommand extends AnyRef

    Contains Visor command start implementation.

    Overview

    Contains Visor command start implementation.

    Help

    +-----------------------------------------------------+
    | start | Starts one or more nodes on remote host(s). |
    |       | Uses SSH protocol to execute commands.      |
    +-----------------------------------------------------+
    Specification
    start "-f= {-m=} {-r}"
    start "-h= {-p=} {-u=} {-pw=} {-k=}
        {-n=} {-g=} {-c=} {-s=} {-m=} {-r}"
    Arguments
    -f=<path>
        Path to INI file that contains topology specification.
    -h=<hostname>
        Hostname where to start nodes.
    
        Can define several hosts if their IPs are sequential.
        Example of range is 192.168.1.100~150,
        which means all IPs from 192.168.1.100 to 192.168.1.150 inclusively.
    -p=<num>
        Port number (default is 22).
    -u=<username>
        Username (if not defined, current local username will be used).
    -pw=<password>
        Password (if not defined, private key file must be defined).
    -k=<path>
        Path to private key file. Define if key authentication is used.
    -n=<num>
        Expected number of nodes on the host.
        If some nodes are started already, then only remaining nodes will be started.
        If current count of nodes is equal to this number and '-r' flag is not set, then nothing will happen.
    -g=<path>
        Path to GridGain installation folder.
        If not defined, GRIDGAIN_HOME environment variable must be set on remote hosts.
    -c=<path>
        Path to configuration file (relative to GridGain home).
        If not provided, default GridGain configuration is used.
    -s=<path>
        Path to start script (relative to GridGain home).
        Default is "bin/ggstart.sh" for Unix or
        "bin\ggstart.bat" for Windows.
    -m=<num>
        Defines maximum number of nodes that can be started in parallel on one host.
        This actually means number of parallel SSH connections to each SSH server.
        Default is 5.
    -t=<num>
        Defines connection timeout in milliseconds.
        Default is 2000.
    -r
        Indicates that existing nodes on the host will be restarted.
        By default, if flag is not present, existing nodes will be left as is.
    Examples
    start "-h=10.1.1.10 -u=uname -pw=passwd -n=3"
        Starts three nodes with default configuration (password authentication).
    start "-h=192.168.1.100~104 -u=uname -k=/home/uname/.ssh/is_rsa -n=5"
        Starts 25 nodes on 5 hosts (5 nodes per host) with default configuration (key-based authentication).
    start "-f=start-nodes.ini -r"
        Starts topology defined in 'start-nodes.ini' file. Existing nodes are stopped.

Value Members

  1. object VisorStartCommand

    Companion object that does initialization of the command.

Inherited from AnyRef

Inherited from Any

Ungrouped