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

Interface MutableConfigurationProvider

All Known Implementing Classes:

MutableCSConfigurationProvider

public interface MutableConfigurationProvider

Interface for allowing changing scheduler configurations.

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 conf)
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.
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)

Method Detail

getAclMutationPolicy

ConfigurationMutationACLPolicy getAclMutationPolicy()

Get the acl mutation policy for this configuration provider.

Returns:

The acl mutation policy.

reloadConfigurationFromStore

void reloadConfigurationFromStore()
                           throws java.lang.Exception

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

Throws:

java.lang.Exception - if configuration could not be refreshed from store

logAndApplyMutation

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

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

Parameters:

user - User who requested the change

confUpdate - User's requested configuration change

Returns:

LogMutation with update info from given SchedConfUpdateInfo

Throws:

java.lang.Exception - if logging the mutation fails

applyChanges

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

Apply the changes on top of the actual configuration.

Parameters:

oldConfiguration - actual configuration

confUpdate - changelist

Returns:

new configuration with the applied changed

Throws:

java.io.IOException - if the merge failed

confirmPendingMutation

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

Confirm last logged mutation.

Parameters:

pendingMutation - the log mutation to apply

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

Throws:

java.lang.Exception - if confirming mutation fails

getConfiguration

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

Returns scheduler configuration cached in this provider.

Returns:

scheduler configuration.

getConfigVersion

long getConfigVersion()
               throws java.lang.Exception

Get the last updated scheduler config version.

Returns:

Last updated scheduler config version.

Throws:

java.lang.Exception - exception occurs.

formatConfigurationInStore

void formatConfigurationInStore(org.apache.hadoop.conf.Configuration conf)
                         throws java.lang.Exception

Throws:

java.lang.Exception

revertToOldConfig

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

Throws:

java.lang.Exception

close

void close()
    throws java.io.IOException

Closes the configuration provider, releasing any required resources.

Throws:

java.io.IOException - on failure to close