Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf

Class MutableCSConfigurationProvider

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf.MutableCSConfigurationProvider

All Implemented Interfaces:

CSConfigurationProvider, MutableConfigurationProvider

public class MutableCSConfigurationProvider
extends Object
implements CSConfigurationProvider, MutableConfigurationProvider

CS configuration provider which implements MutableConfigurationProvider for modifying capacity scheduler configuration.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
MutableCSConfigurationProvider(RMContext rmContext)

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.conf.Configuration	applyChanges(org.apache.hadoop.conf.Configuration oldConfiguration, org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo confUpdate)	Apply the changes on top of the actual configuration.
void	close()	Closes the configuration provider, releasing any required resources.
void	confirmPendingMutation(YarnConfigurationStore.LogMutation pendingMutation, boolean isValid)	Confirm last logged mutation.
void	formatConfigurationInStore(org.apache.hadoop.conf.Configuration config)
ConfigurationMutationACLPolicy	getAclMutationPolicy()	Get the acl mutation policy for this configuration provider.
org.apache.hadoop.conf.Configuration	getConfiguration()	Returns scheduler configuration cached in this provider.
long	getConfigVersion()	Get the last updated scheduler config version.
protected YarnConfigurationStore	getConfStore()
protected org.apache.hadoop.conf.Configuration	getInitSchedulerConfig()
void	init(org.apache.hadoop.conf.Configuration config)	Initialize the configuration provider with given conf.
CapacitySchedulerConfiguration	loadConfiguration(org.apache.hadoop.conf.Configuration configuration)	Loads capacity scheduler configuration object.
YarnConfigurationStore.LogMutation	logAndApplyMutation(org.apache.hadoop.security.UserGroupInformation user, org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo confUpdate)	Log user's requested configuration mutation, and applies it in-memory.
void	reloadConfigurationFromStore()	Called when a new ResourceManager is starting/becomes active.
void	revertToOldConfig(org.apache.hadoop.conf.Configuration config)

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

MutableCSConfigurationProvider

public MutableCSConfigurationProvider(RMContext rmContext)

Method Details

getInitSchedulerConfig

protected org.apache.hadoop.conf.Configuration getInitSchedulerConfig()

init

public void init(org.apache.hadoop.conf.Configuration config)
          throws IOException

Description copied from interface: CSConfigurationProvider

Initialize the configuration provider with given conf.

Specified by:

init in interface CSConfigurationProvider

Parameters:

config - configuration to initialize with

Throws:

IOException - if initialization fails due to misconfiguration

close

public void close()
           throws IOException

Description copied from interface: MutableConfigurationProvider

Closes the configuration provider, releasing any required resources.

Specified by:

close in interface MutableConfigurationProvider

Throws:

IOException - on failure to close

getConfStore

@VisibleForTesting
protected YarnConfigurationStore getConfStore()

loadConfiguration

public CapacitySchedulerConfiguration loadConfiguration(org.apache.hadoop.conf.Configuration configuration)
                                                 throws IOException

Description copied from interface: CSConfigurationProvider

Loads capacity scheduler configuration object.

Specified by:

loadConfiguration in interface CSConfigurationProvider

Parameters:

configuration - initial bootstrap configuration

Returns:

CS configuration

Throws:

IOException - if fail to retrieve configuration

getConfiguration

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

Description copied from interface: MutableConfigurationProvider

Returns scheduler configuration cached in this provider.

Specified by:

getConfiguration in interface MutableConfigurationProvider

Returns:

scheduler configuration.

getConfigVersion

public long getConfigVersion()
                      throws Exception

Description copied from interface: MutableConfigurationProvider

Get the last updated scheduler config version.

Specified by:

getConfigVersion in interface MutableConfigurationProvider

Returns:

Last updated scheduler config version.

Throws:

Exception - exception occurs.

getAclMutationPolicy

public ConfigurationMutationACLPolicy getAclMutationPolicy()

Description copied from interface: MutableConfigurationProvider

Get the acl mutation policy for this configuration provider.

Specified by:

getAclMutationPolicy in interface MutableConfigurationProvider

Returns:

The acl mutation policy.

logAndApplyMutation

public YarnConfigurationStore.LogMutation logAndApplyMutation(org.apache.hadoop.security.UserGroupInformation user,
 org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo confUpdate)
                                                       throws Exception

Description copied from interface: MutableConfigurationProvider

Log user's requested configuration mutation, and applies it in-memory.

Specified by:

logAndApplyMutation in interface MutableConfigurationProvider

Parameters:

user - User who requested the change

confUpdate - User's requested configuration change

Returns:

LogMutation with update info from given SchedConfUpdateInfo

Throws:

Exception - if logging the mutation fails

applyChanges

public org.apache.hadoop.conf.Configuration applyChanges(org.apache.hadoop.conf.Configuration oldConfiguration,
 org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo confUpdate)
                                                  throws IOException

Description copied from interface: MutableConfigurationProvider

Apply the changes on top of the actual configuration.

Specified by:

applyChanges in interface MutableConfigurationProvider

Parameters:

oldConfiguration - actual configuration

confUpdate - changelist

Returns:

new configuration with the applied changed

Throws:

IOException - if the merge failed

formatConfigurationInStore

public void formatConfigurationInStore(org.apache.hadoop.conf.Configuration config)
                                throws Exception

Specified by:

formatConfigurationInStore in interface MutableConfigurationProvider

Throws:

Exception

revertToOldConfig

public void revertToOldConfig(org.apache.hadoop.conf.Configuration config)
                       throws Exception

Specified by:

revertToOldConfig in interface MutableConfigurationProvider

Throws:

Exception

confirmPendingMutation

public void confirmPendingMutation(YarnConfigurationStore.LogMutation pendingMutation,
 boolean isValid)
                            throws Exception

Description copied from interface: MutableConfigurationProvider

Confirm last logged mutation.

Specified by:

confirmPendingMutation in interface MutableConfigurationProvider

Parameters:

pendingMutation - the log mutation to apply

isValid - if the last logged mutation is applied to scheduler properly.

Throws:

Exception - if confirming mutation fails

reloadConfigurationFromStore

public void reloadConfigurationFromStore()
                                  throws Exception

Description copied from interface: MutableConfigurationProvider

Called when a new ResourceManager is starting/becomes active. Ensures configuration is up-to-date.

Specified by:

reloadConfigurationFromStore in interface MutableConfigurationProvider

Throws:

Exception - if configuration could not be refreshed from store