org.apache.hadoop.yarn.server.resourcemanager.recovery

Class ZKRMStateStore

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.resourcemanager.recovery.RMStateStore

org.apache.hadoop.yarn.server.resourcemanager.recovery.ZKRMStateStore

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.service.Service

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class ZKRMStateStore
extends RMStateStore

RMStateStore implementation backed by ZooKeeper. The znode structure is as follows: ROOT_DIR_PATH |--- VERSION_INFO |--- EPOCH_NODE |--- RM_ZK_FENCING_LOCK |--- RM_APP_ROOT | |----- (#ApplicationId1) | | |----- (#ApplicationAttemptIds) | | | |----- (#ApplicationId2) | | |----- (#ApplicationAttemptIds) | .... | |--- RM_DT_SECRET_MANAGER_ROOT |----- RM_DT_SEQUENTIAL_NUMBER_ZNODE_NAME |----- RM_DELEGATION_TOKENS_ROOT_ZNODE_NAME | |----- Token_1 | |----- Token_2 | .... | |----- RM_DT_MASTER_KEYS_ROOT_ZNODE_NAME | |----- Key_1 | |----- Key_2 .... |--- AMRMTOKEN_SECRET_MANAGER_ROOT |----- currentMasterKey |----- nextMasterKey |-- RESERVATION_SYSTEM_ROOT |------PLAN_1 | |------ RESERVATION_1 | |------ RESERVATION_2 | .... |------PLAN_2 .... Note: Changes from 1.1 to 1.2 - AMRMTokenSecretManager state has been saved separately. The currentMasterkey and nextMasterkey have been stored. Also, AMRMToken has been removed from ApplicationAttemptState. Changes from 1.2 to 1.3, Addition of ReservationSystem state.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.server.resourcemanager.recovery.RMStateStore

RMStateStore.RMDTSecretManagerState, RMStateStore.RMState, RMStateStore.RMStateStoreState

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE_DELETE_PERMS
protected org.apache.curator.framework.CuratorFramework	curatorFramework
protected static org.apache.hadoop.yarn.server.records.Version	CURRENT_VERSION_INFO
static org.apache.commons.logging.Log	LOG
protected static String	ROOT_ZNODE_NAME
protected String	znodeWorkingPath

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.recovery.RMStateStore

AM_CLIENT_TOKEN_MASTER_KEY_NAME, AM_RM_TOKEN_SERVICE, AMRMTOKEN_SECRET_MANAGER_ROOT, DELEGATION_KEY_PREFIX, DELEGATION_TOKEN_PREFIX, DELEGATION_TOKEN_SEQUENCE_NUMBER_PREFIX, EPOCH_NODE, RESERVATION_SYSTEM_ROOT, resourceManager, RM_APP_ROOT, RM_DT_SECRET_MANAGER_ROOT, VERSION_NODE

Constructor Summary

Constructors

Constructor and Description
ZKRMStateStore()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeInternal() Derived classes close themselves using this method.
protected List<org.apache.zookeeper.data.ACL>	constructZkRootNodeACL(org.apache.hadoop.conf.Configuration conf, List<org.apache.zookeeper.data.ACL> sourceACLs) Given the Configuration and ACLs used (zkAcl) for ZooKeeper access, construct the ACLs for the store's root node.
void	deleteStore() Derived classes must implement this method to delete the state store
long	getAndIncrementEpoch() Get the current epoch of RM and increment the value.
protected org.apache.hadoop.yarn.server.records.Version	getCurrentVersion() Get the current version of the underlying state store.
void	initInternal(org.apache.hadoop.conf.Configuration conf) Derived classes initialize themselves using this method.
RMStateStore.RMState	loadState() Blocking API The derived class must recover state from the store and return a new RMState object populated with that state This must not be called on the dispatcher thread
protected org.apache.hadoop.yarn.server.records.Version	loadVersion() Derived class use this method to load the version information from state store.
void	removeApplication(org.apache.hadoop.yarn.api.records.ApplicationId removeAppId) Derived classes must implement this method to remove application from the state store
void	removeApplicationStateInternal(ApplicationStateData appState) Blocking API Derived classes must implement this method to remove the state of an application and its attempts
protected void	removeReservationState(String planName, String reservationIdName) Blocking API Derived classes must implement this method to remove the state of a reservation allocation.
protected void	removeRMDelegationTokenState(org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier rmDTIdentifier) Blocking API Derived classes must implement this method to remove the state of RMDelegationToken
protected void	removeRMDTMasterKeyState(org.apache.hadoop.security.token.delegation.DelegationKey delegationKey) Blocking API Derived classes must implement this method to remove the state of DelegationToken Master Key
void	startInternal() Derived classes start themselves using this method.
void	storeApplicationAttemptStateInternal(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, ApplicationAttemptStateData attemptStateDataPB) Blocking API Derived classes must implement this method to store the state of an application attempt
void	storeApplicationStateInternal(org.apache.hadoop.yarn.api.records.ApplicationId appId, ApplicationStateData appStateDataPB) Blocking API Derived classes must implement this method to store the state of an application.
void	storeOrUpdateAMRMTokenSecretManagerState(AMRMTokenSecretManagerState amrmTokenSecretManagerState, boolean isUpdate) Blocking API Derived classes must implement this method to store or update the state of AMRMToken Master Key
protected void	storeReservationState(org.apache.hadoop.yarn.proto.YarnProtos.ReservationAllocationStateProto reservationAllocation, String planName, String reservationIdName) Blocking API Derived classes must implement this method to store the state of a reservation allocation.
protected void	storeRMDelegationTokenState(org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier rmDTIdentifier, Long renewDate) Blocking API Derived classes must implement this method to store the state of RMDelegationToken and sequence number
protected void	storeRMDTMasterKeyState(org.apache.hadoop.security.token.delegation.DelegationKey delegationKey) Blocking API Derived classes must implement this method to store the state of DelegationToken Master Key
protected void	storeVersion() Derived class use this method to store the version information.
void	updateApplicationAttemptStateInternal(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, ApplicationAttemptStateData attemptStateDataPB)
void	updateApplicationStateInternal(org.apache.hadoop.yarn.api.records.ApplicationId appId, ApplicationStateData appStateDataPB)
protected void	updateRMDelegationTokenState(org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier rmDTIdentifier, Long renewDate) Blocking API Derived classes must implement this method to update the state of RMDelegationToken and sequence number

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.recovery.RMStateStore

checkVersion, getCredentialsFromAppAttempt, getRMStateStoreState, handleStoreEvent, isFencedState, notifyStoreOperationFailed, removeApplication, removeReservation, removeRMDelegationToken, removeRMDTMasterKey, serviceInit, serviceStart, serviceStop, setResourceManager, setRMDispatcher, storeNewApplication, storeNewApplicationAttempt, storeNewReservation, storeOrUpdateAMRMTokenSecretManager, storeRMDelegationToken, storeRMDTMasterKey, updateApplicationAttemptState, updateApplicationState, updateApplicationStateSynchronously, updateFencedState, updateRMDelegationToken

Methods 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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

ROOT_ZNODE_NAME

protected static final String ROOT_ZNODE_NAME

See Also:

Constant Field Values

CURRENT_VERSION_INFO

protected static final org.apache.hadoop.yarn.server.records.Version CURRENT_VERSION_INFO

znodeWorkingPath

protected String znodeWorkingPath

CREATE_DELETE_PERMS

public static final int CREATE_DELETE_PERMS

See Also:

Constant Field Values

curatorFramework

protected org.apache.curator.framework.CuratorFramework curatorFramework

Constructor Detail

ZKRMStateStore

public ZKRMStateStore()

Method Detail

constructZkRootNodeACL

@InterfaceAudience.Private
@InterfaceStability.Unstable
protected List<org.apache.zookeeper.data.ACL> constructZkRootNodeACL(org.apache.hadoop.conf.Configuration conf,
                                                                                                               List<org.apache.zookeeper.data.ACL> sourceACLs)
                                                              throws NoSuchAlgorithmException

Given the Configuration and ACLs used (zkAcl) for ZooKeeper access, construct the ACLs for the store's root node. In the constructed ACL, all the users allowed by zkAcl are given rwa access, while the current RM has exclude create-delete access. To be called only when HA is enabled and the configuration doesn't set ACL for the root node.

Throws:

NoSuchAlgorithmException

initInternal

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

Description copied from class: RMStateStore

Derived classes initialize themselves using this method.

Specified by:

initInternal in class RMStateStore

Throws:

Exception

startInternal

public void startInternal()
                   throws Exception

Description copied from class: RMStateStore

Derived classes start themselves using this method. The base class is started and the event dispatcher is ready to use at this point

Specified by:

startInternal in class RMStateStore

Throws:

Exception

closeInternal

protected void closeInternal()
                      throws Exception

Description copied from class: RMStateStore

Derived classes close themselves using this method. The base class will be closed and the event dispatcher will be shutdown after this

Specified by:

closeInternal in class RMStateStore

Throws:

Exception

getCurrentVersion

protected org.apache.hadoop.yarn.server.records.Version getCurrentVersion()

Description copied from class: RMStateStore

Get the current version of the underlying state store.

Specified by:

getCurrentVersion in class RMStateStore

storeVersion

protected void storeVersion()
                     throws Exception

Description copied from class: RMStateStore

Derived class use this method to store the version information.

Specified by:

storeVersion in class RMStateStore

Throws:

Exception

loadVersion

protected org.apache.hadoop.yarn.server.records.Version loadVersion()
                                                             throws Exception

Description copied from class: RMStateStore

Derived class use this method to load the version information from state store.

Specified by:

loadVersion in class RMStateStore

Throws:

Exception

getAndIncrementEpoch

public long getAndIncrementEpoch()
                          throws Exception

Description copied from class: RMStateStore

Get the current epoch of RM and increment the value.

Specified by:

getAndIncrementEpoch in class RMStateStore

Throws:

Exception

loadState

public RMStateStore.RMState loadState()
                               throws Exception

Description copied from class: RMStateStore

Blocking API The derived class must recover state from the store and return a new RMState object populated with that state This must not be called on the dispatcher thread

Specified by:

loadState in class RMStateStore

Throws:

Exception

storeApplicationStateInternal

public void storeApplicationStateInternal(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                                 ApplicationStateData appStateDataPB)
                                   throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store the state of an application.

Specified by:

storeApplicationStateInternal in class RMStateStore

Throws:

Exception

updateApplicationStateInternal

public void updateApplicationStateInternal(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                                  ApplicationStateData appStateDataPB)
                                    throws Exception

Specified by:

updateApplicationStateInternal in class RMStateStore

Throws:

Exception

storeApplicationAttemptStateInternal

public void storeApplicationAttemptStateInternal(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId,
                                        ApplicationAttemptStateData attemptStateDataPB)
                                          throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store the state of an application attempt

Specified by:

storeApplicationAttemptStateInternal in class RMStateStore

Throws:

Exception

updateApplicationAttemptStateInternal

public void updateApplicationAttemptStateInternal(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId,
                                         ApplicationAttemptStateData attemptStateDataPB)
                                           throws Exception

Specified by:

updateApplicationAttemptStateInternal in class RMStateStore

Throws:

Exception

removeApplicationStateInternal

public void removeApplicationStateInternal(ApplicationStateData appState)
                                    throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to remove the state of an application and its attempts

Specified by:

removeApplicationStateInternal in class RMStateStore

Throws:

Exception

storeRMDelegationTokenState

protected void storeRMDelegationTokenState(org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier rmDTIdentifier,
                               Long renewDate)
                                    throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store the state of RMDelegationToken and sequence number

Specified by:

storeRMDelegationTokenState in class RMStateStore

Throws:

Exception

removeRMDelegationTokenState

protected void removeRMDelegationTokenState(org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier rmDTIdentifier)
                                     throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to remove the state of RMDelegationToken

Specified by:

removeRMDelegationTokenState in class RMStateStore

Throws:

Exception

updateRMDelegationTokenState

protected void updateRMDelegationTokenState(org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier rmDTIdentifier,
                                Long renewDate)
                                     throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to update the state of RMDelegationToken and sequence number

Specified by:

updateRMDelegationTokenState in class RMStateStore

Throws:

Exception

storeRMDTMasterKeyState

protected void storeRMDTMasterKeyState(org.apache.hadoop.security.token.delegation.DelegationKey delegationKey)
                                throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store the state of DelegationToken Master Key

Specified by:

storeRMDTMasterKeyState in class RMStateStore

Throws:

Exception

removeRMDTMasterKeyState

protected void removeRMDTMasterKeyState(org.apache.hadoop.security.token.delegation.DelegationKey delegationKey)
                                 throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to remove the state of DelegationToken Master Key

Specified by:

removeRMDTMasterKeyState in class RMStateStore

Throws:

Exception

deleteStore

public void deleteStore()
                 throws Exception

Description copied from class: RMStateStore

Derived classes must implement this method to delete the state store

Specified by:

deleteStore in class RMStateStore

Throws:

Exception

removeApplication

public void removeApplication(org.apache.hadoop.yarn.api.records.ApplicationId removeAppId)
                       throws Exception

Description copied from class: RMStateStore

Derived classes must implement this method to remove application from the state store

Specified by:

removeApplication in class RMStateStore

Throws:

Exception

storeOrUpdateAMRMTokenSecretManagerState

public void storeOrUpdateAMRMTokenSecretManagerState(AMRMTokenSecretManagerState amrmTokenSecretManagerState,
                                            boolean isUpdate)
                                              throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store or update the state of AMRMToken Master Key

Specified by:

storeOrUpdateAMRMTokenSecretManagerState in class RMStateStore

Throws:

Exception

removeReservationState

protected void removeReservationState(String planName,
                          String reservationIdName)
                               throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to remove the state of a reservation allocation.

Specified by:

removeReservationState in class RMStateStore

Throws:

Exception

storeReservationState

protected void storeReservationState(org.apache.hadoop.yarn.proto.YarnProtos.ReservationAllocationStateProto reservationAllocation,
                         String planName,
                         String reservationIdName)
                              throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store the state of a reservation allocation.

Specified by:

storeReservationState in class RMStateStore

Throws:

Exception