Package org.apache.hadoop.hbase

Class HBaseClusterManager

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.hbase.HBaseClusterManager

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, ClusterManager

Direct Known Subclasses:

CoprocClusterManager

@Private
public class HBaseClusterManager
extends org.apache.hadoop.conf.Configured
implements ClusterManager

A default cluster manager for HBase. Uses SSH, and hbase shell scripts to manage the cluster. Assumes Unix-like commands are available like 'ps', 'kill', etc. Also assumes the user running the test has enough "power" to start & stop servers on the remote machines (for example, the test user could be the same user as the user the daemon is running as)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	HBaseClusterManager.CommandProvider	Provides command strings for services to be executed by Shell.
(package private) static class	HBaseClusterManager.HadoopShellCommandProvider	CommandProvider to manage the service using sbin/hadoop-* scripts.
(package private) static class	HBaseClusterManager.HBaseShellCommandProvider	CommandProvider to manage the service using bin/hbase-* scripts
protected class	HBaseClusterManager.RemoteShell	Executes commands over SSH
protected class	HBaseClusterManager.RemoteSudoShell	Executes commands over SSH
protected static enum	HBaseClusterManager.Signal
(package private) static class	HBaseClusterManager.ZookeeperShellCommandProvider	CommandProvider to manage the service using bin/zk* scripts.

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.ClusterManager

ClusterManager.ServiceType

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final int	DEFAULT_RETRY_ATTEMPTS
(package private) static final int	DEFAULT_RETRY_SLEEP_INTERVAL
private static final String	DEFAULT_TUNNEL_CMD	The command format that is used to execute the remote command.
private static final String	DEFAULT_TUNNEL_SUDO_CMD	The command format that is used to execute the remote command with sudo.
protected static final org.slf4j.Logger	LOG
(package private) static final String	RETRY_ATTEMPTS_KEY
(package private) static final String	RETRY_SLEEP_INTERVAL_KEY
protected org.apache.hadoop.hbase.util.RetryCounterFactory	retryCounterFactory
private String	sshOptions
private String	sshUserName
private String	tunnelCmd
private String	tunnelSudoCmd

Constructor Summary

Constructors

Constructor	Description
HBaseClusterManager()

Method Summary

Modifier and Type	Method	Description
protected org.apache.hadoop.hbase.util.Pair<Integer,String>	exec(String hostname, ClusterManager.ServiceType service, String... cmd)	Execute the given command on the host using SSH
private void	exec(String hostname, ClusterManager.ServiceType service, HBaseClusterManager.CommandProvider.Operation op)
org.apache.hadoop.hbase.util.Pair<Integer,String>	execSudo(String hostname, long timeout, String... cmd)	Execute the given command on the host using SSH
org.apache.hadoop.hbase.util.Pair<Integer,String>	execSudoWithRetries(String hostname, long timeout, String... cmd)
private org.apache.hadoop.hbase.util.Pair<Integer,String>	execWithRetries(String hostname, ClusterManager.ServiceType service, String... cmd)
protected HBaseClusterManager.CommandProvider	getCommandProvider(ClusterManager.ServiceType service)
protected String	getServiceUser(ClusterManager.ServiceType service)
boolean	isRunning(ClusterManager.ServiceType service, String hostname, int port)	Returns whether the service is running on the remote host.
void	kill(ClusterManager.ServiceType service, String hostname, int port)	Kills the service running on the given host
void	restart(ClusterManager.ServiceType service, String hostname, int port)	Restart the service on the given host
void	resume(ClusterManager.ServiceType service, String hostname, int port)	Resumes the services running on the given host
private <E extends Exception> void	retryOrThrow(org.apache.hadoop.hbase.util.RetryCounter retryCounter, E ex, String hostname, String[] cmd)
void	setConf(org.apache.hadoop.conf.Configuration conf)
void	signal(ClusterManager.ServiceType service, HBaseClusterManager.Signal signal, String hostname)
void	start(ClusterManager.ServiceType service, String hostname, int port)	Start the service on the given host
void	stop(ClusterManager.ServiceType service, String hostname, int port)	Stop the service on the given host
void	suspend(ClusterManager.ServiceType service, String hostname, int port)	Suspends the service running on the given host

Methods inherited from class org.apache.hadoop.conf.Configured

getConf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf

Field Details

LOG

protected static final org.slf4j.Logger LOG

sshUserName

private String sshUserName

sshOptions

private String sshOptions

DEFAULT_TUNNEL_CMD

private static final String DEFAULT_TUNNEL_CMD

The command format that is used to execute the remote command. Arguments: 1 SSH options, 2 user name , 3 "@" if username is set, 4 host, 5 original command, 6 service user.

See Also:

• Constant Field Values

tunnelCmd

private String tunnelCmd

DEFAULT_TUNNEL_SUDO_CMD

