Package org.apache.flink.runtime.highavailability.zookeeper

Class ZooKeeperLeaderElectionHaServices

java.lang.Object

org.apache.flink.runtime.highavailability.AbstractHaServices

org.apache.flink.runtime.highavailability.zookeeper.ZooKeeperLeaderElectionHaServices

All Implemented Interfaces:

AutoCloseable, GloballyCleanableResource, ClientHighAvailabilityServices, HighAvailabilityServices

public class ZooKeeperLeaderElectionHaServices
extends AbstractHaServices

ZooKeeper HA services that only use a single leader election per process.

 /flink
      +/cluster_id_1/leader/latch
      |            |       /resource_manager/connection_info
      |            |       /dispatcher/connection_info
      |            |       /rest_server/connection_info
      |            |       /job-id-1/connection_info
      |            |       /job-id-2/connection_info
      |            |
      |            |
      |            +jobgraphs/job-id-1
      |            |         /job-id-2
      |            +jobs/job-id-1/checkpoints/latest
      |                 |                    /latest-1
      |                 |                    /latest-2
      |                 |       /checkpoint_id_counter
 

Field Summary

Fields inherited from class org.apache.flink.runtime.highavailability.AbstractHaServices

configuration, ioExecutor, logger

Fields inherited from interface org.apache.flink.runtime.highavailability.HighAvailabilityServices

DEFAULT_JOB_ID, DEFAULT_LEADER_ID

Constructor Summary

Constructors

Constructor	Description
ZooKeeperLeaderElectionHaServices(CuratorFrameworkWithUnhandledErrorListener curatorFrameworkWrapper, org.apache.flink.configuration.Configuration configuration, Executor executor, BlobStoreService blobStoreService)

Method Summary

