All Classes and Interfaces (Operator SDK - Framework

Class

Description

An abstract implementation of ConfigurationService meant to ease custom implementations

AbstractDependentResource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

An abstract implementation of DependentResource to be used as base for custom implementations, providing, in particular, the core AbstractDependentResource.reconcile(HasMetadata, Context) logic for dependents

AbstractEventSource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

AbstractEventSourceHolderDependentResource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata,T extends EventSource<R,P>>

AbstractExternalDependentResource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata,T extends EventSource<R,P>>

AbstractPollingDependentResource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

AggregatedOperatorException

AnnotationConfigurable<A extends Annotation>

BaseConfigurationService

BaseControl<T extends BaseControl<T>>

BooleanWithUndefined

A replacement for Boolean, which can't be used in annotations.

BoundedCache<K,R>

BoundedItemStore<R extends io.fabric8.kubernetes.api.model.HasMetadata>

BuilderUtils

BulkDependentResource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Manages dynamic number of resources created for a primary resource.

BulkUpdater<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Helper for the buld Dependent Resources to make it more explicit that such dependents only to implement BulkDependentResource.match(Object,Object,HasMetadata,Context)

Cache<T>

CacheKeyMapper<R>

CachingInboundEventSource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

CachingInboundEventSource.ResourceFetcher<R,P>

Cleaner

Cloner

Condition<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Condition.Type

Configurable<C>

ConfigurationConverter<A extends Annotation,C>

ConfigurationService

An interface from which to retrieve configuration information.

ConfigurationServiceOverrider

Configured

ConfiguredDependentResource<C>

Constants

Context

ContextInitializer

Controller

ControllerConfiguration

ControllerConfiguration

ControllerConfigurationOverrider<R extends io.fabric8.kubernetes.api.model.HasMetadata>

ControllerEventSource<T extends io.fabric8.kubernetes.api.model.HasMetadata>

ControllerHealthInfo

CRDPresentActivationCondition<R extends io.fabric8.kubernetes.api.model.HasMetadata,P extends io.fabric8.kubernetes.api.model.HasMetadata>

A generic CRD checking activation condition.

CRDPresentActivationCondition.CRDCheckState

CRDPresentActivationCondition.CRDPresentChecker

Creator<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

CRUDBulkDependentResource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

CRUDKubernetesDependentResource<R extends io.fabric8.kubernetes.api.model.HasMetadata,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Adaptor class resources that manage Create, Read and Update operations and that should be automatically garbage-collected by Kubernetes when the associated primary resource is destroyed.

CRUDNoGCKubernetesDependentResource<R extends io.fabric8.kubernetes.api.model.HasMetadata,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Adaptor class resources that manage Create, Read and Update operations, however resource is NOT garbage collected by Kubernetes when the associated primary resource is destroyed, instead explicitly deleted.

CustomResourceUtils

DefaultContext

DefaultManagedWorkflow

DefaultManagedWorkflowAndDependentResourceContext

DefaultResourceClassResolver

DefaultResult<T>

DeleteControl

Deleter

DependentResource can implement this interface to denote it requires explicit logic to clean up resources.

Dependent

The annotation used to create managed DependentResource associated with a given Reconciler

DependentResource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

An interface to implement and provide dependent resource support.

DependentResourceConfigurationProvider

DependentResourceConfigurationResolver

DependentResourceException

DependentResourceFactory<C extends ControllerConfiguration<?>,D extends DependentResourceSpec>

DependentResourceSpec<R,P extends io.fabric8.kubernetes.api.model.HasMetadata,C>

DependentResourceWithExplicitState<R,P extends io.fabric8.kubernetes.api.model.HasMetadata,S extends io.fabric8.kubernetes.api.model.HasMetadata>

Handles external resources where in order to address the resource additional information or persistent state (usually the ID of the resource) is needed to access the current state.

DetailedCondition<R,P extends io.fabric8.kubernetes.api.model.HasMetadata,T>

A condition that can return extra information in addition of whether it is met or not.

DetailedCondition.Result<T>

Holds a more detailed Condition result.

ErrorStatusUpdateControl

Event

EventHandler

EventProcessor

EventSource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Creates an event source to trigger your reconciler whenever something happens to a secondary or external resource that should cause a reconciliation of the primary resource.

EventSourceContext

Contextual information made available to event sources.

EventSourceHealthIndicator

EventSourceManager

EventSourceNotFoundException

EventSourceReferencer

EventSourceRetriever

EventSourceStartPriority

Defines priority levels for EventSource implementation to ensure that some sources are started before others

EventSourceUtils

ExecutorServiceManager

ExternalResourceCachingEventSource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Handles caching and related operation of external event sources.

GarbageCollected

Can be implemented by a dependent resource extending KubernetesDependentResource to express that the resource deletion is handled by the controller during DependentResource.reconcile(HasMetadata, Context).

GenericFilter<R>

GenericKubernetesDependentResource

GenericKubernetesResourceMatcher<R extends io.fabric8.kubernetes.api.model.HasMetadata,P extends io.fabric8.kubernetes.api.model.HasMetadata>

GenericResourceUpdater

GenericRetry

GenericRetryExecution

GradualRetry

GroupVersionKind

GroupVersionKindPlural

An extension of GroupVersionKind that also records the associated plural form which is useful when dealing with Kubernetes RBACs.

Ignore

An annotation for downstream tooling to ignore the annotated Reconciler.

IndexedResourceCache<T extends io.fabric8.kubernetes.api.model.HasMetadata>

IndexerResourceCache<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Informable<R extends io.fabric8.kubernetes.api.model.HasMetadata>

Informer

InformerConfiguration<R extends io.fabric8.kubernetes.api.model.HasMetadata>

InformerEventSource<R extends io.fabric8.kubernetes.api.model.HasMetadata,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Wraps informer(s) so it is connected to the eventing system of the framework.

InformerEventSourceConfiguration<R extends io.fabric8.kubernetes.api.model.HasMetadata>

InformerEventSourceConfiguration.Builder<R extends io.fabric8.kubernetes.api.model.HasMetadata>

InformerEventSourceConfiguration.DefaultInformerEventSourceConfiguration<R extends io.fabric8.kubernetes.api.model.HasMetadata>

InformerHealthIndicator

InformerStoppedHandler

InformerWrappingEventSourceHealthIndicator<R extends io.fabric8.kubernetes.api.model.HasMetadata>

InternalEventFilters

KubernetesDependent

KubernetesDependentConverter<R extends io.fabric8.kubernetes.api.model.HasMetadata,P extends io.fabric8.kubernetes.api.model.HasMetadata>

KubernetesDependentResource<R extends io.fabric8.kubernetes.api.model.HasMetadata,P extends io.fabric8.kubernetes.api.model.HasMetadata>

KubernetesDependentResourceConfig<R extends io.fabric8.kubernetes.api.model.HasMetadata>

KubernetesDependentResourceConfigBuilder<R extends io.fabric8.kubernetes.api.model.HasMetadata>

KubernetesResourceDeletedCondition

A condition implementation meant to be used as a delete post-condition on Kubernetes dependent resources to prevent the workflow from proceeding until the associated resource is actually deleted from the server (or, at least, doesn't have any finalizers anymore).

KubernetesResourceFetcher<R extends io.fabric8.kubernetes.api.model.HasMetadata>

KubernetesResourceUtils

LeaderElectionConfiguration

LeaderElectionConfigurationBuilder

LeaderElectionManager

LifecycleAware

LinearRateLimiter

A simple rate limiter that limits the number of permission for a time interval.

LoggingUtils

ManagedDependentResourceException

ManagedInformerEventSource<R extends io.fabric8.kubernetes.api.model.HasMetadata,P extends io.fabric8.kubernetes.api.model.HasMetadata,C extends Informable<R>>

ManagedWorkflow

ManagedWorkflowAndDependentResourceContext

Contextual information related to DependentResource either to retrieve the actual implementations to interact with them or to pass information between them and/or the reconciler

ManagedWorkflowFactory<C extends ControllerConfiguration<?>>

ManagedWorkflowSupport

Mappers

Mappers.SecondaryToPrimaryFromDefaultAnnotation

Matcher<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Implement this interface to provide custom matching logic when determining whether secondary resources match their desired state.

Matcher.Result<R>

Abstracts the matching result letting implementations also return the desired state if it has been computed as part of their logic.

MaxReconciliationInterval

MDCUtils

Metrics

An interface that metrics providers can implement and that the SDK will call at different times of its execution cycle.

Metrics.ControllerExecution<T>

Encapsulates the information about a controller execution i.e. a call to either Reconciler.reconcile(HasMetadata, Context) or Cleaner.cleanup(HasMetadata, Context).

MissingCRDException

NameSetter

NamespaceChangeable

NoEventSourceForClassException

PerResourcePollingConfiguration<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

PerResourcePollingConfigurationBuilder<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

PerResourcePollingDependentResource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

PerResourcePollingEventSource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Polls the supplier for each controlled resource registered.

PerResourcePollingEventSource.ResourceFetcher<R,P>

PollingConfiguration<R>

PollingConfigurationBuilder<R>

PollingDependentResource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

PollingEventSource<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Polls resource (on contrary to PerResourcePollingEventSource) not per resource bases but instead to calls supplier periodically and independently of the number or state of custom resources managed by the controller.

PollingEventSource.GenericResourceFetcher<R>

PrimaryToSecondaryIndex<R extends io.fabric8.kubernetes.api.model.HasMetadata>

PrimaryToSecondaryMapper

Identifies the set of secondary resources associated with a given primary resource.

RateLimited

RateLimiter<S extends RateLimiter.RateLimitState>

RateLimiter.RateLimitState

RecentOperationCacheFiller<R>

Reconciler

ReconcileResult<R>

ReconcileResult.Operation

ReconcilerUtils

RegisteredController

ResolvedControllerConfiguration

ResourceAction

ResourceCache<T extends io.fabric8.kubernetes.api.model.HasMetadata>

ResourceClassResolver

ResourceComparators

ResourceEvent

ResourceEventAware<T extends io.fabric8.kubernetes.api.model.HasMetadata>

ResourceFetcher<K,R>

ResourceID

ResourceUpdaterMatcher<R extends io.fabric8.kubernetes.api.model.HasMetadata>

RuntimeInfo in general is available when operator is fully started.

SecondaryToPrimaryMapper<R>

SimpleInboundEventSource

SSABasedGenericKubernetesResourceMatcher<R extends io.fabric8.kubernetes.api.model.HasMetadata>

Matches the actual state on the server vs the desired state.

Status

The health status of an EventSource

TemporaryResourceCache<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Temporal cache is used to solve the problem for KubernetesDependentResource that is, when a create or update is executed the subsequent getResource operation might not return the up-to-date resource from informer cache, since it is not received yet.

TimerEventSource<R extends io.fabric8.kubernetes.api.model.HasMetadata>

TransformingItemStore<R extends io.fabric8.kubernetes.api.model.HasMetadata>

UpdatableCache<T>

UpdateControl

Updater<R,P extends io.fabric8.kubernetes.api.model.HasMetadata>

Utils

Utils.Configurator<T>

Version

A class encapsulating the version information associated with this SDK instance.

Versions

Workflow

Workflow

WorkflowBuilder

WorkflowCleanupResult

WorkflowReconcileResult

WorkflowResult

WorkflowSpec