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

Class LocalityRouterPolicy

java.lang.Object

org.apache.hadoop.yarn.server.federation.policies.AbstractConfigurableFederationPolicy

org.apache.hadoop.yarn.server.federation.policies.router.AbstractRouterPolicy

org.apache.hadoop.yarn.server.federation.policies.router.WeightedRandomRouterPolicy

org.apache.hadoop.yarn.server.federation.policies.router.LocalityRouterPolicy

All Implemented Interfaces:

ConfigurableFederationPolicy, FederationRouterPolicy

public class LocalityRouterPolicy
extends WeightedRandomRouterPolicy

This policy selects the subcluster depending on the node where the Client wants to run its application. It succeeds if: - There are three AMContainerResourceRequests in the order NODE, RACK, ANY It falls back to WeightedRandomRouterPolicy in case of: - Null or empty AMContainerResourceRequests; - One AMContainerResourceRequests and it has ANY as ResourceName; - The node is in blacklisted SubClusters. It fails if: - The node does not exist and RelaxLocality is False; - We have an invalid number (not 0, 1 or 3) resource requests

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
LocalityRouterPolicy()

Method Summary

Modifier and Type	Method	Description
SubClusterId	getHomeSubcluster(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appSubmissionContext, List<SubClusterId> blackListSubClusters)	Simply picks from alphabetically-sorted active subclusters based on the hash of query name.
void	reinitialize(FederationPolicyInitializationContext policyContext)	This method is invoked to initialize of update the configuration of policies.

Methods inherited from class org.apache.hadoop.yarn.server.federation.policies.router.WeightedRandomRouterPolicy

chooseSubCluster

Methods inherited from class org.apache.hadoop.yarn.server.federation.policies.router.AbstractRouterPolicy

getReservationHomeSubcluster, prefilterSubClusters, validate, validate

Methods inherited from class org.apache.hadoop.yarn.server.federation.policies.AbstractConfigurableFederationPolicy

getActiveSubclusters, getIsDirty, getPolicyContext, getPolicyInfo, setPolicyContext, setPolicyInfo

Methods inherited from class java.lang.Object

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

Field Details

LOG

public static final org.slf4j.Logger LOG

Constructor Details

LocalityRouterPolicy

public LocalityRouterPolicy()

Method Details

reinitialize

public void reinitialize(FederationPolicyInitializationContext policyContext)
                  throws FederationPolicyInitializationException

Description copied from interface: ConfigurableFederationPolicy

This method is invoked to initialize of update the configuration of policies. The implementor should provide try-n-swap semantics, and retain state if possible.

Specified by:

reinitialize in interface ConfigurableFederationPolicy

Overrides:

reinitialize in class AbstractConfigurableFederationPolicy

Parameters:

policyContext - the new context to provide to implementor.

Throws:

FederationPolicyInitializationException - in case the initialization fails.

getHomeSubcluster

public SubClusterId getHomeSubcluster(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appSubmissionContext,
 List<SubClusterId> blackListSubClusters)
                               throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from class: AbstractRouterPolicy

Simply picks from alphabetically-sorted active subclusters based on the hash of query name. Jobs of the same queue will all be routed to the same sub-cluster, as far as the number of active sub-cluster and their names remain the same.

Specified by:

getHomeSubcluster in interface FederationRouterPolicy

Overrides:

getHomeSubcluster in class AbstractRouterPolicy

Parameters:

appSubmissionContext - the ApplicationSubmissionContext that has to be routed to an appropriate subCluster for execution.

blackListSubClusters - the list of subClusters as identified by SubClusterId to blackList from the selection of the home subCluster.

Returns:

a hash-based chosen SubClusterId that will be the "home" for this application.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if there are no active subclusters.