controller

Documentation

Overview

Definitions for the Kubernetes Controllers

Definitions for the multicluster Kubernetes Controllers

Definitions for the Kubernetes Controllers

Index

• type JobDeletionReconciler
• type JobEventHandler
• type JobEventHandlerFuncs
  • func (f *JobEventHandlerFuncs) CreateJob(obj *batch_v1.Job) error
  • func (f *JobEventHandlerFuncs) DeleteJob(obj *batch_v1.Job) error
  • func (f *JobEventHandlerFuncs) GenericJob(obj *batch_v1.Job) error
  • func (f *JobEventHandlerFuncs) UpdateJob(objOld, objNew *batch_v1.Job) error
• type JobEventWatcher
  • func NewJobEventWatcher(name string, mgr manager.Manager) JobEventWatcher
• type JobFinalizer
• type JobReconcileLoop
  • func NewJobReconcileLoop(name string, mgr manager.Manager, options reconcile.Options) JobReconcileLoop
• type JobReconciler
• type JobReconcilerFuncs
  • func (f *JobReconcilerFuncs) ReconcileJob(obj *batch_v1.Job) (reconcile.Result, error)
  • func (f *JobReconcilerFuncs) ReconcileJobDeletion(req reconcile.Request) error
• type MulticlusterJobDeletionReconciler
• type MulticlusterJobReconcileLoop
  • func NewMulticlusterJobReconcileLoop(name string, cw multicluster.ClusterWatcher, options reconcile.Options) MulticlusterJobReconcileLoop
• type MulticlusterJobReconciler
• type MulticlusterJobReconcilerFuncs
  • func (f *MulticlusterJobReconcilerFuncs) ReconcileJob(clusterName string, obj *batch_v1.Job) (reconcile.Result, error)
  • func (f *MulticlusterJobReconcilerFuncs) ReconcileJobDeletion(clusterName string, req reconcile.Request) error

Types

type JobDeletionReconciler

type JobDeletionReconciler interface {
	ReconcileJobDeletion(req reconcile.Request) error
}

Reconcile deletion events for the Job Resource. Deletion receives a reconcile.Request as we cannot guarantee the last state of the object before being deleted. implemented by the user

type JobEventHandler

type JobEventHandler interface {
	CreateJob(obj *batch_v1.Job) error
	UpdateJob(old, new *batch_v1.Job) error
	DeleteJob(obj *batch_v1.Job) error
	GenericJob(obj *batch_v1.Job) error
}

Handle events for the Job Resource DEPRECATED: Prefer reconciler pattern.

type JobEventHandlerFuncs

type JobEventHandlerFuncs struct {
	OnCreate  func(obj *batch_v1.Job) error
	OnUpdate  func(old, new *batch_v1.Job) error
	OnDelete  func(obj *batch_v1.Job) error
	OnGeneric func(obj *batch_v1.Job) error
}

func (*JobEventHandlerFuncs) CreateJob

func (f *JobEventHandlerFuncs) CreateJob(obj *batch_v1.Job) error

func (*JobEventHandlerFuncs) DeleteJob

func (f *JobEventHandlerFuncs) DeleteJob(obj *batch_v1.Job) error

func (*JobEventHandlerFuncs) GenericJob

func (f *JobEventHandlerFuncs) GenericJob(obj *batch_v1.Job) error

func (*JobEventHandlerFuncs) UpdateJob

func (f *JobEventHandlerFuncs) UpdateJob(objOld, objNew *batch_v1.Job) error

type JobEventWatcher

type JobEventWatcher interface {
	AddEventHandler(ctx context.Context, h JobEventHandler, predicates ...predicate.Predicate) error
}

func NewJobEventWatcher

func NewJobEventWatcher(name string, mgr manager.Manager) JobEventWatcher

type JobFinalizer

type JobFinalizer interface {
	JobReconciler

	// name of the finalizer used by this handler.
	// finalizer names should be unique for a single task
	JobFinalizerName() string

	// finalize the object before it is deleted.
	// Watchers created with a finalizing handler will a
	FinalizeJob(obj *batch_v1.Job) error
}

Reconcile and finalize the Job Resource implemented by the user

type JobReconcileLoop

type JobReconcileLoop interface {
	RunJobReconciler(ctx context.Context, rec JobReconciler, predicates ...predicate.Predicate) error
}

func NewJobReconcileLoop

func NewJobReconcileLoop(name string, mgr manager.Manager, options reconcile.Options) JobReconcileLoop

type JobReconciler

type JobReconciler interface {
	ReconcileJob(obj *batch_v1.Job) (reconcile.Result, error)
}

Reconcile Upsert events for the Job Resource. implemented by the user

type JobReconcilerFuncs

type JobReconcilerFuncs struct {
	OnReconcileJob         func(obj *batch_v1.Job) (reconcile.Result, error)
	OnReconcileJobDeletion func(req reconcile.Request) error
}

func (*JobReconcilerFuncs) ReconcileJob

func (f *JobReconcilerFuncs) ReconcileJob(obj *batch_v1.Job) (reconcile.Result, error)

func (*JobReconcilerFuncs) ReconcileJobDeletion

func (f *JobReconcilerFuncs) ReconcileJobDeletion(req reconcile.Request) error

type MulticlusterJobDeletionReconciler

type MulticlusterJobDeletionReconciler interface {
	ReconcileJobDeletion(clusterName string, req reconcile.Request) error
}

Reconcile deletion events for the Job Resource across clusters. Deletion receives a reconcile.Request as we cannot guarantee the last state of the object before being deleted. implemented by the user

type MulticlusterJobReconcileLoop

type MulticlusterJobReconcileLoop interface {
	// AddMulticlusterJobReconciler adds a MulticlusterJobReconciler to the MulticlusterJobReconcileLoop.
	AddMulticlusterJobReconciler(ctx context.Context, rec MulticlusterJobReconciler, predicates ...predicate.Predicate)
}

func NewMulticlusterJobReconcileLoop

func NewMulticlusterJobReconcileLoop(name string, cw multicluster.ClusterWatcher, options reconcile.Options) MulticlusterJobReconcileLoop

type MulticlusterJobReconciler

type MulticlusterJobReconciler interface {
	ReconcileJob(clusterName string, obj *batch_v1.Job) (reconcile.Result, error)
}

Reconcile Upsert events for the Job Resource across clusters. implemented by the user

type MulticlusterJobReconcilerFuncs

type MulticlusterJobReconcilerFuncs struct {
	OnReconcileJob         func(clusterName string, obj *batch_v1.Job) (reconcile.Result, error)
	OnReconcileJobDeletion func(clusterName string, req reconcile.Request) error
}

func (*MulticlusterJobReconcilerFuncs) ReconcileJob

func (f *MulticlusterJobReconcilerFuncs) ReconcileJob(clusterName string, obj *batch_v1.Job) (reconcile.Result, error)

func (*MulticlusterJobReconcilerFuncs) ReconcileJobDeletion

func (f *MulticlusterJobReconcilerFuncs) ReconcileJobDeletion(clusterName string, req reconcile.Request) error