Modifier and Type	Method	Description
CheckpointRecoveryFactory	createCheckpointRecoveryFactory()	Create the checkpoint recovery factory for the job manager.
ExecutionPlanStore	createExecutionPlanStore()	Create the submitted execution plan store for the job manager.
protected LeaderRetrievalService	createLeaderRetrievalService(String componentId)	Create leader retrieval service with specified leaderName.
protected void	deleteZNode(String path)
protected String	getLeaderPathForDispatcher()	Get the leader path for Dispatcher.
protected String	getLeaderPathForJobManager(org.apache.flink.api.common.JobID jobID)	Get the leader path for specific JobManager.
protected String	getLeaderPathForResourceManager()	Get the leader path for ResourceManager.
protected String	getLeaderPathForRestServer()	Get the leader path for RestServer.
protected void	internalCleanup()	Clean up the meta data in the distributed system(e.g.
protected void	internalCleanupJobData(org.apache.flink.api.common.JobID jobID)	Clean up the meta data in the distributed system(e.g.
protected void	internalClose()	Closes the components which is used for external operations(e.g.

Methods inherited from class org.apache.flink.runtime.highavailability.AbstractHaServices

cleanupAllData, close, createBlobStore, getCheckpointRecoveryFactory, getClusterRestEndpointLeaderElection, getClusterRestEndpointLeaderRetriever, getDispatcherLeaderElection, getDispatcherLeaderRetriever, getExecutionPlanStore, getJobManagerLeaderElection, getJobManagerLeaderRetriever, getJobManagerLeaderRetriever, getJobResultStore, getResourceManagerLeaderElection, getResourceManagerLeaderRetriever, globalCleanupAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.highavailability.HighAvailabilityServices

closeWithOptionalClean, getWebMonitorLeaderElection, getWebMonitorLeaderRetriever

Constructor Detail

ZooKeeperLeaderElectionHaServices

public ZooKeeperLeaderElectionHaServices(CuratorFrameworkWithUnhandledErrorListener curatorFrameworkWrapper,
                                         org.apache.flink.configuration.Configuration configuration,
                                         Executor executor,
                                         BlobStoreService blobStoreService)
                                  throws Exception

Throws:

Exception

Method Detail

createCheckpointRecoveryFactory

public CheckpointRecoveryFactory createCheckpointRecoveryFactory()
                                                          throws Exception

Description copied from class: AbstractHaServices

Create the checkpoint recovery factory for the job manager.

Specified by:

createCheckpointRecoveryFactory in class AbstractHaServices

Returns:

Checkpoint recovery factory

Throws:

Exception

createExecutionPlanStore

public ExecutionPlanStore createExecutionPlanStore()
                                            throws Exception

Description copied from class: AbstractHaServices

Create the submitted execution plan store for the job manager.

Specified by:

createExecutionPlanStore in class AbstractHaServices

Returns:

Submitted execution plan store

Throws:

Exception - if the submitted execution plan store could not be created

internalClose

protected void internalClose()

Description copied from class: AbstractHaServices

Closes the components which is used for external operations(e.g. Zookeeper Client, Kubernetes Client).

Specified by:

internalClose in class AbstractHaServices

internalCleanup

protected void internalCleanup()
                        throws Exception

Description copied from class: AbstractHaServices

Clean up the meta data in the distributed system(e.g. Zookeeper, Kubernetes ConfigMap).

If an exception occurs during internal cleanup, we will continue the cleanup in AbstractHaServices.cleanupAllData() and report exceptions only after all cleanup steps have been attempted.

Specified by:

internalCleanup in class AbstractHaServices

Throws:

Exception - when do the cleanup operation on external storage.

internalCleanupJobData

protected void internalCleanupJobData(org.apache.flink.api.common.JobID jobID)
                               throws Exception

Description copied from class: AbstractHaServices

Clean up the meta data in the distributed system(e.g. Zookeeper, Kubernetes ConfigMap) for the specified Job. Method implementations need to be thread-safe.

Specified by:

internalCleanupJobData in class AbstractHaServices

Parameters:

jobID - The identifier of the job to cleanup.

Throws:

Exception - when do the cleanup operation on external storage.

deleteZNode

protected void deleteZNode(String path)
                    throws Exception

Throws:

Exception

createLeaderRetrievalService

protected LeaderRetrievalService createLeaderRetrievalService(String componentId)

Description copied from class: AbstractHaServices

Create leader retrieval service with specified leaderName.

Specified by:

createLeaderRetrievalService in class AbstractHaServices

Parameters:

componentId - ConfigMap name in Kubernetes or child node path in Zookeeper.

Returns:

Return LeaderRetrievalService using Zookeeper or Kubernetes.

getLeaderPathForResourceManager

protected String getLeaderPathForResourceManager()

Description copied from class: AbstractHaServices

Get the leader path for ResourceManager.

Specified by:

getLeaderPathForResourceManager in class AbstractHaServices

Returns:

Return the ResourceManager leader name. It is ConfigMap name in Kubernetes or child node path in Zookeeper.

getLeaderPathForDispatcher

protected String getLeaderPathForDispatcher()

Description copied from class: AbstractHaServices

Get the leader path for Dispatcher.

Specified by:

getLeaderPathForDispatcher in class AbstractHaServices

Returns:

Return the Dispatcher leader name. It is ConfigMap name in Kubernetes or child node path in Zookeeper.

getLeaderPathForJobManager

protected String getLeaderPathForJobManager(org.apache.flink.api.common.JobID jobID)

Description copied from class: AbstractHaServices

Get the leader path for specific JobManager.

Specified by:

getLeaderPathForJobManager in class AbstractHaServices

Parameters:

jobID - job id

Returns:

Return the JobManager leader name for specified job id. It is ConfigMap name in Kubernetes or child node path in Zookeeper.

getLeaderPathForRestServer

protected String getLeaderPathForRestServer()

Description copied from class: AbstractHaServices

Get the leader path for RestServer.

Specified by:

getLeaderPathForRestServer in class AbstractHaServices

Returns:

Return the RestServer leader name. It is ConfigMap name in Kubernetes or child node path in Zookeeper.