Package org.apache.hadoop.yarn.client.cli

Class RouterCLI

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.yarn.client.cli.RouterCLI

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

public class RouterCLI
extends org.apache.hadoop.conf.Configured
implements org.apache.hadoop.util.Tool

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.util.Map<java.lang.String,org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos>	ADMIN_USAGE
protected static org.apache.hadoop.ha.HAAdmin.UsageInfo	APPLICATION_DELETE_USAGE
protected static java.lang.String	APPLICATION_DELETE_USAGE_EXAMPLE_1
protected static java.lang.String	APPLICATION_DELETE_USAGE_EXAMPLE_DESC
protected static org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos	APPLICATION_USAGEINFOS
protected static java.lang.String	DEREGISTER_SUBCLUSTER_EXAMPLE_1
protected static java.lang.String	DEREGISTER_SUBCLUSTER_EXAMPLE_2
protected static java.lang.String	DEREGISTER_SUBCLUSTER_HELP_INFO
protected static org.apache.hadoop.ha.HAAdmin.UsageInfo	DEREGISTER_SUBCLUSTER_USAGE
protected static java.lang.String	GET_SUBCLUSTER_EXAMPLE
protected static org.apache.hadoop.ha.HAAdmin.UsageInfo	GET_SUBCLUSTER_USAGE
protected static org.apache.hadoop.ha.HAAdmin.UsageInfo	POLICY_BATCH_SAVE_USAGE
protected static java.lang.String	POLICY_BATCH_SAVE_USAGE_EXAMPLE_1
protected static java.lang.String	POLICY_BATCH_SAVE_USAGE_EXAMPLE_2
protected static java.lang.String	POLICY_BATCH_SAVE_USAGE_EXAMPLE_DESC
protected static org.apache.hadoop.ha.HAAdmin.UsageInfo	POLICY_DELETE_USAGE
protected static java.lang.String	POLICY_DELETE_USAGE_EXAMPLE_DESC
protected static java.lang.String	POLICY_DELETE_USAGE_EXAMPLE1
protected static java.lang.String	POLICY_DELETE_USAGE_EXAMPLE2
protected static org.apache.hadoop.ha.HAAdmin.UsageInfo	POLICY_LIST_USAGE
protected static java.lang.String	POLICY_LIST_USAGE_EXAMPLE_1
protected static java.lang.String	POLICY_LIST_USAGE_EXAMPLE_2
protected static java.lang.String	POLICY_LIST_USAGE_EXAMPLE_DESC
protected static org.apache.hadoop.ha.HAAdmin.UsageInfo	POLICY_SAVE_USAGE
protected static java.lang.String	POLICY_SAVE_USAGE_EXAMPLE_1
protected static java.lang.String	POLICY_SAVE_USAGE_EXAMPLE_2
protected static java.lang.String	POLICY_SAVE_USAGE_EXAMPLE_DESC
protected static org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos	POLICY_USAGEINFOS
protected static org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos	SUBCLUSTER_USAGEINFOS

Constructor Summary

Constructors

