controllers

Documentation

Index

• Constants
• func SetDeprecationStatus(ext *ocv1.ClusterExtension, bundleName string, ...)
• type Applier
• type CatalogCache
• type CatalogCachePopulator
• type ClusterCatalogReconciler
  • func (r *ClusterCatalogReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *ClusterCatalogReconciler) SetupWithManager(mgr ctrl.Manager) error
• type ClusterExtensionReconciler
  • func (r *ClusterExtensionReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *ClusterExtensionReconciler) SetupWithManager(mgr ctrl.Manager) error
• type DefaultInstalledBundleGetter
  • func (d *DefaultInstalledBundleGetter) GetInstalledBundle(ctx context.Context, ext *ocv1.ClusterExtension) (*InstalledBundle, error)
• type InstalledBundle
• type InstalledBundleGetter
• type PullSecretReconciler
  • func (r *PullSecretReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *PullSecretReconciler) SetupWithManager(mgr ctrl.Manager) error

Constants

const (
	ClusterExtensionCleanupUnpackCacheFinalizer         = "olm.operatorframework.io/cleanup-unpack-cache"
	ClusterExtensionCleanupContentManagerCacheFinalizer = "olm.operatorframework.io/cleanup-contentmanager-cache"
)

Functions

func SetDeprecationStatus

func SetDeprecationStatus(ext *ocv1.ClusterExtension, bundleName string, deprecation *declcfg.Deprecation)

SetDeprecationStatus will set the appropriate deprecation statuses for a ClusterExtension based on the provided bundle

Types

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) ([]client.Object, string, 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 (*ClusterCatalogReconciler) Reconcile

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

func (*ClusterCatalogReconciler) SetupWithManager

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

SetupWithManager sets up the controller with the Manager.

type ClusterExtensionReconciler

type ClusterExtensionReconciler struct {
	client.Client
	Resolver resolve.Resolver

	ImageCache  imageutil.Cache
	ImagePuller imageutil.Puller

	Applier Applier
	Manager contentmanager.Manager

	InstalledBundleGetter InstalledBundleGetter
	Finalizers            crfinalizer.Finalizers
	// contains filtered or unexported fields
}

ClusterExtensionReconciler reconciles a ClusterExtension object

func (*ClusterExtensionReconciler) Reconcile

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

The operator controller needs to watch all the bundle objects and reconcile accordingly. Though not ideal, but these permissions are required. This has been taken from rukpak, and an issue was created before to discuss it: https://github.com/operator-framework/rukpak/issues/800.

func (*ClusterExtensionReconciler) SetupWithManager

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

SetupWithManager sets up the controller with the Manager.

type DefaultInstalledBundleGetter

type DefaultInstalledBundleGetter struct {
	helmclient.ActionClientGetter
}

func (*DefaultInstalledBundleGetter) GetInstalledBundle

func (d *DefaultInstalledBundleGetter) GetInstalledBundle(ctx context.Context, ext *ocv1.ClusterExtension) (*InstalledBundle, error)

type InstalledBundle

type InstalledBundle struct {
	ocv1.BundleMetadata
	Image string
}

type InstalledBundleGetter

type InstalledBundleGetter interface {
	GetInstalledBundle(ctx context.Context, ext *ocv1.ClusterExtension) (*InstalledBundle, error)
}

type PullSecretReconciler

type PullSecretReconciler struct {
	client.Client
	SecretKey    types.NamespacedName
	AuthFilePath string
}

PullSecretReconciler reconciles a specific Secret object that contains global pull secrets for pulling bundle images

func (*PullSecretReconciler) Reconcile

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

func (*PullSecretReconciler) SetupWithManager

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

SetupWithManager sets up the controller with the Manager.