controller

Documentation

Overview

Package controller provides functions for creating and registering a Helm controller with a `controller-runtime` manager. It also provides a Helm reconciler implementation that can be used to create a Helm-based operator.

Index

• func Add(mgr manager.Manager, options WatchOptions) error
• func DeploymentNotInstalled(ctx context.Context, deploymentName string, namespaceName string) bool
• func ValidateNotebook(ctx context.Context, kind string, namespace string) error
• type HelmOperatorReconciler
  • func (r HelmOperatorReconciler) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error)
• type ReleaseHookFunc
• type WatchOptions

Functions

func Add

func Add(mgr manager.Manager, options WatchOptions) error

Add creates a new helm operator controller and adds it to the manager

func DeploymentNotInstalled

func DeploymentNotInstalled(ctx context.Context, deploymentName string, namespaceName string) bool

func ValidateNotebook

func ValidateNotebook(ctx context.Context, kind string, namespace string) error

Returns error if the release is for Notebook resource without the preconditions met

Types

type HelmOperatorReconciler

type HelmOperatorReconciler struct {
	Client                 client.Client
	EventRecorder          record.EventRecorder
	GVK                    schema.GroupVersionKind
	ManagerFactory         release.ManagerFactory
	ReconcilePeriod        time.Duration
	OverrideValues         map[string]string
	SuppressOverrideValues bool
	// contains filtered or unexported fields
}

HelmOperatorReconciler reconciles custom resources as Helm releases.

func (HelmOperatorReconciler) Reconcile

func (r HelmOperatorReconciler) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error)

type ReleaseHookFunc

type ReleaseHookFunc func(*rpb.Release) error

ReleaseHookFunc defines a function signature for release hooks.

type WatchOptions

type WatchOptions struct {
	GVK                     schema.GroupVersionKind
	ManagerFactory          release.ManagerFactory
	ReconcilePeriod         time.Duration
	WatchDependentResources bool
	OverrideValues          map[string]string
	SuppressOverrideValues  bool
	MaxConcurrentReconciles int
	Selector                metav1.LabelSelector
}

WatchOptions contains the necessary values to create a new controller that manages helm releases in a particular namespace based on a GVK watch.