lifecycle

package

v0.37.0 Latest Latest Go to latest Published: May 28, 2024 License: Apache-2.0 Imports: 24 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/openmfp/golang-commons

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type LifecycleManager
- func NewLifecycleManager(log *logger.Logger, operatorName string, controllerName string, ...) *LifecycleManager
type RuntimeObject
type RuntimeObjectConditions
type RuntimeObjectSpreadReconcileStatus
- func MustToRuntimeObjectSpreadReconcileStatusInterface(instance RuntimeObject, log *logger.Logger) RuntimeObjectSpreadReconcileStatus
type Subroutine

Constants ¶

View Source

const (
	ConditionReady = "Ready"
)

View Source

const SpreadReconcileRefreshLabel = "openmfp.io/refresh-reconcile"

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type LifecycleManager ¶

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

func NewLifecycleManager ¶

func NewLifecycleManager(log *logger.Logger, operatorName string, controllerName string, client client.Client, subroutines []Subroutine) *LifecycleManager

func (*LifecycleManager) Reconcile ¶

func (l *LifecycleManager) Reconcile(ctx context.Context, req ctrl.Request, instance RuntimeObject) (ctrl.Result, error)

func (*LifecycleManager) SetupWithManager ¶

func (l *LifecycleManager) SetupWithManager(mgr ctrl.Manager, maxReconciles int, reconcilerName string, instance RuntimeObject, debugLabelValue string, r reconcile.Reconciler, log *logger.Logger, eventPredicates ...predicate.Predicate) error

func (*LifecycleManager) WithConditionManagement ¶ added in v0.21.0

func (l *LifecycleManager) WithConditionManagement() *LifecycleManager

func (*LifecycleManager) WithSpreadingReconciles ¶ added in v0.5.0

func (l *LifecycleManager) WithSpreadingReconciles() *LifecycleManager

WithSpreadingReconciles sets the LifecycleManager to spread out the reconciles

type RuntimeObject ¶

type RuntimeObject interface {
	runtime.Object
	v1.Object
}

type RuntimeObjectConditions ¶ added in v0.21.0

type RuntimeObjectConditions interface {
	GetConditions() []metav1.Condition
	SetConditions([]metav1.Condition)
}

type RuntimeObjectSpreadReconcileStatus ¶ added in v0.5.0

type RuntimeObjectSpreadReconcileStatus interface {
	GetGeneration() int64
	GetObservedGeneration() int64
	SetObservedGeneration(int64)
	GetNextReconcileTime() v1.Time
	SetNextReconcileTime(time v1.Time)
}

func MustToRuntimeObjectSpreadReconcileStatusInterface ¶ added in v0.29.0

func MustToRuntimeObjectSpreadReconcileStatusInterface(instance RuntimeObject, log *logger.Logger) RuntimeObjectSpreadReconcileStatus

type Subroutine ¶

type Subroutine interface {
	Process(ctx context.Context, instance RuntimeObject) (ctrl.Result, errors.OperatorError)
	Finalize(ctx context.Context, instance RuntimeObject) (ctrl.Result, errors.OperatorError)
	GetName() string
	Finalizers() []string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mocks

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL