public class MutableCSConfigurationProvider extends Object implements CSConfigurationProvider, MutableConfigurationProvider
MutableConfigurationProvider for modifying capacity scheduler
 configuration.| Modifier and Type | Field and Description | 
|---|---|
| static org.slf4j.Logger | LOG | 
| Constructor and Description | 
|---|
| MutableCSConfigurationProvider(RMContext rmContext) | 
| Modifier and Type | Method and 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. | 
| YarnConfigurationStore | getConfStore() | 
| 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) | 
public MutableCSConfigurationProvider(RMContext rmContext)
public void init(org.apache.hadoop.conf.Configuration config)
          throws IOException
CSConfigurationProviderinit in interface CSConfigurationProviderconfig - configuration to initialize withIOException - if initialization fails due to misconfigurationpublic void close()
           throws IOException
MutableConfigurationProviderclose in interface MutableConfigurationProviderIOException - on failure to closepublic YarnConfigurationStore getConfStore()
public CapacitySchedulerConfiguration loadConfiguration(org.apache.hadoop.conf.Configuration configuration) throws IOException
CSConfigurationProviderloadConfiguration in interface CSConfigurationProviderconfiguration - initial bootstrap configurationIOException - if fail to retrieve configurationpublic org.apache.hadoop.conf.Configuration getConfiguration()
MutableConfigurationProvidergetConfiguration in interface MutableConfigurationProviderpublic long getConfigVersion()
                      throws Exception
MutableConfigurationProvidergetConfigVersion in interface MutableConfigurationProviderExceptionpublic ConfigurationMutationACLPolicy getAclMutationPolicy()
MutableConfigurationProvidergetAclMutationPolicy in interface MutableConfigurationProviderpublic YarnConfigurationStore.LogMutation logAndApplyMutation(org.apache.hadoop.security.UserGroupInformation user, org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo confUpdate) throws Exception
MutableConfigurationProviderlogAndApplyMutation in interface MutableConfigurationProvideruser - User who requested the changeconfUpdate - User's requested configuration changeException - if logging the mutation failspublic org.apache.hadoop.conf.Configuration applyChanges(org.apache.hadoop.conf.Configuration oldConfiguration,
                                                         org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo confUpdate)
                                                  throws IOException
MutableConfigurationProviderapplyChanges in interface MutableConfigurationProvideroldConfiguration - actual configurationconfUpdate - changelistIOException - if the merge failedpublic void formatConfigurationInStore(org.apache.hadoop.conf.Configuration config)
                                throws Exception
formatConfigurationInStore in interface MutableConfigurationProviderExceptionpublic void revertToOldConfig(org.apache.hadoop.conf.Configuration config)
                       throws Exception
revertToOldConfig in interface MutableConfigurationProviderExceptionpublic void confirmPendingMutation(YarnConfigurationStore.LogMutation pendingMutation, boolean isValid) throws Exception
MutableConfigurationProviderconfirmPendingMutation in interface MutableConfigurationProviderpendingMutation - the log mutation to applyisValid - if the last logged mutation is applied to scheduler
                properly.Exception - if confirming mutation failspublic void reloadConfigurationFromStore()
                                  throws Exception
MutableConfigurationProviderreloadConfigurationFromStore in interface MutableConfigurationProviderException - if configuration could not be refreshed from storeCopyright © 2008–2023 Apache Software Foundation. All rights reserved.