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

Class AbstractFlinkResourceReconciler<CR extends org.apache.flink.kubernetes.operator.api.AbstractFlinkResource<SPEC,​STATUS>,​SPEC extends org.apache.flink.kubernetes.operator.api.spec.AbstractFlinkSpec,​STATUS extends org.apache.flink.kubernetes.operator.api.status.CommonStatus<SPEC>>

  • All Implemented Interfaces:
    Reconciler<CR>
    Direct Known Subclasses:
    AbstractJobReconciler, SessionReconciler
    public abstract class AbstractFlinkResourceReconciler<CR extends org.apache.flink.kubernetes.operator.api.AbstractFlinkResource<SPEC,​STATUS>,​SPEC extends org.apache.flink.kubernetes.operator.api.spec.AbstractFlinkSpec,​STATUS extends org.apache.flink.kubernetes.operator.api.status.CommonStatus<SPEC>>
extends java.lang.Object
implements Reconciler<CR>
    Base class for all Flink resource reconcilers. It contains the general flow of reconciling Flink related resources including initial deployments, upgrades, rollbacks etc.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      io.javaoperatorsdk.operator.api.reconciler.DeleteControl cleanup​(CR resource, io.javaoperatorsdk.operator.api.reconciler.Context<?> context)
      This is called when receiving the delete event of custom resource.
      protected abstract io.javaoperatorsdk.operator.api.reconciler.DeleteControl cleanupInternal​(CR resource, io.javaoperatorsdk.operator.api.reconciler.Context<?> context)
      Shut down and clean up all Flink job/cluster resources.
      protected abstract void deploy​(CR relatedResource, SPEC spec, STATUS status, io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx, org.apache.flink.configuration.Configuration deployConfig, java.util.Optional<java.lang.String> savepoint, boolean requireHaMetadata)
      Deploys the target resource spec to Kubernetes.
      protected boolean flinkVersionChanged​(SPEC oldSpec, SPEC newSpec)  
      protected abstract org.apache.flink.configuration.Configuration getDeployConfig​(io.fabric8.kubernetes.api.model.ObjectMeta meta, SPEC spec, io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx)
      Get Flink configuration object for deploying the given spec using deploy(CR, SPEC, STATUS, io.javaoperatorsdk.operator.api.reconciler.Context<?>, org.apache.flink.configuration.Configuration, java.util.Optional<java.lang.String>, boolean).
      protected abstract FlinkService getFlinkService​(CR resource, io.javaoperatorsdk.operator.api.reconciler.Context<?> context)
      Get the Flink service related to the resource and context.
      protected abstract org.apache.flink.configuration.Configuration getObserveConfig​(CR resource, io.javaoperatorsdk.operator.api.reconciler.Context<?> context)
      Get Flink configuration for client interactions with the running Flink deployment/session job.
      protected abstract boolean readyToReconcile​(CR cr, io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx, org.apache.flink.configuration.Configuration deployConfig)
      Check whether the given Flink resource is ready to be reconciled or we are still waiting for any pending operation or condition first.
      void reconcile​(CR cr, io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx)
      This is called when receiving the create or update event of the custom resource.
      protected abstract boolean reconcileOtherChanges​(CR cr, io.javaoperatorsdk.operator.api.reconciler.Context<?> context, org.apache.flink.configuration.Configuration observeConfig)
      Reconcile any other changes required for this resource that are specific to the reconciler implementation.
      protected abstract void reconcileSpecChange​(CR cr, io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx, org.apache.flink.configuration.Configuration observeConfig, org.apache.flink.configuration.Configuration deployConfig, org.apache.flink.kubernetes.operator.api.diff.DiffType diffType)
      Reconcile spec upgrade on the currently deployed/suspended Flink resource and update the status accordingly.
      protected abstract void rollback​(CR cr, io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx, org.apache.flink.configuration.Configuration observeConfig)
      Rollback deployed resource to the last stable spec.
      protected void setClock​(java.time.Clock clock)  
      protected void setOwnerReference​(CR owner, org.apache.flink.configuration.Configuration deployConfig)  
      protected boolean shouldRecoverDeployment​(org.apache.flink.configuration.Configuration conf, org.apache.flink.kubernetes.operator.api.FlinkDeployment deployment)
      Checks whether the JobManager Kubernetes Deployment recovery logic should be initiated.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • statusRecorder

        protected final StatusRecorder<CR extends org.apache.flink.kubernetes.operator.api.AbstractFlinkResource<SPEC,​STATUS>,​STATUS extends org.apache.flink.kubernetes.operator.api.status.CommonStatus<SPEC>> statusRecorder

      • kubernetesClient

        protected final io.fabric8.kubernetes.client.KubernetesClient kubernetesClient

      • MSG_SPEC_CHANGED

        public static final java.lang.String MSG_SPEC_CHANGED
        See Also:
        Constant Field Values

      • clock

        protected java.time.Clock clock

    • Method Detail

      • reconcile

        public final void reconcile​(CR cr,
                            io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx)
                     throws java.lang.Exception
        Description copied from interface: Reconciler
        This is called when receiving the create or update event of the custom resource.
        Specified by:
        reconcile in interface Reconciler<CR extends org.apache.flink.kubernetes.operator.api.AbstractFlinkResource<SPEC,​STATUS>>
        Parameters:
        cr - the custom resource that has been created or updated
        ctx - the context with which the operation is executed
        Throws:
        java.lang.Exception - Error during reconciliation.

      • getObserveConfig

        protected abstract org.apache.flink.configuration.Configuration getObserveConfig​(CR resource,
                                                                                 io.javaoperatorsdk.operator.api.reconciler.Context<?> context)
        Get Flink configuration for client interactions with the running Flink deployment/session job.
        Parameters:
        resource - Related Flink resource.
        context - Reconciliation context.
        Returns:
        Observe configuration.

      • readyToReconcile

        protected abstract boolean readyToReconcile​(CR cr,
                                            io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx,
                                            org.apache.flink.configuration.Configuration deployConfig)
        Check whether the given Flink resource is ready to be reconciled or we are still waiting for any pending operation or condition first.
        Parameters:
        cr - Related Flink resource.
        ctx - Reconciliation context.
        deployConfig - Deployment configuration.
        Returns:
        True if the resource is ready to be reconciled.

      • reconcileSpecChange

        protected abstract void reconcileSpecChange​(CR cr,
                                            io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx,
                                            org.apache.flink.configuration.Configuration observeConfig,
                                            org.apache.flink.configuration.Configuration deployConfig,
                                            org.apache.flink.kubernetes.operator.api.diff.DiffType diffType)
                                     throws java.lang.Exception
        Reconcile spec upgrade on the currently deployed/suspended Flink resource and update the status accordingly.
        Parameters:
        cr - Related Flink resource.
        observeConfig - Observe configuration.
        deployConfig - Deployment configuration.
        Throws:
        java.lang.Exception - Error during spec upgrade.

      • rollback

        protected abstract void rollback​(CR cr,
                                 io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx,
                                 org.apache.flink.configuration.Configuration observeConfig)
                          throws java.lang.Exception
        Rollback deployed resource to the last stable spec.
        Parameters:
        cr - Related Flink resource.
        ctx - Reconciliation context.
        observeConfig - Observe configuration.
        Throws:
        java.lang.Exception - Error during rollback.

      • reconcileOtherChanges

        protected abstract boolean reconcileOtherChanges​(CR cr,
                                                 io.javaoperatorsdk.operator.api.reconciler.Context<?> context,
                                                 org.apache.flink.configuration.Configuration observeConfig)
                                          throws java.lang.Exception
        Reconcile any other changes required for this resource that are specific to the reconciler implementation.
        Parameters:
        cr - Related Flink resource.
        observeConfig - Observe configuration.
        Returns:
        True if any further reconciliation action was taken.
        Throws:
        java.lang.Exception - Error during reconciliation.

      • cleanup

        public final io.javaoperatorsdk.operator.api.reconciler.DeleteControl cleanup​(CR resource,
                                                                              io.javaoperatorsdk.operator.api.reconciler.Context<?> context)
        Description copied from interface: Reconciler
        This is called when receiving the delete event of custom resource. This method is meant to cleanup the associated components like the Flink job components.
        Specified by:
        cleanup in interface Reconciler<CR extends org.apache.flink.kubernetes.operator.api.AbstractFlinkResource<SPEC,​STATUS>>
        Parameters:
        resource - the custom resource that has been deleted
        context - the context with which the operation is executed
        Returns:
        DeleteControl to manage the deletion behavior

      • deploy

        protected abstract void deploy​(CR relatedResource,
                               SPEC spec,
                               STATUS status,
                               io.javaoperatorsdk.operator.api.reconciler.Context<?> ctx,
                               org.apache.flink.configuration.Configuration deployConfig,
                               java.util.Optional<java.lang.String> savepoint,
                               boolean requireHaMetadata)
                        throws java.lang.Exception
        Deploys the target resource spec to Kubernetes.
        Parameters:
        relatedResource - Related resource.
        spec - Spec that should be deployed to Kubernetes.
        status - Status object of the resource
        deployConfig - Flink conf for the deployment.
        ctx - Reconciliation context.
        savepoint - Optional savepoint path for applications and session jobs.
        requireHaMetadata - Flag used by application deployments to validate HA metadata
        Throws:
        java.lang.Exception - Error during deployment.

      • cleanupInternal

        protected abstract io.javaoperatorsdk.operator.api.reconciler.DeleteControl cleanupInternal​(CR resource,
                                                                                            io.javaoperatorsdk.operator.api.reconciler.Context<?> context)
        Shut down and clean up all Flink job/cluster resources.
        Parameters:
        resource - Resource being reconciled.
        context - Current context.
        Returns:
        DeleteControl object.

      • getFlinkService

        protected abstract FlinkService getFlinkService​(CR resource,
                                                io.javaoperatorsdk.operator.api.reconciler.Context<?> context)
        Get the Flink service related to the resource and context.
        Parameters:
        resource - Resource being reconciled.
        context - Current context.
        Returns:
        Flink service implementation.

      • shouldRecoverDeployment

        protected boolean shouldRecoverDeployment​(org.apache.flink.configuration.Configuration conf,
                                          org.apache.flink.kubernetes.operator.api.FlinkDeployment deployment)
        Checks whether the JobManager Kubernetes Deployment recovery logic should be initiated. This is triggered only if, jm deployment missing, recovery config and HA enabled. This logic is only used by the Session and Application reconcilers.
        Parameters:
        conf - Flink cluster configuration.
        deployment - FlinkDeployment object.
        Returns:
        True if recovery should be executed.

      • flinkVersionChanged

        protected boolean flinkVersionChanged​(SPEC oldSpec,
                                      SPEC newSpec)

      • setOwnerReference

        protected void setOwnerReference​(CR owner,
                                 org.apache.flink.configuration.Configuration deployConfig)

      • setClock

        @VisibleForTesting
protected void setClock​(java.time.Clock clock)