reconciler

func SkipDependentWatches ¶

func SkipDependentWatches(skip bool) Option

WithDependentWatchesEnabled is an Option that configures whether the Reconciler will register watches for dependent objects in releases and trigger reconciliations when they change.

By default, dependent watches are enabled.

func SkipPrimaryGVKSchemeRegistration ¶ added in v0.0.10

func SkipPrimaryGVKSchemeRegistration(skip bool) Option

SkipPrimaryGVKSchemeRegistration is an Option that allows to disable the default behaviour of registering unstructured.Unstructured as underlying type for the GVK scheme.

Disabling this built-in registration is necessary when building operators for which it is desired to have the underlying GVK scheme backed by a custom struct type.

Example for using a custom type for the GVK scheme instead of unstructured.Unstructured:

// Define custom type for GVK scheme.
//+kubebuilder:object:root=true
type Custom struct {
  // [...]
}

// Register custom type along with common meta types in scheme.
scheme := runtime.NewScheme()
scheme.AddKnownTypes(SchemeGroupVersion, &Custom{})
metav1.AddToGroupVersion(scheme, SchemeGroupVersion)

// Create new manager using the controller-runtime, injecting above scheme.
options := ctrl.Options{
  Scheme = scheme,
  // [...]
}
mgr, err := ctrl.NewManager(config, options)

// Create reconciler with generic scheme registration being disabled.
r, err := reconciler.New(
  reconciler.WithChart(chart),
  reconciler.SkipPrimaryGVKSchemeRegistration(true),
  // [...]
)

// Setup reconciler with above manager.
err = r.SetupWithManager(mgr)

By default, skipping of the generic scheme setup is disabled, which means that unstructured.Unstructured is used for the GVK scheme.

func WithActionClientGetter ¶

func WithActionClientGetter(actionClientGetter helmclient.ActionClientGetter) Option

WithActionClientGetter is an Option that configures a Reconciler's ActionClientGetter.

A default ActionClientGetter is used if this option is not configured.

func WithChart ¶

func WithChart(chrt chart.Chart) Option

WithChart is an Option that configures a Reconciler's helm chart.

This option is required.

func WithClient ¶

func WithClient(cl client.Client) Option

WithClient is an Option that configures a Reconciler's client.

By default, manager.GetClient() is used if this option is not configured.

func WithControllerSetupFunc ¶ added in v0.1.0

func WithControllerSetupFunc(f ControllerSetupFunc) Option

WithControllerSetupFunc is an Option that allows customizing a controller before it is started. The only supported customization here is adding additional Watch sources to the controller.

func WithEventRecorder ¶

func WithEventRecorder(er record.EventRecorder) Option

WithEventRecorder is an Option that configures a Reconciler's EventRecorder.

By default, manager.GetEventRecorderFor() is used if this option is not configured.

func WithGroupVersionKind ¶

func WithGroupVersionKind(gvk schema.GroupVersionKind) Option

WithGroupVersionKind is an Option that configures a Reconciler's GroupVersionKind.

This option is required.

func WithInstallAnnotations ¶

func WithInstallAnnotations(as ...annotation.Install) Option

WithInstallAnnotations is an Option that configures Install annotations to enable custom action.Install fields to be set based on the value of annotations found in the custom resource watched by this reconciler. Duplicate annotation names will result in an error.

func WithLog ¶

func WithLog(log logr.Logger) Option

WithLog is an Option that configures a Reconciler's logger.

A default logger is used if this option is not configured.

func WithMaxConcurrentReconciles ¶

func WithMaxConcurrentReconciles(max int) Option

WithMaxConcurrentReconciles is an Option that configures the number of concurrent reconciles that the controller will run.

The default is 1.

func WithMaxReleaseHistory ¶ added in v0.0.9

func WithMaxReleaseHistory(maxHistory int) Option

WithMaxReleaseHistory specifies the maximum size of the Helm release history maintained on upgrades/rollbacks. Zero (default) means unlimited.

func WithOverrideValues ¶

func WithOverrideValues(overrides map[string]string) Option

WithOverrideValues is an Option that configures a Reconciler's override values.

Override values can be used to enforce that certain values provided by the chart's default values.yaml or by a CR spec are always overridden when rendering the chart. If a value in overrides is set by a CR, it is overridden by the override value. The override value can be static but can also refer to an environment variable.

If an environment variable reference is listed in override values but is not present in the environment when this function runs, it will resolve to an empty string and override all other values. Therefore, when using environment variable expansion, ensure that the environment variable is set.

func WithPostHook ¶

func WithPostHook(h hook.PostHook) Option

WithPostHook is an Option that configures the reconciler to run the given PostHook just after performing any non-uninstall release actions.

func WithPreHook ¶

func WithPreHook(h hook.PreHook) Option

WithPreHook is an Option that configures the reconciler to run the given PreHook just before performing any actions (e.g. install, upgrade, uninstall, or reconciliation).

func WithReconcilePeriod ¶

func WithReconcilePeriod(rp time.Duration) Option

WithReconcilePeriod is an Option that configures the reconcile period of the controller. This will cause the controller to reconcile CRs at least once every period. By default, the reconcile period is set to 0, which means no time-based reconciliations will occur.

func WithSelector ¶ added in v0.0.9

func WithSelector(s metav1.LabelSelector) Option

WithSelector is an Option that configures the reconciler to creates a predicate that is used to filter resources based on the specified selector

func WithUninstallAnnotations ¶

func WithUninstallAnnotations(as ...annotation.Uninstall) Option

WithUninstallAnnotations is an Option that configures Uninstall annotations to enable custom action.Uninstall fields to be set based on the value of annotations found in the custom resource watched by this reconciler. Duplicate annotation names will result in an error.

func WithUpgradeAnnotations ¶

func WithUpgradeAnnotations(as ...annotation.Upgrade) Option

WithUpgradeAnnotations is an Option that configures Upgrade annotations to enable custom action.Upgrade fields to be set based on the value of annotations found in the custom resource watched by this reconciler. Duplicate annotation names will result in an error.

func WithValueTranslator ¶ added in v0.0.9

func WithValueTranslator(t values.Translator) Option

WithValueTranslator is an Option that configures a function that translates a custom resource to the values passed to Helm. Use this if you need to customize the logic that translates your custom resource to Helm values. If you wish to, you can convert the Unstructured that is passed to your Translator to your own Custom Resource struct like this:

import "k8s.io/apimachinery/pkg/runtime"
foo := your.Foo{}
if err = runtime.DefaultUnstructuredConverter.FromUnstructured(u.Object, &foo); err != nil {
  return nil, err
}
// work with the type-safe foo

Alternatively, your translator can also work similarly to a Mapper, by accessing the spec with:

u.Object["spec"].(map[string]interface{})

func New ¶

func New(opts ...Option) (*Reconciler, error)

New creates a new Reconciler that reconciles custom resources that define a Helm release. New takes variadic Option arguments that are used to configure the Reconciler.

Required options are:

• WithGroupVersionKind
• WithChart

Other options are defaulted to sane defaults when SetupWithManager is called.

If an error occurs configuring or validating the Reconciler, it is returned.