controller

Documentation

Index

• Constants
• func Add(mgr manager.Manager) error
• func GetConditionValues(conditionList []conditions.Condition) map[conditions.ConditionType]corev1.ConditionStatus
• func MarkCrDeploying(cr *cdiv1alpha1.CDI, reason, message string)
• func MarkCrFailed(cr *cdiv1alpha1.CDI, reason, message string)
• func MarkCrFailedHealing(cr *cdiv1alpha1.CDI, reason, message string)
• func MarkCrHealthyMessage(cr *cdiv1alpha1.CDI, reason, message string)
• func MarkCrUpgradeHealingDegraded(cr *cdiv1alpha1.CDI, reason, message string)
• func NewIgnoreLeaderElectionPredicate() predicate.Predicate
• type CertManager
  • func NewCertManager(mgr manager.Manager, installNamespace string, additionalNamespaces ...string) (CertManager, error)
• type IgnoreWithMeta
  • func (p *IgnoreWithMeta) Create(e event.CreateEvent) bool
  • func (p *IgnoreWithMeta) Delete(e event.DeleteEvent) bool
  • func (p *IgnoreWithMeta) Generic(e event.GenericEvent) bool
  • func (p *IgnoreWithMeta) Update(e event.UpdateEvent) bool
• type ReconcileCDI
  • func (r *ReconcileCDI) Reconcile(request reconcile.Request) (reconcile.Result, error)
• type ReconcileCallback
• type ReconcileCallbackArgs
• type ReconcileState

Constants

const LeaderElectionAnnotation = "control-plane.alpha.kubernetes.io/leader"

LeaderElectionAnnotation is the annotatation used on resources for leader election

const (
	// SCCAnnotation is the annotation listing SCCs for a SA
	SCCAnnotation = "cdi-scc"
)

Functions

func Add

func Add(mgr manager.Manager) error

Add creates a new CDI Controller and adds it to the Manager. The Manager will set fields on the Controller and Start it when the Manager is Started.

func GetConditionValues

func GetConditionValues(conditionList []conditions.Condition) map[conditions.ConditionType]corev1.ConditionStatus

GetConditionValues gets the conditions and put them into a map for easy comparison

func MarkCrDeploying

func MarkCrDeploying(cr *cdiv1alpha1.CDI, reason, message string)

MarkCrDeploying marks the passed CR as currently deploying. The CR object needs to be updated by the caller afterwards. Deploying means the following status conditions are set: ApplicationAvailable: false Progressing: true Degraded: false

func MarkCrFailed

func MarkCrFailed(cr *cdiv1alpha1.CDI, reason, message string)

MarkCrFailed marks the passed CR as failed and requiring human intervention. The CR object needs to be updated by the caller afterwards. Failed means the following status conditions are set: ApplicationAvailable: false Progressing: false Degraded: true

func MarkCrFailedHealing

func MarkCrFailedHealing(cr *cdiv1alpha1.CDI, reason, message string)

MarkCrFailedHealing marks the passed CR as failed and healing. The CR object needs to be updated by the caller afterwards. FailedAndHealing means the following status conditions are set: ApplicationAvailable: false Progressing: true Degraded: true

func MarkCrHealthyMessage

func MarkCrHealthyMessage(cr *cdiv1alpha1.CDI, reason, message string)

MarkCrHealthyMessage marks the passed in CR as healthy. The CR object needs to be updated by the caller afterwards. Healthy means the following status conditions are set: ApplicationAvailable: true Progressing: false Degraded: false

func MarkCrUpgradeHealingDegraded

func MarkCrUpgradeHealingDegraded(cr *cdiv1alpha1.CDI, reason, message string)

MarkCrUpgradeHealingDegraded marks the passed CR as upgrading and degraded. The CR object needs to be updated by the caller afterwards. Failed means the following status conditions are set: ApplicationAvailable: true Progressing: true Degraded: true

