@InterfaceAudience.Private
@InterfaceStability.Unstable
public interface FederationMembershipStateStore
SubClusterInfo
for all the
subcluster(s) that are participating in federation.Modifier and Type | Method and Description |
---|---|
SubClusterDeregisterResponse |
deregisterSubCluster(SubClusterDeregisterRequest subClusterDeregisterRequest)
Deregister a subcluster identified by
SubClusterId to
change state in federation. |
GetSubClusterInfoResponse |
getSubCluster(GetSubClusterInfoRequest subClusterRequest)
Get the membership information of subcluster as identified by
SubClusterId . |
GetSubClustersInfoResponse |
getSubClusters(GetSubClustersInfoRequest subClustersRequest)
Get the membership information of all the subclusters that are
currently participating in federation.
|
SubClusterRegisterResponse |
registerSubCluster(SubClusterRegisterRequest registerSubClusterRequest)
Register a subcluster by publishing capabilities as represented by
SubClusterInfo to indicate participation in federation. |
SubClusterHeartbeatResponse |
subClusterHeartbeat(SubClusterHeartbeatRequest subClusterHeartbeatRequest)
Periodic heartbeat from a
ResourceManager participating in
federation to indicate liveliness. |
SubClusterRegisterResponse registerSubCluster(SubClusterRegisterRequest registerSubClusterRequest) throws org.apache.hadoop.yarn.exceptions.YarnException
SubClusterInfo
to indicate participation in federation. This is
typically done during initialization or restart/failover of the
subcluster's ResourceManager
. Upon successful registration, an
identifier for the subcluster which is unique across the federated
cluster is returned. The identifier is static, i.e. preserved across
restarts and failover.registerSubClusterRequest
- the capabilities of the subcluster that
wants to participate in federation. The subcluster id is also
specified in case registration is triggered by restart/failoverorg.apache.hadoop.yarn.exceptions.YarnException
- if the request is invalid/failsSubClusterDeregisterResponse deregisterSubCluster(SubClusterDeregisterRequest subClusterDeregisterRequest) throws org.apache.hadoop.yarn.exceptions.YarnException
SubClusterId
to
change state in federation. This can be done to mark the sub cluster lost,
deregistered, or decommissioned.subClusterDeregisterRequest
- - the request to deregister the
sub-cluster from federation.org.apache.hadoop.yarn.exceptions.YarnException
- if the request is invalid/failsSubClusterHeartbeatResponse subClusterHeartbeat(SubClusterHeartbeatRequest subClusterHeartbeatRequest) throws org.apache.hadoop.yarn.exceptions.YarnException
ResourceManager
participating in
federation to indicate liveliness. The heartbeat publishes the current
capabilities as represented by SubClusterInfo
of the subcluster.
Currently response is empty if the operation was successful, if not an
exception reporting reason for a failure.subClusterHeartbeatRequest
- the capabilities of the subcluster that
wants to keep alive its participation in federationorg.apache.hadoop.yarn.exceptions.YarnException
- if the request is invalid/failsGetSubClusterInfoResponse getSubCluster(GetSubClusterInfoRequest subClusterRequest) throws org.apache.hadoop.yarn.exceptions.YarnException
SubClusterId
. The membership information includes the cluster
endpoint and current capabilities as represented by SubClusterInfo
.subClusterRequest
- the subcluster whose information is requiredSubClusterInfo
, or null
if there is no mapping
for the subclusterorg.apache.hadoop.yarn.exceptions.YarnException
- if the request is invalid/failsGetSubClustersInfoResponse getSubClusters(GetSubClustersInfoRequest subClustersRequest) throws org.apache.hadoop.yarn.exceptions.YarnException
SubClusterInfo
.subClustersRequest
- request for sub-clusters informationSubClusterInfo
keyed by the SubClusterId
org.apache.hadoop.yarn.exceptions.YarnException
- if the request is invalid/failsCopyright © 2008–2020 Apache Software Foundation. All rights reserved.