qruntime

Documentation

Overview

Package qruntime implements queue-based runtime for controllers.

Index

• Constants
• type Adapter
  • func NewAdapter(ctrl controller.QController, adapterOptions adapter.Options) (*Adapter, error)
  • func (adapter *Adapter) Run(ctx context.Context)
  • func (adapter *Adapter) WatchTrigger(md *reduced.Metadata)
• type QItem
  • func NewQItem(md *resource.Metadata, job QJob) QItem
  • func NewQItemFromReduced(md *reduced.Metadata, job QJob) QItem
• type QJob
  • func (job QJob) String() string
• type QKey
  • func (item QKey) ID() resource.ID
  • func (item QKey) Namespace() resource.Namespace
  • func (item QKey) Type() resource.Type
• type QValue
  • func (item QValue) FinalizersEmpty() bool
  • func (item QValue) Labels() *resource.Labels
  • func (item QValue) Phase() resource.Phase

Constants

const DefaultConcurrency = 1

DefaultConcurrency is the default concurrency for the QController.

Types

type Adapter

type Adapter struct {
	controllerstate.StateAdapter
	// contains filtered or unexported fields
}

Adapter implements QRuntime interface for the QController.

func NewAdapter

func NewAdapter(
	ctrl controller.QController,
	adapterOptions adapter.Options,
) (*Adapter, error)

NewAdapter creates a new QRuntime adapter for the QController.

func (*Adapter) Run

func (adapter *Adapter) Run(ctx context.Context)

Run the QController.

func (*Adapter) WatchTrigger

func (adapter *Adapter) WatchTrigger(md *reduced.Metadata)

WatchTrigger is called by common controller runtime when there is a change in the watched resources.

type QItem

type QItem struct {
	QKey
	QValue
}

QItem is a key-value pair stored in the reconcole queue.

func NewQItem

func NewQItem(md *resource.Metadata, job QJob) QItem

NewQItem creates a new QItem.

func NewQItemFromReduced

func NewQItemFromReduced(md *reduced.Metadata, job QJob) QItem

NewQItemFromReduced creates a new QItem from a reduced Metadata.

type QJob

type QJob int

QJob is a job to be executed by the reconcile queue.

const (
	QJobReconcile QJob = iota
	QJobMap
)

QJob constants.

func (QJob) String

func (job QJob) String() string

type QKey

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

QKey is the key of the reconcile queue.

func (QKey) ID

func (item QKey) ID() resource.ID

ID implements resource.Pointer interface.

func (QKey) Namespace

func (item QKey) Namespace() resource.Namespace

Namespace implements resource.Pointer interface.

func (QKey) Type

func (item QKey) Type() resource.Type

Type implements resource.Pointer interface.

type QValue

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

QValue is the value of the reconcile queue.

func (QValue) FinalizersEmpty

func (item QValue) FinalizersEmpty() bool

FinalizersEmpty implements ReducedResourceMetadata interface.

func (QValue) Labels

func (item QValue) Labels() *resource.Labels

Labels implements ReducedResourceMetadata interface.

func (QValue) Phase

func (item QValue) Phase() resource.Phase

Phase implements ReducedResourceMetadata interface.