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

Class FederationPolicyUtils

java.lang.Object

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

@Private
public final class FederationPolicyUtils
extends java.lang.Object

Utility class for Federation policy.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NO_ACTIVE_SUBCLUSTER_AVAILABLE

Method Summary

Modifier and Type	Method	Description
static int	getWeightedRandom(java.util.ArrayList<java.lang.Float> weights)	Select a random bin according to the weight array for the bins.
static FederationPolicyManager	instantiatePolicyManager(java.lang.String newType)	A utilize method to instantiate a policy manager class given the type (class name) from SubClusterPolicyConfiguration.
static FederationAMRMProxyPolicy	loadAMRMPolicy(java.lang.String queue, FederationAMRMProxyPolicy oldPolicy, org.apache.hadoop.conf.Configuration conf, FederationStateStoreFacade federationFacade, SubClusterId homeSubClusterId)	Get AMRMProxy policy from state store, using default queue and configuration as fallback.
static SubClusterPolicyConfiguration	loadPolicyConfiguration(java.lang.String queue, org.apache.hadoop.conf.Configuration conf, FederationStateStoreFacade federationFacade)	Get Federation policy configuration from state store, using default queue and configuration as fallback.
static void	setRand(long seed)
static void	validateSubClusterAvailability(java.util.Collection<SubClusterId> activeSubClusters, java.util.Collection<SubClusterId> blackListSubClusters)	Validate if there is any active subcluster that is not blacklisted, it will throw an exception if there are no usable subclusters.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ACTIVE_SUBCLUSTER_AVAILABLE

public static final java.lang.String NO_ACTIVE_SUBCLUSTER_AVAILABLE

See Also:

Constant Field Values

Method Detail

instantiatePolicyManager

public static FederationPolicyManager instantiatePolicyManager(java.lang.String newType)
                                                        throws FederationPolicyInitializationException

A utilize method to instantiate a policy manager class given the type (class name) from SubClusterPolicyConfiguration.

Parameters:

newType - class name of the policy manager to create

Returns:

Policy manager

Throws:

FederationPolicyInitializationException - if fails

loadPolicyConfiguration

public static SubClusterPolicyConfiguration loadPolicyConfiguration(java.lang.String queue,
                                                                    org.apache.hadoop.conf.Configuration conf,
                                                                    FederationStateStoreFacade federationFacade)

Get Federation policy configuration from state store, using default queue and configuration as fallback.

Parameters:

queue - the queue of the application

conf - the YARN configuration

federationFacade - state store facade

Returns:

SubClusterPolicyConfiguration recreated

loadAMRMPolicy

public static FederationAMRMProxyPolicy loadAMRMPolicy(java.lang.String queue,
                                                       FederationAMRMProxyPolicy oldPolicy,
                                                       org.apache.hadoop.conf.Configuration conf,
                                                       FederationStateStoreFacade federationFacade,
                                                       SubClusterId homeSubClusterId)
                                                throws FederationPolicyInitializationException

Get AMRMProxy policy from state store, using default queue and configuration as fallback.

Parameters:

queue - the queue of the application

oldPolicy - the previous policy instance (can be null)

conf - the YARN configuration

federationFacade - state store facade

homeSubClusterId - home sub-cluster id

Returns:

FederationAMRMProxyPolicy recreated

Throws:

FederationPolicyInitializationException - if fails

validateSubClusterAvailability

public static void validateSubClusterAvailability(java.util.Collection<SubClusterId> activeSubClusters,
                                                  java.util.Collection<SubClusterId> blackListSubClusters)
                                           throws FederationPolicyException

Validate if there is any active subcluster that is not blacklisted, it will throw an exception if there are no usable subclusters.

Parameters:

activeSubClusters - the list of subClusters as identified by SubClusterId currently active.

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

Throws:

FederationPolicyException - if there are no usable subclusters.

getWeightedRandom

public static int getWeightedRandom(java.util.ArrayList<java.lang.Float> weights)

Select a random bin according to the weight array for the bins. Only bins with positive weights will be considered. If no positive weight found, return -1.

Parameters:

weights - the weight array

Returns:

the index of the sample in the array

setRand

@VisibleForTesting
public static void setRand(long seed)