private static final String DEFAULT_TUNNEL_SUDO_CMD

The command format that is used to execute the remote command with sudo. Arguments: 1 SSH options, 2 user name , 3 "@" if username is set, 4 host, 5 original command, 6 timeout.

See Also:

• Constant Field Values

tunnelSudoCmd

private String tunnelSudoCmd

RETRY_ATTEMPTS_KEY

static final String RETRY_ATTEMPTS_KEY

See Also:

• Constant Field Values

DEFAULT_RETRY_ATTEMPTS

static final int DEFAULT_RETRY_ATTEMPTS

See Also:

• Constant Field Values

RETRY_SLEEP_INTERVAL_KEY

static final String RETRY_SLEEP_INTERVAL_KEY

See Also:

• Constant Field Values

DEFAULT_RETRY_SLEEP_INTERVAL

static final int DEFAULT_RETRY_SLEEP_INTERVAL

See Also:

• Constant Field Values

retryCounterFactory

protected org.apache.hadoop.hbase.util.RetryCounterFactory retryCounterFactory

Constructor Details

HBaseClusterManager

public HBaseClusterManager()

Method Details

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

Overrides:

setConf in class org.apache.hadoop.conf.Configured

getServiceUser

protected String getServiceUser(ClusterManager.ServiceType service)

getCommandProvider

protected HBaseClusterManager.CommandProvider getCommandProvider(ClusterManager.ServiceType service)
                                                          throws IOException

Throws:

IOException

exec

protected org.apache.hadoop.hbase.util.Pair<Integer,String> exec(String hostname,
 ClusterManager.ServiceType service,
 String... cmd)
                                                          throws IOException

Execute the given command on the host using SSH

Returns:

pair of exit code and command output

Throws:

IOException - if something goes wrong.

execWithRetries

private org.apache.hadoop.hbase.util.Pair<Integer,String> execWithRetries(String hostname,
 ClusterManager.ServiceType service,
 String... cmd)
                                                                   throws IOException

Throws:

IOException

execSudo

public org.apache.hadoop.hbase.util.Pair<Integer,String> execSudo(String hostname,
 long timeout,
 String... cmd)
                                                           throws IOException

Execute the given command on the host using SSH

Returns:

pair of exit code and command output

Throws:

IOException - if something goes wrong.

execSudoWithRetries

public org.apache.hadoop.hbase.util.Pair<Integer,String> execSudoWithRetries(String hostname,
 long timeout,
 String... cmd)
                                                                      throws IOException

Throws:

IOException

retryOrThrow

private <E extends Exception> void retryOrThrow(org.apache.hadoop.hbase.util.RetryCounter retryCounter,
 E ex,
 String hostname,
 String[] cmd)
                                         throws E

Throws:

E extends Exception

exec

private void exec(String hostname,
 ClusterManager.ServiceType service,
 HBaseClusterManager.CommandProvider.Operation op)
           throws IOException

Throws:

IOException

start

public void start(ClusterManager.ServiceType service,
 String hostname,
 int port)
           throws IOException

Description copied from interface: ClusterManager

Start the service on the given host

Specified by:

start in interface ClusterManager

Throws:

IOException

stop

public void stop(ClusterManager.ServiceType service,
 String hostname,
 int port)
          throws IOException

Description copied from interface: ClusterManager

Stop the service on the given host

Specified by:

stop in interface ClusterManager

Throws:

IOException

restart

public void restart(ClusterManager.ServiceType service,
 String hostname,
 int port)
             throws IOException

Description copied from interface: ClusterManager

Restart the service on the given host

Specified by:

restart in interface ClusterManager

Throws:

IOException

signal

public void signal(ClusterManager.ServiceType service,
 HBaseClusterManager.Signal signal,
 String hostname)
            throws IOException

Throws:

IOException

isRunning

public boolean isRunning(ClusterManager.ServiceType service,
 String hostname,
 int port)
                  throws IOException

Description copied from interface: ClusterManager

Returns whether the service is running on the remote host. This only checks whether the service still has a pid.

Specified by:

isRunning in interface ClusterManager

Throws:

IOException

kill

public void kill(ClusterManager.ServiceType service,
 String hostname,
 int port)
          throws IOException

Description copied from interface: ClusterManager

Kills the service running on the given host

Specified by:

kill in interface ClusterManager

Throws:

IOException

suspend

public void suspend(ClusterManager.ServiceType service,
 String hostname,
 int port)
             throws IOException

Description copied from interface: ClusterManager

Suspends the service running on the given host

Specified by:

suspend in interface ClusterManager

Throws:

IOException

resume

public void resume(ClusterManager.ServiceType service,
 String hostname,
 int port)
            throws IOException

Description copied from interface: ClusterManager

Resumes the services running on the given host

Specified by:

resume in interface ClusterManager

Throws:

IOException