jobqueuecontroller

Documentation

Index

• type Context
  • func NewContext(context controllercontext.ContextInterface) *Context
• type Controller
  • func NewController(ctrlContext controllercontext.ContextInterface, ...) (*Controller, error)
  • func (c *Controller) GetHealth() controllermanager.HealthStatus
  • func (c *Controller) Run(ctx context.Context) error
  • func (c *Controller) Shutdown(ctx context.Context)
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) Name() string
  • func (f *Factory) New(ctrlContext controllercontext.ContextInterface, ...) (controllermanager.Controller, error)
• type IndependentReconciler
  • func NewIndependentReconciler(ctrlContext *Context, concurrency *configv1.Concurrency) *IndependentReconciler
  • func (r *IndependentReconciler) Concurrency() int
  • func (r *IndependentReconciler) MaxRequeues() int
  • func (r *IndependentReconciler) Name() string
  • func (r *IndependentReconciler) SyncOne(ctx context.Context, namespace, name string, _ int) error
• type InformerWorker
  • func NewInformerWorker(ctrlContext *Context) *InformerWorker
  • func (w *InformerWorker) WorkerName() string
• type JobControl
  • func NewJobControl(client executionv1alpha1.ExecutionV1alpha1Interface, ...) *JobControl
  • func (c *JobControl) RejectJob(ctx context.Context, rj *execution.Job, msg string) error
  • func (c *JobControl) StartJob(ctx context.Context, rj *execution.Job) error
• type JobControlInterface
• type PerConfigReconciler
  • func NewPerConfigReconciler(ctrlContext *Context, concurrency *configv1.Concurrency) *PerConfigReconciler
  • func (w *PerConfigReconciler) Concurrency() int
  • func (w *PerConfigReconciler) MaxRequeues() int
  • func (w *PerConfigReconciler) Name() string
  • func (w *PerConfigReconciler) SyncOne(ctx context.Context, namespace, name string, _ int) error

Types

type Context

type Context struct {
	controllercontext.ContextInterface
	// contains filtered or unexported fields
}

Context extends the common controllercontext.Context.

func NewContext

func NewContext(context controllercontext.ContextInterface) *Context

type Controller

type Controller struct {
	*Context
	// contains filtered or unexported fields
}

Controller is responsible for processing all Jobs to determine if they can be started, and if so, starts them in a deterministic order and safe from race conditions.

func NewController

func NewController(
	ctrlContext controllercontext.ContextInterface,
	concurrency *configv1.Concurrency,
) (*Controller, error)

func (*Controller) GetHealth

func (c *Controller) GetHealth() controllermanager.HealthStatus

func (*Controller) Run

func (c *Controller) Run(ctx context.Context) error

func (*Controller) Shutdown

func (c *Controller) Shutdown(ctx context.Context)

type Factory

type Factory struct{}

func NewFactory

func NewFactory() *Factory

func (*Factory) Name

func (f *Factory) Name() string

func (*Factory) New

func (f *Factory) New(
	ctrlContext controllercontext.ContextInterface,
	concurrencySpec *v1.ExecutionControllerConcurrencySpec,
) (controllermanager.Controller, error)

type IndependentReconciler

type IndependentReconciler struct {
	*Context
	// contains filtered or unexported fields
}

IndependentReconciler reconciles independent Jobs that do not have any JobConfig.

func NewIndependentReconciler

func NewIndependentReconciler(ctrlContext *Context, concurrency *configv1.Concurrency) *IndependentReconciler

func (*IndependentReconciler) Concurrency

func (r *IndependentReconciler) Concurrency() int

func (*IndependentReconciler) MaxRequeues

func (r *IndependentReconciler) MaxRequeues() int

func (*IndependentReconciler) Name

func (r *IndependentReconciler) Name() string

func (*IndependentReconciler) SyncOne

func (r *IndependentReconciler) SyncOne(ctx context.Context, namespace, name string, _ int) error

type InformerWorker

type InformerWorker struct {
	*Context
}

InformerWorker receives events from the informer and enqueues work to be done for the controller.

func NewInformerWorker

func NewInformerWorker(ctrlContext *Context) *InformerWorker

func (*InformerWorker) WorkerName

func (w *InformerWorker) WorkerName() string

type JobControl

type JobControl struct {
	// contains filtered or unexported fields
}

JobControl is the default implementation of JobControlInterface.

func NewJobControl

func NewJobControl(
	client executionv1alpha1.ExecutionV1alpha1Interface,
	recorder record.EventRecorder,
	name string,
) *JobControl

func (*JobControl) RejectJob

func (c *JobControl) RejectJob(ctx context.Context, rj *execution.Job, msg string) error

func (*JobControl) StartJob

func (c *JobControl) StartJob(ctx context.Context, rj *execution.Job) error

StartJob sets the startTime of the Job to the current time.

type JobControlInterface

type JobControlInterface interface {
	StartJob(ctx context.Context, rj *execution.Job) error
	RejectJob(ctx context.Context, rj *execution.Job, msg string) error
}

JobControlInterface is the client interface for the Controller.

type PerConfigReconciler

type PerConfigReconciler struct {
	*Context
	// contains filtered or unexported fields
}

PerConfigReconciler reconciles Jobs belonging to a JobConfig. It is guaranteed that no two routines will process Jobs belonging to the same JobConfig.

func NewPerConfigReconciler

func NewPerConfigReconciler(ctrlContext *Context, concurrency *configv1.Concurrency) *PerConfigReconciler

func (*PerConfigReconciler) Concurrency

func (w *PerConfigReconciler) Concurrency() int

func (*PerConfigReconciler) MaxRequeues

func (w *PerConfigReconciler) MaxRequeues() int

func (*PerConfigReconciler) Name

func (w *PerConfigReconciler) Name() string

func (*PerConfigReconciler) SyncOne

func (w *PerConfigReconciler) SyncOne(ctx context.Context, namespace, name string, _ int) error