Constructor	Description
RouterCLI()
RouterCLI(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
protected org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol	createAdminProtocol()
java.util.Map<java.lang.String,org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos>	getAdminUsage()
static org.apache.hadoop.ha.HAAdmin.UsageInfo	getPolicyBatchSaveUsage()
protected int	handDeletePolicy(java.lang.String queue)	Delete queue weight information.
protected int	handListPolicies(int pageSize, int currentPage, java.lang.String queue, java.util.List<java.lang.String> queues)	Handles the list federation policies based on the specified parameters.
static void	main(java.lang.String[] args)
protected java.util.List<org.apache.hadoop.yarn.server.api.protocolrecords.FederationQueueWeight>	parsePoliciesByXml(java.lang.String policiesXml)	Parse FederationQueueWeight from the xml configuration file.
protected org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyRequest	parsePolicy(java.lang.String policy)	We will parse the policy, and it has specific formatting requirements.
protected int	parseXml2PoliciesAndBatchSavePolicies(java.lang.String policiesXml)	Parse Policies from XML and save them in batches to FederationStateStore.
int	run(java.lang.String[] args)

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

getConf, setConf

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, setConf

Field Detail

DEREGISTER_SUBCLUSTER_USAGE

protected static final org.apache.hadoop.ha.HAAdmin.UsageInfo DEREGISTER_SUBCLUSTER_USAGE

DEREGISTER_SUBCLUSTER_EXAMPLE_1

protected static final java.lang.String DEREGISTER_SUBCLUSTER_EXAMPLE_1

See Also:

Constant Field Values

DEREGISTER_SUBCLUSTER_EXAMPLE_2

protected static final java.lang.String DEREGISTER_SUBCLUSTER_EXAMPLE_2

See Also:

Constant Field Values

DEREGISTER_SUBCLUSTER_HELP_INFO

protected static final java.lang.String DEREGISTER_SUBCLUSTER_HELP_INFO

See Also:

Constant Field Values

GET_SUBCLUSTER_USAGE

protected static final org.apache.hadoop.ha.HAAdmin.UsageInfo GET_SUBCLUSTER_USAGE

GET_SUBCLUSTER_EXAMPLE

protected static final java.lang.String GET_SUBCLUSTER_EXAMPLE

See Also:

Constant Field Values

SUBCLUSTER_USAGEINFOS

protected static final org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos SUBCLUSTER_USAGEINFOS

POLICY_SAVE_USAGE

protected static final org.apache.hadoop.ha.HAAdmin.UsageInfo POLICY_SAVE_USAGE

POLICY_SAVE_USAGE_EXAMPLE_DESC

protected static final java.lang.String POLICY_SAVE_USAGE_EXAMPLE_DESC

See Also:

Constant Field Values

POLICY_SAVE_USAGE_EXAMPLE_1

protected static final java.lang.String POLICY_SAVE_USAGE_EXAMPLE_1

See Also:

Constant Field Values

POLICY_SAVE_USAGE_EXAMPLE_2

protected static final java.lang.String POLICY_SAVE_USAGE_EXAMPLE_2

See Also:

Constant Field Values

POLICY_BATCH_SAVE_USAGE

protected static final org.apache.hadoop.ha.HAAdmin.UsageInfo POLICY_BATCH_SAVE_USAGE

POLICY_BATCH_SAVE_USAGE_EXAMPLE_DESC

protected static final java.lang.String POLICY_BATCH_SAVE_USAGE_EXAMPLE_DESC

See Also:

Constant Field Values

POLICY_BATCH_SAVE_USAGE_EXAMPLE_1

protected static final java.lang.String POLICY_BATCH_SAVE_USAGE_EXAMPLE_1

See Also:

Constant Field Values

POLICY_BATCH_SAVE_USAGE_EXAMPLE_2

protected static final java.lang.String POLICY_BATCH_SAVE_USAGE_EXAMPLE_2

See Also:

Constant Field Values

POLICY_LIST_USAGE

protected static final org.apache.hadoop.ha.HAAdmin.UsageInfo POLICY_LIST_USAGE

POLICY_LIST_USAGE_EXAMPLE_DESC

protected static final java.lang.String POLICY_LIST_USAGE_EXAMPLE_DESC

See Also:

Constant Field Values

POLICY_LIST_USAGE_EXAMPLE_1

protected static final java.lang.String POLICY_LIST_USAGE_EXAMPLE_1

See Also:

Constant Field Values

POLICY_LIST_USAGE_EXAMPLE_2

protected static final java.lang.String POLICY_LIST_USAGE_EXAMPLE_2

See Also:

Constant Field Values

POLICY_DELETE_USAGE

protected static final org.apache.hadoop.ha.HAAdmin.UsageInfo POLICY_DELETE_USAGE

POLICY_DELETE_USAGE_EXAMPLE_DESC

protected static final java.lang.String POLICY_DELETE_USAGE_EXAMPLE_DESC

See Also:

Constant Field Values

POLICY_DELETE_USAGE_EXAMPLE1

protected static final java.lang.String POLICY_DELETE_USAGE_EXAMPLE1

See Also:

Constant Field Values

POLICY_DELETE_USAGE_EXAMPLE2

protected static final java.lang.String POLICY_DELETE_USAGE_EXAMPLE2

See Also:

Constant Field Values

POLICY_USAGEINFOS

protected static final org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos POLICY_USAGEINFOS

APPLICATION_DELETE_USAGE

protected static final org.apache.hadoop.ha.HAAdmin.UsageInfo APPLICATION_DELETE_USAGE

APPLICATION_DELETE_USAGE_EXAMPLE_DESC

protected static final java.lang.String APPLICATION_DELETE_USAGE_EXAMPLE_DESC

See Also:

Constant Field Values

APPLICATION_DELETE_USAGE_EXAMPLE_1

protected static final java.lang.String APPLICATION_DELETE_USAGE_EXAMPLE_1

See Also:

Constant Field Values

APPLICATION_USAGEINFOS

protected static final org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos APPLICATION_USAGEINFOS

ADMIN_USAGE

protected static final java.util.Map<java.lang.String,org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos> ADMIN_USAGE

Constructor Detail

RouterCLI

public RouterCLI()

RouterCLI

public RouterCLI(org.apache.hadoop.conf.Configuration conf)

Method Detail

createAdminProtocol

protected org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol createAdminProtocol()
                                                                                               throws java.io.IOException

Throws:

java.io.IOException

parsePolicy

protected org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyRequest parsePolicy(java.lang.String policy)
                                                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException

We will parse the policy, and it has specific formatting requirements. 1. queue,router weight,amrm weight,headroomalpha FederationQueueWeight. 2. the sum of weights for all sub-clusters in routerWeight/amrmWeight should be 1.

Parameters:

policy - queue weight.

Returns:

If the conversion is correct, we will get the FederationQueueWeight, otherwise an exception will be thrown.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.

parseXml2PoliciesAndBatchSavePolicies

protected int parseXml2PoliciesAndBatchSavePolicies(java.lang.String policiesXml)

Parse Policies from XML and save them in batches to FederationStateStore. We save 20 policies in one batch. If the user needs to save 1000 policies, it will cycle 50 times. Every time a page is saved, we will print whether a page has been saved successfully or failed.

Parameters:

policiesXml - Policies Xml Path.

Returns:

0, success; 1, failed.

parsePoliciesByXml

protected java.util.List<org.apache.hadoop.yarn.server.api.protocolrecords.FederationQueueWeight> parsePoliciesByXml(java.lang.String policiesXml)
                                                                                                              throws java.io.IOException,
                                                                                                                     org.xml.sax.SAXException,
                                                                                                                     javax.xml.parsers.ParserConfigurationException

Parse FederationQueueWeight from the xml configuration file.

We allow users to provide an xml configuration file, which stores the weight information of the queue.

Parameters:

policiesXml - Policies Xml Path.

Returns:

FederationQueueWeight List.

Throws:

java.io.IOException - an I/O exception of some sort has occurred.

org.xml.sax.SAXException - Encapsulate a general SAX error or warning.

javax.xml.parsers.ParserConfigurationException - a serious configuration error..

handListPolicies

protected int handListPolicies(int pageSize,
                               int currentPage,
                               java.lang.String queue,
                               java.util.List<java.lang.String> queues)

Handles the list federation policies based on the specified parameters.

Parameters:

pageSize - Records displayed per page.

currentPage - The current page number.

queue - The name of the queue to be filtered.

queues - list of queues to filter.

Returns:

0, success; 1, failed.

handDeletePolicy

protected int handDeletePolicy(java.lang.String queue)

Delete queue weight information.

Parameters:

queue - Queue whose policy needs to be deleted.

Returns:

0, success; 1, failed.

run

public int run(java.lang.String[] args)
        throws java.lang.Exception

Specified by:

run in interface org.apache.hadoop.util.Tool

Throws:

java.lang.Exception

getPolicyBatchSaveUsage

public static org.apache.hadoop.ha.HAAdmin.UsageInfo getPolicyBatchSaveUsage()

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getAdminUsage

@VisibleForTesting
public java.util.Map<java.lang.String,org.apache.hadoop.yarn.client.cli.RouterCLI.RouterCmdUsageInfos> getAdminUsage()