shared

Documentation

Overview

Copyright 2022-2023 Edixos SPDX-License-Identifier: Apache-2.0

Index

• Variables
• type ConditionedObject
• type Reconciler
  • func (r *Reconciler) DeleteObject(ctx context.Context, object client.Object) (err error)
  • func (r *Reconciler) EmitEvent(object runtime.Object, name string, res controllerutil.OperationResult, ...)
  • func (r *Reconciler) ProcessCondition(ctx context.Context, object ConditionedObject, conditionType string, ...)
  • func (r *Reconciler) ProcessFailedCondition(ctx context.Context, object ConditionedObject, conditionType string, ...)
  • func (r *Reconciler) ProcessInProgressCondition(ctx context.Context, object ConditionedObject, conditionType string, ...)
  • func (r *Reconciler) ProcessReadyCondition(ctx context.Context, object ConditionedObject, conditionType string, ...)
  • func (r *Reconciler) UpdateStatus(ctx context.Context, object client.Object) (err error)

Variables

var Clock clock.Clock = clock.RealClock{}

Clock is defined as a package var so it can be stubbed out during tests.

Types

type ConditionedObject

type ConditionedObject interface {
	client.Object
	metav1.Object
	GetConditions() []metav1.Condition
	SetConditions([]metav1.Condition)
}

ConditionedObject is an interface that describes condition-related operations.

type Reconciler

type Reconciler struct {
	client.Client
	Scheme   *runtime.Scheme
	Recorder record.EventRecorder
	Log      logr.Logger
}

Reconciler reconciles an object.

func (*Reconciler) DeleteObject

func (r *Reconciler) DeleteObject(ctx context.Context, object client.Object) (err error)

func (*Reconciler) EmitEvent

func (r *Reconciler) EmitEvent(object runtime.Object, name string, res controllerutil.OperationResult, msg string, err error)

func (*Reconciler) ProcessCondition

func (r *Reconciler) ProcessCondition(ctx context.Context, object ConditionedObject, conditionType string, status metav1.ConditionStatus, reason, message string)

func (*Reconciler) ProcessFailedCondition

func (r *Reconciler) ProcessFailedCondition(ctx context.Context, object ConditionedObject, conditionType string, status metav1.ConditionStatus, reason, message string)

func (*Reconciler) ProcessInProgressCondition

func (r *Reconciler) ProcessInProgressCondition(ctx context.Context, object ConditionedObject, conditionType string, status metav1.ConditionStatus, reason, message string)

func (*Reconciler) ProcessReadyCondition

func (r *Reconciler) ProcessReadyCondition(ctx context.Context, object ConditionedObject, conditionType string, status metav1.ConditionStatus, reason, message string)

func (*Reconciler) UpdateStatus

func (r *Reconciler) UpdateStatus(ctx context.Context, object client.Object) (err error)