common

Documentation

Overview

Package common provides the common types and interfaces for the controllers

Index

• type FakeReconciler
  • func (f *FakeReconciler) FeatureGate() string
  • func (f *FakeReconciler) FeatureGroup() string
  • func (f *FakeReconciler) FeatureName() string
  • func (f *FakeReconciler) Reconcile(context.Context, ctrl.Request) (res ctrl.Result, err error)
  • func (f *FakeReconciler) SetupWithManager(mgr ctrl.Manager) error
• type FeaturedReconciler
• type FeaturedReconcilerGroup
  • func NewFeaturedReconcilerGroup() *FeaturedReconcilerGroup
  • func (g *FeaturedReconcilerGroup) Init(featureSlice []string, featureGate string, mgr ctrl.Manager) (err error)
  • func (g *FeaturedReconcilerGroup) Put(reconciler FeaturedReconciler)
• type Reconciler

Types

type FakeReconciler

type FakeReconciler struct {
	SetupError error
	Group      string
	Name       string
	Gate       string
}

FakeReconciler only for the test purpose

func (*FakeReconciler) FeatureGate

func (f *FakeReconciler) FeatureGate() string

func (*FakeReconciler) FeatureGroup

func (f *FakeReconciler) FeatureGroup() string

func (*FakeReconciler) FeatureName

func (f *FakeReconciler) FeatureName() string

func (*FakeReconciler) Reconcile

func (f *FakeReconciler) Reconcile(context.Context, ctrl.Request) (res ctrl.Result, err error)

func (*FakeReconciler) SetupWithManager

func (f *FakeReconciler) SetupWithManager(mgr ctrl.Manager) error

type FeaturedReconciler

type FeaturedReconciler interface {
	Reconciler
	FeatureGroup() string
	FeatureName() string
	FeatureGate() string
}

FeaturedReconciler represents a featured reconciler

type FeaturedReconcilerGroup

type FeaturedReconcilerGroup struct {
	// contains filtered or unexported fields
}

FeaturedReconcilerGroup groups a set of reconcilers

func NewFeaturedReconcilerGroup

func NewFeaturedReconcilerGroup() *FeaturedReconcilerGroup

NewFeaturedReconcilerGroup creates the FeaturedReconcilerGroup instance

func (*FeaturedReconcilerGroup) Init

func (g *FeaturedReconcilerGroup) Init(featureSlice []string, featureGate string, mgr ctrl.Manager) (err error)

Init setups all the controllers

func (*FeaturedReconcilerGroup) Put

func (g *FeaturedReconcilerGroup) Put(reconciler FeaturedReconciler)

Put puts a reconciler

type Reconciler

type Reconciler interface {
	Reconcile(context.Context, ctrl.Request) (ctrl.Result, error)
	SetupWithManager(mgr ctrl.Manager) error
}

Reconciler represents a reconciler interface