func NewIgnoreLeaderElectionPredicate

func NewIgnoreLeaderElectionPredicate() predicate.Predicate

NewIgnoreLeaderElectionPredicate returns a predicate used for ignoring leader election resources

Types

type CertManager

type CertManager interface {
	Sync(certs []cdicerts.CertificateDefinition) error
}

CertManager is the client interface to the certificate manager/refresher

func NewCertManager

func NewCertManager(mgr manager.Manager, installNamespace string, additionalNamespaces ...string) (CertManager, error)

NewCertManager creates a new certificate manager/refresher

type IgnoreWithMeta

type IgnoreWithMeta struct {
	LabelKeys      []string
	AnnotationKeys []string
}

IgnoreWithMeta ignores resources with specified labels/annotations

func (*IgnoreWithMeta) Create

func (p *IgnoreWithMeta) Create(e event.CreateEvent) bool

Create implements Predicate

func (*IgnoreWithMeta) Delete

func (p *IgnoreWithMeta) Delete(e event.DeleteEvent) bool

Delete implements Predicate

func (*IgnoreWithMeta) Generic

func (p *IgnoreWithMeta) Generic(e event.GenericEvent) bool

Generic implements Predicate

func (*IgnoreWithMeta) Update

func (p *IgnoreWithMeta) Update(e event.UpdateEvent) bool

Update implements Predicate

type ReconcileCDI

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

ReconcileCDI reconciles a CDI object

func (*ReconcileCDI) Reconcile

func (r *ReconcileCDI) Reconcile(request reconcile.Request) (reconcile.Result, error)

Reconcile reads that state of the cluster for a CDI object and makes changes based on the state read and what is in the CDI.Spec Note: The Controller will requeue the Request to be processed again if the returned error is non-nil or Result.Requeue is true, otherwise upon completion it will remove the work from the queue.

type ReconcileCallback

type ReconcileCallback func(args *ReconcileCallbackArgs) error

ReconcileCallback is the callback function

type ReconcileCallbackArgs

type ReconcileCallbackArgs struct {
	Logger    logr.Logger
	Client    client.Client
	Scheme    *runtime.Scheme
	Namespace string
	Resource  *cdiv1alpha1.CDI

	State         ReconcileState
	DesiredObject runtime.Object
	CurrentObject runtime.Object
}

ReconcileCallbackArgs contains the data of a ReconcileCallback

type ReconcileState

type ReconcileState string

ReconcileState is the current state of the reconcile for a particuar resource

const (
	// ReconcileStatePreCreate is the state before a resource is created
	ReconcileStatePreCreate ReconcileState = "PRE_CREATE"
	// ReconcileStatePostCreate is the state sfter a resource is created
	ReconcileStatePostCreate ReconcileState = "POST_CREATE"

	// ReconcileStatePostRead is the state sfter a resource is read
	ReconcileStatePostRead ReconcileState = "POST_READ"

	// ReconcileStatePreUpdate is the state before a resource is updated
	ReconcileStatePreUpdate ReconcileState = "PRE_UPDATE"
	// ReconcileStatePostUpdate is the state after a resource is updated
	ReconcileStatePostUpdate ReconcileState = "POST_UPDATE"

	// ReconcileStatePreDelete is the state before a resource is explicitly deleted (probably during upgrade)
	// don't count on this always being called for your resource
	// ideally we just let garbage collection do it's thing
	ReconcileStatePreDelete ReconcileState = "PRE_DELETE"
	// ReconcileStatePostDelete is the state after a resource is explicitly deleted (probably during upgrade)
	// don't count on this always being called for your resource
	// ideally we just let garbage collection do it's thing
	ReconcileStatePostDelete ReconcileState = "POST_DELETE"

	// ReconcileStateCDIDelete is called during CDI finalizer
	ReconcileStateCDIDelete ReconcileState = "CDI_DELETE"
)