Package org.apache.flink.kubernetes.operator.observer.deployment

Class AbstractFlinkDeploymentObserver

java.lang.Object

org.apache.flink.kubernetes.operator.observer.AbstractFlinkResourceObserver<org.apache.flink.kubernetes.operator.api.FlinkDeployment,FlinkDeploymentObserverContext>

org.apache.flink.kubernetes.operator.observer.deployment.AbstractFlinkDeploymentObserver

All Implemented Interfaces:

Observer<org.apache.flink.kubernetes.operator.api.FlinkDeployment>

Direct Known Subclasses:

ApplicationObserver, SessionObserver

public abstract class AbstractFlinkDeploymentObserver
extends AbstractFlinkResourceObserver<org.apache.flink.kubernetes.operator.api.FlinkDeployment,FlinkDeploymentObserverContext>

Base observer for session and application clusters.

Field Summary

Fields

Modifier and Type	Field	Description
protected FlinkService	flinkService
protected org.slf4j.Logger	logger

Fields inherited from class org.apache.flink.kubernetes.operator.observer.AbstractFlinkResourceObserver

configManager, eventRecorder

Constructor Summary

Constructors

Constructor	Description
AbstractFlinkDeploymentObserver(FlinkService flinkService, FlinkConfigManager configManager, EventRecorder eventRecorder)

Method Summary

Modifier and Type	Method	Description
protected void	clearErrorsIfDeploymentIsHealthy(org.apache.flink.kubernetes.operator.api.FlinkDeployment dep)
protected FlinkDeploymentObserverContext	getObserverContext(org.apache.flink.kubernetes.operator.api.FlinkDeployment resource, io.javaoperatorsdk.operator.api.reconciler.Context<?> context)	Get the observer context for the current resource.
protected boolean	isJmDeploymentReady(org.apache.flink.kubernetes.operator.api.FlinkDeployment dep)
protected boolean	isSuspendedJob(org.apache.flink.kubernetes.operator.api.FlinkDeployment deployment)
protected abstract void	observeFlinkCluster(org.apache.flink.kubernetes.operator.api.FlinkDeployment flinkApp, io.javaoperatorsdk.operator.api.reconciler.Context<?> context, FlinkDeploymentObserverContext observerContext)	Observe the flinkApp status when the cluster is ready.
void	observeInternal(org.apache.flink.kubernetes.operator.api.FlinkDeployment flinkDep, io.javaoperatorsdk.operator.api.reconciler.Context<?> context, FlinkDeploymentObserverContext observerContext)	Internal observer logic specific to each resource type.
protected void	observeJmDeployment(org.apache.flink.kubernetes.operator.api.FlinkDeployment flinkApp, io.javaoperatorsdk.operator.api.reconciler.Context<?> context, org.apache.flink.configuration.Configuration effectiveConfig)
protected void	updateStatusToDeployedIfAlreadyUpgraded(org.apache.flink.kubernetes.operator.api.FlinkDeployment flinkDep, io.javaoperatorsdk.operator.api.reconciler.Context<?> context, FlinkDeploymentObserverContext observerContext)	Checks a resource that is currently in the UPGRADING state whether it was already deployed but we simply miss the status information.

Methods inherited from class org.apache.flink.kubernetes.operator.observer.AbstractFlinkResourceObserver

isResourceReadyToBeObserved, observe

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

flinkService

protected final FlinkService flinkService

Constructor Detail

AbstractFlinkDeploymentObserver

public AbstractFlinkDeploymentObserver(FlinkService flinkService,
                                       FlinkConfigManager configManager,
                                       EventRecorder eventRecorder)

Method Detail

getObserverContext

protected FlinkDeploymentObserverContext getObserverContext(org.apache.flink.kubernetes.operator.api.FlinkDeployment resource,
                                                            io.javaoperatorsdk.operator.api.reconciler.Context<?> context)

Description copied from class: AbstractFlinkResourceObserver

Get the observer context for the current resource.

Specified by:

getObserverContext in class AbstractFlinkResourceObserver<org.apache.flink.kubernetes.operator.api.FlinkDeployment,FlinkDeploymentObserverContext>

Parameters:

resource - Resource being observed

context - Resource context

Returns:

Observer context

observeInternal

public void observeInternal(org.apache.flink.kubernetes.operator.api.FlinkDeployment flinkDep,
                            io.javaoperatorsdk.operator.api.reconciler.Context<?> context,
                            FlinkDeploymentObserverContext observerContext)

Description copied from class: AbstractFlinkResourceObserver

Internal observer logic specific to each resource type.

Specified by:

observeInternal in class AbstractFlinkResourceObserver<org.apache.flink.kubernetes.operator.api.FlinkDeployment,FlinkDeploymentObserverContext>

Parameters:

flinkDep - Resource to be observed

context - Resource context

observerContext - Observer context

observeJmDeployment

protected void observeJmDeployment(org.apache.flink.kubernetes.operator.api.FlinkDeployment flinkApp,
                                   io.javaoperatorsdk.operator.api.reconciler.Context<?> context,
                                   org.apache.flink.configuration.Configuration effectiveConfig)

isJmDeploymentReady

protected boolean isJmDeploymentReady(org.apache.flink.kubernetes.operator.api.FlinkDeployment dep)

clearErrorsIfDeploymentIsHealthy

protected void clearErrorsIfDeploymentIsHealthy(org.apache.flink.kubernetes.operator.api.FlinkDeployment dep)

isSuspendedJob

protected boolean isSuspendedJob(org.apache.flink.kubernetes.operator.api.FlinkDeployment deployment)

updateStatusToDeployedIfAlreadyUpgraded

protected void updateStatusToDeployedIfAlreadyUpgraded(org.apache.flink.kubernetes.operator.api.FlinkDeployment flinkDep,
                                                       io.javaoperatorsdk.operator.api.reconciler.Context<?> context,
                                                       FlinkDeploymentObserverContext observerContext)

Description copied from class: AbstractFlinkResourceObserver

Checks a resource that is currently in the UPGRADING state whether it was already deployed but we simply miss the status information. After comparing the target resource generation with the one from the possible deployment if they match we update the status to the already DEPLOYED state.

Specified by:

updateStatusToDeployedIfAlreadyUpgraded in class AbstractFlinkResourceObserver<org.apache.flink.kubernetes.operator.api.FlinkDeployment,FlinkDeploymentObserverContext>

Parameters:

flinkDep - Flink resource.

context - Context for resource.

observerContext - Context for observer.

observeFlinkCluster

protected abstract void observeFlinkCluster(org.apache.flink.kubernetes.operator.api.FlinkDeployment flinkApp,
                                            io.javaoperatorsdk.operator.api.reconciler.Context<?> context,
                                            FlinkDeploymentObserverContext observerContext)

Observe the flinkApp status when the cluster is ready. It will be implemented by child class to reflect the changed status on the flinkApp resource.

Parameters:

flinkApp - the target flinkDeployment resource

context - the context with which the operation is executed

observerContext - Observer context