controllers

type Applier ¶

type Applier interface {
	// Apply applies the content in the provided fs.FS using the configuration of the provided ClusterExtension.
	// It also takes in a map[string]string to be applied to all applied resources as labels and another
	// map[string]string used to create a unique identifier for a stored reference to the resources created.
	Apply(context.Context, fs.FS, *ocv1.ClusterExtension, map[string]string, map[string]string) (bool, string, error)
}

type BoxcutterRevisionStatesGetter ¶ added in v1.6.0

type BoxcutterRevisionStatesGetter struct {
	Reader client.Reader
}

func (d *BoxcutterRevisionStatesGetter) GetRevisionStates(ctx context.Context, ext *ocv1.ClusterExtension) (*RevisionStates, error)

type CatalogCache ¶

type CatalogCache interface {
	Get(catalogName, resolvedRef string) (fs.FS, error)
	Remove(catalogName string) error
}

type CatalogCachePopulator ¶

type CatalogCachePopulator interface {
	PopulateCache(ctx context.Context, catalog *ocv1.ClusterCatalog) (fs.FS, error)
}

type ClusterCatalogReconciler ¶

type ClusterCatalogReconciler struct {
	client.Client
	CatalogCache          CatalogCache
	CatalogCachePopulator CatalogCachePopulator
}

ClusterCatalogReconciler reconciles a ClusterCatalog object

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

func (r *ClusterCatalogReconciler) SetupWithManager(mgr ctrl.Manager) error

type ClusterExtensionReconciler ¶

type ClusterExtensionReconciler struct {
	client.Client
	ReconcileSteps ReconcileSteps
}

ClusterExtensionReconciler reconciles a ClusterExtension object

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

func (r *ClusterExtensionReconciler) SetupWithManager(mgr ctrl.Manager, opts ...ControllerBuilderOption) (crcontroller.Controller, error)

type ClusterExtensionRevisionReconciler ¶ added in v1.6.0

type ClusterExtensionRevisionReconciler struct {
	Client         client.Client
	RevisionEngine RevisionEngine
	TrackingCache  trackingCache
}

ClusterExtensionRevisionReconciler actions individual snapshots of ClusterExtensions, as part of the boxcutter integration.

func (c *ClusterExtensionRevisionReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (c *ClusterExtensionRevisionReconciler) SetupWithManager(mgr ctrl.Manager) error

type ControllerBuilderOption ¶ added in v1.6.0

type ControllerBuilderOption func(builder *ctrl.Builder)

func WithOwns(obj client.Object) ControllerBuilderOption

type HelmRevisionStatesGetter ¶ added in v1.6.0

type HelmRevisionStatesGetter struct {
	helmclient.ActionClientGetter
}

func (d *HelmRevisionStatesGetter) GetRevisionStates(ctx context.Context, ext *ocv1.ClusterExtension) (*RevisionStates, error)

type ReconcileStepFunc ¶ added in v1.7.0

type ReconcileStepFunc func(context.Context, *reconcileState, *ocv1.ClusterExtension) (*ctrl.Result, error)

ReconcileStepFunc represents a single step in the ClusterExtension reconciliation process. It takes a context, state and ClusterExtension object as input and returns: - Any error that occurred during reconciliation, which will be returned to the caller - A ctrl.Result that indicates whether reconciliation should complete immediately or be retried later

func ApplyBundle(a Applier) ReconcileStepFunc

func HandleFinalizers(f finalizer.Finalizer) ReconcileStepFunc

func MigrateStorage(m StorageMigrator) ReconcileStepFunc

func ResolveBundle(r resolve.Resolver) ReconcileStepFunc

func RetrieveRevisionStates(r RevisionStatesGetter) ReconcileStepFunc

func UnpackBundle(i imageutil.Puller, cache imageutil.Cache) ReconcileStepFunc

type ReconcileSteps ¶ added in v1.7.0

type ReconcileSteps []ReconcileStepFunc

ReconcileSteps is an ordered collection of reconciliation steps that are executed sequentially. Each step receives the shared state from previous steps, allowing data to flow through the pipeline.

func (steps *ReconcileSteps) Reconcile(ctx context.Context, ext *ocv1.ClusterExtension) (ctrl.Result, error)

type RevisionEngine ¶ added in v1.6.0

type RevisionEngine interface {
	Teardown(ctx context.Context, rev machinerytypes.Revision, opts ...machinerytypes.RevisionTeardownOption) (machinery.RevisionTeardownResult, error)
	Reconcile(ctx context.Context, rev machinerytypes.Revision, opts ...machinerytypes.RevisionReconcileOption) (machinery.RevisionResult, error)
}

type RevisionMetadata ¶ added in v1.6.0

type RevisionMetadata struct {
	Package string
	Image   string
	ocv1.BundleMetadata
}

type RevisionStates ¶ added in v1.6.0

type RevisionStates struct {
	Installed  *RevisionMetadata
	RollingOut []*RevisionMetadata
}

type RevisionStatesGetter ¶ added in v1.6.0

type RevisionStatesGetter interface {
	GetRevisionStates(ctx context.Context, ext *ocv1.ClusterExtension) (*RevisionStates, error)
}

type Sourcerer ¶ added in v1.6.0

type Sourcerer interface {
	Source(handler handler.EventHandler, predicates ...predicate.Predicate) source.Source
}

type StorageMigrator ¶ added in v1.6.0

type StorageMigrator interface {
	Migrate(context.Context, *ocv1.ClusterExtension, map[string]string) error
}