sync

Documentation

Index

• func IsRecognizedObject(specObj crclient.Object) bool
• func SyncObjectWithCluster(specObj crclient.Object, api ClusterAPI) (crclient.Object, error)
• func SyncUnrecognizedObjectWithCluster(specObj crclient.Object, api ClusterAPI) (crclient.Object, error)
• type ClusterAPI
• type NotInSyncError
  • func NewNotInSync(obj crclient.Object, reason NotInSyncReason) *NotInSyncError
  • func (e *NotInSyncError) Error() string
• type NotInSyncReason
• type UnrecoverableSyncError
  • func (e *UnrecoverableSyncError) Error() string
  • func (e *UnrecoverableSyncError) Unwrap() error
• type WarningError
  • func (e *WarningError) Error() string
  • func (e *WarningError) Unwrap() error

Functions

func IsRecognizedObject

func IsRecognizedObject(specObj crclient.Object) bool

IsRecognizedObject returns whether the provided object kind is recognized by the sync package to support updating existing objects on the cluster. If the object is not recognized, passing it to SyncObjectWithCluster will fail. Instead, SyncUnrecognizedObjectWithCluster should be used.

func SyncObjectWithCluster

func SyncObjectWithCluster(specObj crclient.Object, api ClusterAPI) (crclient.Object, error)

SyncObjectWithCluster synchronises the state of specObj to the cluster, creating or updating the cluster object as required. If specObj is in sync with the cluster, returns the object as it exists on the cluster. Returns a NotInSyncError if an update is required, UnrecoverableSyncError if object provided is invalid, or generic error if an unexpected error is encountered

func SyncUnrecognizedObjectWithCluster

func SyncUnrecognizedObjectWithCluster(specObj crclient.Object, api ClusterAPI) (crclient.Object, error)

SyncUnrecognizedObjectWithCluster allows syncing objects not supported by SyncObjectWithCluster. As there is no generic way of deciding if an object needs to be updated, a WarningError is returned if the object exists on the cluster. The only object updating performed by this function is to ensure labels/annotations and ownerReferences in specObj are synced to the cluster. The reason arbitrary updates are not supported is 1) certain objects have defaulted fields that can always trigger naive diff checks (causing reconciles to get stuck), and 2) it's unknown which fields are unmodifiable, (e.g. services must keep ClusterIP once set; pod fields cannot be changed after creation)

Types

type ClusterAPI

type ClusterAPI struct {
	Client           crclient.Client
	NonCachingClient crclient.Client
	Scheme           *runtime.Scheme
	Logger           logr.Logger
	Ctx              context.Context
}

type NotInSyncError

type NotInSyncError struct {
	Reason NotInSyncReason
	Object crclient.Object
}

NotInSyncError is returned when a spec object is out-of-sync with its cluster counterpart

func NewNotInSync

func NewNotInSync(obj crclient.Object, reason NotInSyncReason) *NotInSyncError

NewNotInSync wraps creation of NotInSyncErrors for simplicity

func (*NotInSyncError) Error

func (e *NotInSyncError) Error() string

type NotInSyncReason

type NotInSyncReason string

const (
	UpdatedObjectReason NotInSyncReason = "Updated object"
	CreatedObjectReason NotInSyncReason = "Created object"
	DeletedObjectReason NotInSyncReason = "Deleted object"
	NeedRetryReason     NotInSyncReason = "Need to retry"
)

type UnrecoverableSyncError

type UnrecoverableSyncError struct {
	Cause error
}

UnrecoverableSyncError is returned when provided objects cannot be synced with the cluster due to an unexpected error (e.g. they are invalid according to the object's spec).

func (*UnrecoverableSyncError) Error

func (e *UnrecoverableSyncError) Error() string

func (*UnrecoverableSyncError) Unwrap

func (e *UnrecoverableSyncError) Unwrap() error

type WarningError

type WarningError struct {
	Message string
	Err     error
}

WarningError is returned when syncing is successful and can continue but there is a warning regarding the objects synced to the cluster (e.g. they will not be updated)

func (*WarningError) Error

func (e *WarningError) Error() string

func (*WarningError) Unwrap

func (e *WarningError) Unwrap() error