types

Documentation

Overview

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

Index

• Constants
• func NameKeyToString(key NameKey) string
• func ObjectKeyToString(key ObjectKey) string
• func TypeKeyToString(key TypeKey) string
• type NameKey
  • func NameKeyFromNamespaceAndName(namespace string, name string) NameKey
  • func NameKeyFromNamespacedName(namespaceName apitypes.NamespacedName) NameKey
• 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 TypeKey
  • func TypeKeyFromGroupAndVersionAndKind(group string, version string, kind string) TypeKey
  • func TypeKeyFromGroupVersionKind(gvk schema.GroupVersionKind) TypeKey
• type Unstructurable
• type UnstructurableMap
  • func (m UnstructurableMap) ToUnstructured() map[string]any

Constants

const (
	LabelKeySuffixOwnerId              = "owner-id"
	AnnotationKeySuffixOwnerId         = "owner-id"
	AnnotationKeySuffixDigest          = "digest"
	AnnotationKeySuffixAdoptionPolicy  = "adoption-policy"
	AnnotationKeySuffixReconcilePolicy = "reconcile-policy"
	AnnotationKeySuffixUpdatePolicy    = "update-policy"
	AnnotationKeySuffixDeletePolicy    = "delete-policy"
	AnnotationKeySuffixApplyOrder      = "apply-order"
	AnnotationKeySuffixPurgeOrder      = "purge-order"
	AnnotationKeySuffixDeleteOrder     = "delete-order"
	AnnotationKeySuffixStatusHint      = "status-hint"
)

const (
	AdoptionPolicyNever     = "never"
	AdoptionPolicyIfUnowned = "if-unowned"
	AdoptionPolicyAlways    = "always"
)

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

const (
	UpdatePolicyDefault     = "default"
	UpdatePolicyRecreate    = "recreate"
	UpdatePolicyReplace     = "replace"
	UpdatePolicySsaMerge    = "ssa-merge"
	UpdatePolicySsaOverride = "ssa-override"
)

const (
	DeletePolicyDefault = "default"
	DeletePolicyDelete  = "delete"
	DeletePolicyOrphan  = "orphan"
)

const (
	StatusHintHasObservedGeneration = "has-observed-generation"
	StatusHintHasReadyCondition     = "has-ready-condition"
	StatusHintConditions            = "conditions"
)

Functions

func NameKeyToString

func NameKeyToString(key NameKey) string

Return a string representation of a NameKey.

func ObjectKeyToString

func ObjectKeyToString(key ObjectKey) string

Return a string representation of an ObjectKey.

func TypeKeyToString

func TypeKeyToString(key TypeKey) string

Return a string representation of a TypeKey.

Types

type NameKey

type NameKey interface {
	GetNamespace() string
	GetName() string
}

Represents types which a namespace and a name. All types implementing metav1.Object or even controller-runtime's client.Object obviously implement NameKey as well.

func NameKeyFromNamespaceAndName

func NameKeyFromNamespaceAndName(namespace string, name string) NameKey

Wrap a namespace and name as NameKey.

func NameKeyFromNamespacedName

func NameKeyFromNamespacedName(namespaceName apitypes.NamespacedName) NameKey

Wrap a NamespacedName as NameKey.

type ObjectKey

type ObjectKey interface {
	TypeKey
	NameKey
}

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 TypeKey

type TypeKey interface {
	GetObjectKind() schema.ObjectKind
}

Represents types which have TypeMeta/GroupVersionKind. All types implementing runtime.Object or even controller-runtime's client.Object obviously implement TypeKey as well.

func TypeKeyFromGroupAndVersionAndKind

func TypeKeyFromGroupAndVersionAndKind(group string, version string, kind string) TypeKey

Wrap a group, version and kind as TypeKey.

func TypeKeyFromGroupVersionKind

func TypeKeyFromGroupVersionKind(gvk schema.GroupVersionKind) TypeKey

Wrap a GroupVersionKind as TypeKey.

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.