Package org.apache.hadoop.yarn.server.router

Class Router

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.service.CompositeService

org.apache.hadoop.yarn.server.router.Router

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.service.Service

public class Router
extends org.apache.hadoop.service.CompositeService

The router is a stateless YARN component which is the entry point to the cluster. It can be deployed on multiple nodes behind a Virtual IP (VIP) with a LoadBalancer. The Router exposes the ApplicationClientProtocol (RPC and REST) to the outside world, transparently hiding the presence of ResourceManager(s), which allows users to request and update reservations, submit and kill applications, and request status on running applications. In addition, it exposes the ResourceManager Admin API. This provides a placeholder for throttling mis-behaving clients (YARN-1546) and masks the access to multiple RMs (YARN-3659).

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.service.CompositeService

org.apache.hadoop.service.CompositeService.CompositeServiceShutdownHook

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Field Summary

Fields

Modifier and Type	Field	Description
protected RouterClientRMService	clientRMProxyService
protected RouterRMAdminService	rmAdminProxyService
static int	SHUTDOWN_HOOK_PRIORITY	Priority of the Router shutdown hook.
protected java.lang.String	webAppAddress

Fields inherited from class org.apache.hadoop.service.CompositeService

STOP_ONLY_STARTED_SERVICES

Constructor Summary

Constructors

Constructor	Description
Router()

Method Summary

Modifier and Type	Method	Description
protected RouterClientRMService	createClientRMProxyService()
protected RouterRMAdminService	createRMAdminProxyService()
protected void	doSecureLogin()
RouterClientRMService	getClientRMProxyService()
static long	getClusterTimeStamp()
org.apache.hadoop.yarn.server.webproxy.FedAppReportFetcher	getFetcher()
static java.lang.String	getProxyHostAndPort(org.apache.hadoop.conf.Configuration conf)
RouterRMAdminService	getRmAdminProxyService()
org.apache.hadoop.yarn.webapp.WebApp	getWebapp()
static void	main(java.lang.String[] argv)
static void	removeApplication(org.apache.hadoop.conf.Configuration conf, java.lang.String applicationId)
protected void	serviceInit(org.apache.hadoop.conf.Configuration config)
protected void	serviceStart()
protected void	serviceStop()
protected void	shutDown()
void	startWepApp()

Methods inherited from class org.apache.hadoop.service.CompositeService

addIfService, addService, getServices, removeService

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Field Detail

clientRMProxyService

@VisibleForTesting
protected RouterClientRMService clientRMProxyService

rmAdminProxyService

@VisibleForTesting
protected RouterRMAdminService rmAdminProxyService

webAppAddress

@VisibleForTesting
protected java.lang.String webAppAddress

SHUTDOWN_HOOK_PRIORITY

public static final int SHUTDOWN_HOOK_PRIORITY

Priority of the Router shutdown hook.

See Also:

Constant Field Values

Constructor Detail

Router

public Router()

Method Detail

doSecureLogin

protected void doSecureLogin()
                      throws java.io.IOException

Throws:

java.io.IOException

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration config)
                    throws java.lang.Exception

Overrides:

serviceInit in class org.apache.hadoop.service.CompositeService

Throws:

java.lang.Exception

serviceStart

protected void serviceStart()
                     throws java.lang.Exception

Overrides:

serviceStart in class org.apache.hadoop.service.CompositeService

Throws:

java.lang.Exception

serviceStop

protected void serviceStop()
                    throws java.lang.Exception

Overrides:

serviceStop in class org.apache.hadoop.service.CompositeService

Throws:

java.lang.Exception

shutDown

protected void shutDown()

createClientRMProxyService

protected RouterClientRMService createClientRMProxyService()

createRMAdminProxyService

protected RouterRMAdminService createRMAdminProxyService()

getWebapp

@Private
public org.apache.hadoop.yarn.webapp.WebApp getWebapp()

startWepApp

@VisibleForTesting
public void startWepApp()

getProxyHostAndPort

public static java.lang.String getProxyHostAndPort(org.apache.hadoop.conf.Configuration conf)

main

public static void main(java.lang.String[] argv)

getClientRMProxyService

@VisibleForTesting
public RouterClientRMService getClientRMProxyService()

getRmAdminProxyService

@VisibleForTesting
public RouterRMAdminService getRmAdminProxyService()

getClusterTimeStamp

public static long getClusterTimeStamp()

getFetcher

@VisibleForTesting
public org.apache.hadoop.yarn.server.webproxy.FedAppReportFetcher getFetcher()

removeApplication

@VisibleForTesting
public static void removeApplication(org.apache.hadoop.conf.Configuration conf,
                                     java.lang.String applicationId)
                              throws java.lang.Exception

Throws:

java.lang.Exception