Class AdminService
java.lang.Object
org.apache.hadoop.service.AbstractService
org.apache.hadoop.service.CompositeService
org.apache.hadoop.yarn.server.resourcemanager.AdminService
- All Implemented Interfaces:
Closeable,AutoCloseable,org.apache.hadoop.ha.HAServiceProtocol,org.apache.hadoop.service.Service,org.apache.hadoop.tools.GetUserMappingsProtocol,org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol
public class AdminService
extends org.apache.hadoop.service.CompositeService
implements org.apache.hadoop.ha.HAServiceProtocol, org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.hadoop.service.CompositeService
org.apache.hadoop.service.CompositeService.CompositeServiceShutdownHookNested classes/interfaces inherited from interface org.apache.hadoop.ha.HAServiceProtocol
org.apache.hadoop.ha.HAServiceProtocol.HAServiceState, org.apache.hadoop.ha.HAServiceProtocol.RequestSource, org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfoNested classes/interfaces inherited from interface org.apache.hadoop.service.Service
org.apache.hadoop.service.Service.STATE -
Field Summary
Fields inherited from class org.apache.hadoop.service.CompositeService
STOP_ONLY_STARTED_SERVICESFields inherited from interface org.apache.hadoop.tools.GetUserMappingsProtocol
versionIDFields inherited from interface org.apache.hadoop.ha.HAServiceProtocol
versionID -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsResponseaddToClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.BatchSaveFederationQueuePoliciesResponsebatchSaveFederationQueuePolicies(org.apache.hadoop.yarn.server.api.protocolrecords.BatchSaveFederationQueuePoliciesRequest request) In YARN-Federation mode, this method provides a way to save queue policies in batches.org.apache.hadoop.yarn.server.api.protocolrecords.CheckForDecommissioningNodesResponsecheckForDecommissioningNodes(org.apache.hadoop.yarn.server.api.protocolrecords.CheckForDecommissioningNodesRequest checkForDecommissioningNodesRequest) org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationApplicationResponsedeleteFederationApplication(org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationApplicationRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationQueuePoliciesResponsedeleteFederationPoliciesByQueues(org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationQueuePoliciesRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.DeregisterSubClusterResponsederegisterSubCluster(org.apache.hadoop.yarn.server.api.protocolrecords.DeregisterSubClusterRequest request) In YARN Federation mode, We allow users to mark subClusters With no heartbeat for a long time as SC_LOST state.org.apache.hadoop.security.authorize.AccessControlListorg.apache.hadoop.yarn.server.api.protocolrecords.GetSubClustersResponsegetFederationSubClusters(org.apache.hadoop.yarn.server.api.protocolrecords.GetSubClustersRequest request) String[]getGroupsForUser(String user) org.apache.hadoop.ipc.RPC.Serverorg.apache.hadoop.ha.HAServiceStatusReturn the HA status of this RM.org.apache.hadoop.yarn.server.api.protocolrecords.QueryFederationQueuePoliciesResponselistFederationQueuePolicies(org.apache.hadoop.yarn.server.api.protocolrecords.QueryFederationQueuePoliciesRequest request) protected org.apache.hadoop.conf.Configurationorg.apache.hadoop.yarn.server.api.protocolrecords.NodesToAttributesMappingResponsemapAttributesToNodes(org.apache.hadoop.yarn.server.api.protocolrecords.NodesToAttributesMappingRequest request) voidorg.apache.hadoop.yarn.server.api.protocolrecords.RefreshAdminAclsResponserefreshAdminAcls(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshAdminAclsRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.RefreshClusterMaxPriorityResponserefreshClusterMaxPriority(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshClusterMaxPriorityRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResponserefreshNodes(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResourcesResponserefreshNodesResources(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResourcesRequest request) voidorg.apache.hadoop.yarn.server.api.protocolrecords.RefreshQueuesResponserefreshQueues(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshQueuesRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.RefreshServiceAclsResponserefreshServiceAcls(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshServiceAclsRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.RefreshSuperUserGroupsConfigurationResponserefreshSuperUserGroupsConfiguration(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshSuperUserGroupsConfigurationRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.RefreshUserToGroupsMappingsResponserefreshUserToGroupsMappings(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshUserToGroupsMappingsRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsResponseremoveFromClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeResponsereplaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest request) org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyResponsesaveFederationQueuePolicy(org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyRequest request) In YARN-Federation mode, We will be storing the Policy information for Queues.voidserviceInit(org.apache.hadoop.conf.Configuration conf) protected voidprotected voidprotected voidprotected voidvoidtransitionToActive(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo) voidtransitionToObserver(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo) voidtransitionToStandby(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo) org.apache.hadoop.yarn.server.api.protocolrecords.UpdateNodeResourceResponseupdateNodeResource(org.apache.hadoop.yarn.server.api.protocolrecords.UpdateNodeResourceRequest request) Methods inherited from class org.apache.hadoop.service.CompositeService
addIfService, addService, getServices, removeServiceMethods inherited from class org.apache.hadoop.service.AbstractService
close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop
-
Constructor Details
-
AdminService
-
-
Method Details
-
serviceInit
- Overrides:
serviceInitin classorg.apache.hadoop.service.CompositeService- Throws:
Exception
-
serviceStart
- Overrides:
serviceStartin classorg.apache.hadoop.service.CompositeService- Throws:
Exception
-
serviceStop
- Overrides:
serviceStopin classorg.apache.hadoop.service.CompositeService- Throws:
Exception
-
startServer
- Throws:
Exception
-
stopServer
- Throws:
Exception
-
monitorHealth
- Specified by:
monitorHealthin interfaceorg.apache.hadoop.ha.HAServiceProtocol- Throws:
IOException
-
transitionToActive
public void transitionToActive(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo) throws IOException - Specified by:
transitionToActivein interfaceorg.apache.hadoop.ha.HAServiceProtocol- Throws:
IOException
-
transitionToStandby
public void transitionToStandby(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo) throws IOException - Specified by:
transitionToStandbyin interfaceorg.apache.hadoop.ha.HAServiceProtocol- Throws:
IOException
-
transitionToObserver
public void transitionToObserver(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo) throws IOException - Specified by:
transitionToObserverin interfaceorg.apache.hadoop.ha.HAServiceProtocol- Throws:
IOException
-
getServiceStatus
Return the HA status of this RM. This includes the current state and whether the RM is ready to become active.- Specified by:
getServiceStatusin interfaceorg.apache.hadoop.ha.HAServiceProtocol- Returns:
HAServiceStatusof the current RM- Throws:
IOException- if the caller does not have permissions
-
refreshQueues
public org.apache.hadoop.yarn.server.api.protocolrecords.RefreshQueuesResponse refreshQueues(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshQueuesRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, org.apache.hadoop.ipc.StandbyException - Specified by:
refreshQueuesin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionorg.apache.hadoop.ipc.StandbyException
-
loadNewConfiguration
protected org.apache.hadoop.conf.Configuration loadNewConfiguration() throws IOException, org.apache.hadoop.yarn.exceptions.YarnException- Throws:
IOExceptionorg.apache.hadoop.yarn.exceptions.YarnException
-
refreshQueues
@Private public void refreshQueues() throws IOException, org.apache.hadoop.yarn.exceptions.YarnException- Throws:
IOExceptionorg.apache.hadoop.yarn.exceptions.YarnException
-
refreshNodes
public org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResponse refreshNodes(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, org.apache.hadoop.ipc.StandbyException - Specified by:
refreshNodesin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionorg.apache.hadoop.ipc.StandbyException
-
refreshSuperUserGroupsConfiguration
public org.apache.hadoop.yarn.server.api.protocolrecords.RefreshSuperUserGroupsConfigurationResponse refreshSuperUserGroupsConfiguration(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshSuperUserGroupsConfigurationRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
refreshSuperUserGroupsConfigurationin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
refreshUserToGroupsMappings
public org.apache.hadoop.yarn.server.api.protocolrecords.RefreshUserToGroupsMappingsResponse refreshUserToGroupsMappings(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshUserToGroupsMappingsRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
refreshUserToGroupsMappingsin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
refreshAdminAcls
public org.apache.hadoop.yarn.server.api.protocolrecords.RefreshAdminAclsResponse refreshAdminAcls(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshAdminAclsRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
refreshAdminAclsin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
refreshServiceAcls
public org.apache.hadoop.yarn.server.api.protocolrecords.RefreshServiceAclsResponse refreshServiceAcls(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshServiceAclsRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
refreshServiceAclsin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
getGroupsForUser
- Specified by:
getGroupsForUserin interfaceorg.apache.hadoop.tools.GetUserMappingsProtocol- Throws:
IOException
-
updateNodeResource
public org.apache.hadoop.yarn.server.api.protocolrecords.UpdateNodeResourceResponse updateNodeResource(org.apache.hadoop.yarn.server.api.protocolrecords.UpdateNodeResourceRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
updateNodeResourcein interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
refreshNodesResources
public org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResourcesResponse refreshNodesResources(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResourcesRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, org.apache.hadoop.ipc.StandbyException - Specified by:
refreshNodesResourcesin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionorg.apache.hadoop.ipc.StandbyException
-
getAccessControlList
@VisibleForTesting public org.apache.hadoop.security.authorize.AccessControlList getAccessControlList() -
getServer
@VisibleForTesting public org.apache.hadoop.ipc.RPC.Server getServer() -
addToClusterNodeLabels
public org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsResponse addToClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
addToClusterNodeLabelsin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
removeFromClusterNodeLabels
public org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsResponse removeFromClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
removeFromClusterNodeLabelsin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
replaceLabelsOnNode
public org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeResponse replaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
replaceLabelsOnNodein interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
checkForDecommissioningNodes
public org.apache.hadoop.yarn.server.api.protocolrecords.CheckForDecommissioningNodesResponse checkForDecommissioningNodes(org.apache.hadoop.yarn.server.api.protocolrecords.CheckForDecommissioningNodesRequest checkForDecommissioningNodesRequest) throws IOException, org.apache.hadoop.yarn.exceptions.YarnException - Specified by:
checkForDecommissioningNodesin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
IOExceptionorg.apache.hadoop.yarn.exceptions.YarnException
-
refreshClusterMaxPriority
public org.apache.hadoop.yarn.server.api.protocolrecords.RefreshClusterMaxPriorityResponse refreshClusterMaxPriority(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshClusterMaxPriorityRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
refreshClusterMaxPriorityin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
mapAttributesToNodes
public org.apache.hadoop.yarn.server.api.protocolrecords.NodesToAttributesMappingResponse mapAttributesToNodes(org.apache.hadoop.yarn.server.api.protocolrecords.NodesToAttributesMappingRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
mapAttributesToNodesin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
deregisterSubCluster
public org.apache.hadoop.yarn.server.api.protocolrecords.DeregisterSubClusterResponse deregisterSubCluster(org.apache.hadoop.yarn.server.api.protocolrecords.DeregisterSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException In YARN Federation mode, We allow users to mark subClusters With no heartbeat for a long time as SC_LOST state. RM does not support deregisterSubCluster, deregisterSubCluster is supported by Router. If we include a specific subClusterId in the request, check for the specified subCluster. If subClusterId is empty, all subClusters are checked.- Specified by:
deregisterSubClusterin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Parameters:
request- deregisterSubCluster request. The request contains the id of to deregister sub-cluster.- Returns:
- Response from deregisterSubCluster.
- Throws:
org.apache.hadoop.yarn.exceptions.YarnException- exceptions from yarn servers.
-
saveFederationQueuePolicy
public org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyResponse saveFederationQueuePolicy(org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException In YARN-Federation mode, We will be storing the Policy information for Queues. RM does not support saveFederationQueuePolicy, saveFederationQueuePolicy is supported by Router.- Specified by:
saveFederationQueuePolicyin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Parameters:
request- saveFederationQueuePolicy Request- Returns:
- Response from saveFederationQueuePolicy.
- Throws:
org.apache.hadoop.yarn.exceptions.YarnException- exceptions from yarn servers.IOException- if an IO error occurred.
-
batchSaveFederationQueuePolicies
public org.apache.hadoop.yarn.server.api.protocolrecords.BatchSaveFederationQueuePoliciesResponse batchSaveFederationQueuePolicies(org.apache.hadoop.yarn.server.api.protocolrecords.BatchSaveFederationQueuePoliciesRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException In YARN-Federation mode, this method provides a way to save queue policies in batches. RM does not support batchSaveFederationQueuePolicies, batchSaveFederationQueuePolicies is supported by Router.- Specified by:
batchSaveFederationQueuePoliciesin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Parameters:
request- BatchSaveFederationQueuePolicies Request- Returns:
- Response from batchSaveFederationQueuePolicies.
- Throws:
org.apache.hadoop.yarn.exceptions.YarnException- exceptions from yarn servers.IOException- if an IO error occurred.
-
listFederationQueuePolicies
public org.apache.hadoop.yarn.server.api.protocolrecords.QueryFederationQueuePoliciesResponse listFederationQueuePolicies(org.apache.hadoop.yarn.server.api.protocolrecords.QueryFederationQueuePoliciesRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
listFederationQueuePoliciesin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
deleteFederationApplication
public org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationApplicationResponse deleteFederationApplication(org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationApplicationRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
deleteFederationApplicationin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
getFederationSubClusters
public org.apache.hadoop.yarn.server.api.protocolrecords.GetSubClustersResponse getFederationSubClusters(org.apache.hadoop.yarn.server.api.protocolrecords.GetSubClustersRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
getFederationSubClustersin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-
deleteFederationPoliciesByQueues
public org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationQueuePoliciesResponse deleteFederationPoliciesByQueues(org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationQueuePoliciesRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException - Specified by:
deleteFederationPoliciesByQueuesin interfaceorg.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol- Throws:
org.apache.hadoop.yarn.exceptions.YarnExceptionIOException
-