kubebuilderx

type CheckResult struct {
	Satisfied bool
	Err       error
}

type Controller interface {
	// Prepare loads the object tree from Kubernetes.
	Prepare(TreeLoader) Controller

	// Do is the computation phase. It contains the business logic and modifies the object tree.
	Do(...Reconciler) Controller

	// Commit is the plan execution phase. It computes the difference between
	// the old and new object trees, and applies the difference to Kubernetes.
	Commit() (ctrl.Result, error)
}

type ObjectOption interface {
	ApplyToObject(*ObjectOptions)
}

type ObjectOptions struct {
	// if not empty, action should be done on the specified subresource
	SubResource string

	// if true, the object should not be reconciled
	SkipToReconcile bool
}

type ObjectTree struct {
	// TODO(free6om): should find a better place to hold these two params?
	context.Context
	record.EventRecorder
	logr.Logger
	// contains filtered or unexported fields
}

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

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

type Reconciler interface {
	// PreCondition should return ConditionSatisfied if Reconcile() should be invoked,
	// otherwise return ConditionUnsatisfied.
	PreCondition(*ObjectTree) *CheckResult

	// Reconcile contains the business logic and modifies the object tree.
	Reconcile(tree *ObjectTree) (Result, error)
}

type Result struct {
	Next       controlMethod
	RetryAfter time.Duration
}

type SkipToReconcile bool

type TreeLoader interface {
	Load(context.Context, client.Reader, ctrl.Request, record.EventRecorder, logr.Logger) (*ObjectTree, error)
}

type WithSubResource string