types

Documentation

Overview

Package types contains common types used and exposed by the component-operator-runtime framework.

Index

• Constants
• func ObjectKeyToString(key ObjectKey) string
• type ObjectKey
• type RetriableError
  • func NewRetriableError(err error, retryAfter *time.Duration) RetriableError
  • func (e RetriableError) Cause() error
  • func (e RetriableError) Error() string
  • func (e RetriableError) RetryAfter() *time.Duration
  • func (e RetriableError) Unwrap() error
• type SchemeBuilder
• type Unstructurable
• type UnstructurableMap
  • func (m UnstructurableMap) ToUnstructured() map[string]any

Constants

const (
	LabelKeySuffixOwnerId              = "owner-id"
	AnnotationKeySuffixDigest          = "digest"
	AnnotationKeySuffixReconcilePolicy = "reconcile-policy"
	AnnotationKeySuffixUpdatePolicy    = "update-policy"
	AnnotationKeySuffixOrder           = "order"
	AnnotationKeySuffixPurgeOrder      = "purge-order"
	AnnotationKeySuffixOwnerId         = "owner-id"
)

const (
	ReconcilePolicyOnObjectChange            = "on-object-change"
	ReconcilePolicyOnObjectOrComponentChange = "on-object-or-component-change"
	ReconcilePolicyOnce                      = "once"
)

const (
	UpdatePolicyDefault  = "default"
	UpdatePolicyRecreate = "recreate"
)

Functions

func ObjectKeyToString

func ObjectKeyToString(key ObjectKey) string

Return a string representation of an ObjectKey.

Types

type ObjectKey

type ObjectKey interface {
	GetObjectKind() schema.ObjectKind
	GetNamespace() string
	GetName() string
}

Represents types which have TypeMeta, and a namespace and a name. All types implementing controller-runtime's client.Object obviously implement ObjectKey as well.

type RetriableError

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

func NewRetriableError

func NewRetriableError(err error, retryAfter *time.Duration) RetriableError

func (RetriableError) Cause

func (e RetriableError) Cause() error

func (RetriableError) Error

func (e RetriableError) Error() string

func (RetriableError) RetryAfter

func (e RetriableError) RetryAfter() *time.Duration

func (RetriableError) Unwrap

func (e RetriableError) Unwrap() error

type SchemeBuilder

type SchemeBuilder interface {
	AddToScheme(scheme *runtime.Scheme) error
}

SchemeBuilder interface.

type Unstructurable

type Unstructurable interface {
	ToUnstructured() map[string]any
}

Unstructurable represents objects which can be converted into a string-keyed map. All Kubernetes API types, as well as all JSON objects could be modelled as Unstructurable objects.

type UnstructurableMap

type UnstructurableMap map[string]any

UnstructurableMap is a string-keyed map, implementing the Unstructurable interface in the natural way.

func (UnstructurableMap) ToUnstructured

func (m UnstructurableMap) ToUnstructured() map[string]any

ToUnstructured() just returns the map itself.