conditions

Documentation

Index

• Constants
• func InMaintenance() metav1.Condition
• func MaintenanceFailed(message string) metav1.Condition
• func MaintenanceSuccess() metav1.Condition
• func NotReady() metav1.Condition
• func Progressing() metav1.Condition
• func Ready() metav1.Condition
• type ConditionBuilder
  • func Builder() *ConditionBuilder
  • func (b *ConditionBuilder) Build() metav1.Condition
  • func (b *ConditionBuilder) With(condition metav1.Condition) *ConditionBuilder
  • func (b *ConditionBuilder) WithGeneration(object client.Object) *ConditionBuilder
  • func (b *ConditionBuilder) WithMessage(message string) *ConditionBuilder

Constants

const (
	ReasonMaintenanceProgressing = "MaintenanceProgressing"
	ReasonMaintenanceSuccess     = "MaintenanceFinishedSuccessfully"
	ReasonMaintenanceFailure     = "MaintenanceFinishedWithError"
	ReasonReady                  = "Available"
	ReasonNotReady               = "NotAvailable"
	ReasonProgressing            = "ProgressingResource"
)

Reasons that give more context to conditions.

const (
	// TypeInMaintenance identifies a condition related to maintenance.
	TypeInMaintenance = "InMaintenance"
	// TypeReady indicates that an instance is ready to serve.
	TypeReady = "Ready"
	// TypeProgressing indicates that an instance is being updated.
	TypeProgressing = "Progressing"
)

Functions

func InMaintenance

func InMaintenance() metav1.Condition

InMaintenance creates an active condition with TypeReady, ReasonReady and empty message.

func MaintenanceFailed

func MaintenanceFailed(message string) metav1.Condition

MaintenanceFailed creates an inactive condition with TypeInMaintenance, ReasonMaintenanceFailure and given message.

func MaintenanceSuccess

func MaintenanceSuccess() metav1.Condition

MaintenanceSuccess creates an inactive condition with TypeInMaintenance, ReasonMaintenanceSuccess and empty message.

func NotReady

func NotReady() metav1.Condition

NotReady creates a condition with TypeReady, ReasonReady and empty message.

func Progressing

func Progressing() metav1.Condition

Progressing creates a condition with TypeProgressing, ReasonReady and empty message.

func Ready

func Ready() metav1.Condition

Ready creates a condition with TypeReady, ReasonReady and empty message.

Types

type ConditionBuilder

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

ConditionBuilder builds Conditions using various properties.

func Builder

func Builder() *ConditionBuilder

Builder returns a new ConditionBuilder instance.

func (*ConditionBuilder) Build

func (b *ConditionBuilder) Build() metav1.Condition

Build returns the condition.

func (*ConditionBuilder) With

func (b *ConditionBuilder) With(condition metav1.Condition) *ConditionBuilder

With initializes the condition with the given value. Returns itself for convenience.

func (*ConditionBuilder) WithGeneration

func (b *ConditionBuilder) WithGeneration(object client.Object) *ConditionBuilder

WithGeneration sets ObservedGeneration from the given object. Returns itself for convenience.

func (*ConditionBuilder) WithMessage

func (b *ConditionBuilder) WithMessage(message string) *ConditionBuilder

WithMessage sets the condition message. Returns itself for convenience.