sentinel

type DefaultSentinelAction[k8sObject client.Object] struct {
	controller.ReconcilerAction
	// contains filtered or unexported fields
}

type DefaultSentinelActionWithDiff[k8sObject client.Object] struct {
	*DefaultSentinelAction[k8sObject]
}

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

type DefaultSentinelReconciler[k8sObject client.Object] struct {
	controller.Reconciler
}

type SentinelRead interface {
	// GetAllCurrentObjects premit to get the map of current objects, mapped by type
	GetReads() map[string]multiphase.MultiPhaseRead[client.Object]

	// SetCurrentObjects will add object on the right list
	SetCurrentObjects(objects []client.Object)

	// AddCurrentObject will add object on the right list
	AddCurrentObject(o client.Object)

	// AddExpectedObject will add object on the right list
	AddExpectedObject(o client.Object)

	// SetExpectedObjects will add object on the right list
	SetExpectedObjects(objects []client.Object)
}

type SentinelReconciler[k8sObject client.Object] interface {
	controller.Reconciler

	// Reconcile permit to orchestrate all phase needed to successfully reconcile the object
	Reconcile(ctx context.Context, req reconcile.Request, o k8sObject, data map[string]interface{}, reconciler SentinelReconcilerAction[k8sObject]) (res reconcile.Result, err error)
}

type SentinelReconcilerAction[k8sObject client.Object] interface {
	controller.ReconcilerAction

	// Configure permit to init external provider driver (API client REST)
	// It can also permit to init condition on status
	Configure(ctx context.Context, req reconcile.Request, o k8sObject, data map[string]any, logger *logrus.Entry) (res reconcile.Result, err error)

	// Read permit to read the actual resource state from provider and set it on data map
	Read(ctx context.Context, o k8sObject, data map[string]any, logger *logrus.Entry) (read SentinelRead, res reconcile.Result, err error)

	// Apply permit to apply resources on kubernetes using Server-Side Apply
	Apply(ctx context.Context, o k8sObject, data map[string]any, objects []client.Object, logger *logrus.Entry) (res reconcile.Result, err error)

	// Delete permit to delete resources on kubernetes
	Delete(ctx context.Context, o k8sObject, data map[string]any, objects []client.Object, logger *logrus.Entry) (res reconcile.Result, err error)

	// OnError is call when error is throwing
	// It the right way to set status condition when error
	OnError(ctx context.Context, o k8sObject, data map[string]any, currentErr error, logger *logrus.Entry) (res reconcile.Result, err error)

	// OnSuccess is call at the end if no error
	// It's the right way to set status condition when everything is good
	OnSuccess(ctx context.Context, o k8sObject, data map[string]any, diff multiphase.MultiPhaseDiff[client.Object], logger *logrus.Entry) (res reconcile.Result, err error)

	// Diff permit to compare the actual state and the expected state.
	// The simple variant always uses always-apply classification: all expected objects
	// with current counterparts go to the update list (legacy always-apply).
	Diff(ctx context.Context, o k8sObject, read SentinelRead, data map[string]any, logger *logrus.Entry) (diff multiphase.MultiPhaseDiff[client.Object], res reconcile.Result, err error)

	// GetFieldManager returns the field manager name for SSA
	GetFieldManager() string
}

type SentinelReconcilerActionWithDiff[k8sObject client.Object] interface {
	SentinelReconcilerAction[k8sObject]

	// OnDiff is called between Diff and Apply, after the diff has been computed.
	// The diff variant always uses SSA dry-run classification. The default implementation
	// returns nil (safe no-op); override it to run pre-apply tasks.
	OnDiff(ctx context.Context, o k8sObject, data map[string]any, diff multiphase.MultiPhaseDiff[client.Object], logger *logrus.Entry) (res reconcile.Result, err error)
}