reconstitution

Documentation

Index

• type Client
• type CompositionRef
  • func NewCompositionRef(comp *apiv1.Composition) *CompositionRef
• type Manager
  • func New(mgr ctrl.Manager, writeBatchInterval time.Duration) (*Manager, error)
  • func (m *Manager) Add(rec Reconciler) error
  • func (r Manager) AddQueue(queue workqueue.Interface)
  • func (m *Manager) GetClient() Client
  • func (w Manager) PatchStatusAsync(ctx context.Context, ref *ManifestRef, patchFn StatusPatchFn)
  • func (r Manager) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (w Manager) Start(ctx context.Context) error
• type ManifestRef
• type Reconciler
• type Request
• type Resource
  • func (r *Resource) Deleted() bool
  • func (l *Resource) HasBeenSeen() bool
  • func (l *Resource) MatchesLastSeen(rv string) bool
  • func (l *Resource) ObserveReconciliation() time.Duration
  • func (l *Resource) ObserveVersion(rv string)
  • func (r *Resource) Parse() (*unstructured.Unstructured, error)
• type ResourceRef
• type StatusPatchFn

Types

type Client

type Client interface {
	Get(ctx context.Context, comp *CompositionRef, res *ResourceRef) (*Resource, bool)
	PatchStatusAsync(ctx context.Context, req *ManifestRef, patchFn StatusPatchFn)
}

Client provides read/write access to a collection of reconstituted resources.

type CompositionRef

type CompositionRef struct {
	Name, Namespace string
	Generation      int64
}

CompositionRef refers to a specific generation of a composition.

func NewCompositionRef

func NewCompositionRef(comp *apiv1.Composition) *CompositionRef

type Manager

type Manager struct {
	ctrl.Manager
	// contains filtered or unexported fields
}

func New

func New(mgr ctrl.Manager, writeBatchInterval time.Duration) (*Manager, error)

New creates a new Manager, which is responsible for "reconstituting" resources i.e. allowing controllers to treat them as individual resources instead of their storage representation (ResourceSlice).

func (*Manager) Add

func (m *Manager) Add(rec Reconciler) error

func (Manager) AddQueue

func (r Manager) AddQueue(queue workqueue.Interface)

func (*Manager) GetClient

func (m *Manager) GetClient() Client

func (Manager) PatchStatusAsync

func (w Manager) PatchStatusAsync(ctx context.Context, ref *ManifestRef, patchFn StatusPatchFn)

func (Manager) Reconcile

func (r Manager) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (Manager) Start

func (w Manager) Start(ctx context.Context) error

type ManifestRef

type ManifestRef struct {
	Slice types.NamespacedName
	Index int // position of this manifest within the slice
}

ManifestRef references a particular resource manifest within a resource slice.

type Reconciler

type Reconciler interface {
	Name() string
	Reconcile(ctx context.Context, req *Request) (ctrl.Result, error)
}

Reconciler is implemented by types that can reconcile individual, reconstituted resources.

type Request

type Request struct {
	Resource    ResourceRef
	Manifest    ManifestRef
	Composition types.NamespacedName
}

Request is like controller-runtime reconcile.Request but for reconstituted resources. https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/reconcile#Request

type Resource

type Resource struct {
	Ref          ResourceRef
	Manifest     *apiv1.Manifest
	GVK          schema.GroupVersionKind
	SliceDeleted bool
	// contains filtered or unexported fields
}

Resource is the controller's internal representation of a single resource out of a ResourceSlice.

func (*Resource) Deleted

func (r *Resource) Deleted() bool

func (*Resource) HasBeenSeen

func (l *Resource) HasBeenSeen() bool

func (*Resource) MatchesLastSeen

func (l *Resource) MatchesLastSeen(rv string) bool

func (*Resource) ObserveReconciliation

func (l *Resource) ObserveReconciliation() time.Duration

func (*Resource) ObserveVersion

func (l *Resource) ObserveVersion(rv string)

func (*Resource) Parse

func (r *Resource) Parse() (*unstructured.Unstructured, error)

type ResourceRef

type ResourceRef struct {
	Name, Namespace, Kind string
}

ResourceRef refers to a specific synthesized resource.

type StatusPatchFn

type StatusPatchFn func(*apiv1.ResourceState) *apiv1.ResourceState