operatingsystemconfig

type Actuator interface {
	// Reconcile reconciles the [extensionsv1alpha1.OperatingSystemConfig]
	// resource.
	//
	// Implementations should ensure that any resources (e.g. systemd units,
	// files, etc.) are created or updated in order to reach their desired
	// state.
	Reconcile(context.Context, logr.Logger, *extensionsv1alpha1.OperatingSystemConfig) ([]byte, []extensionsv1alpha1.Unit, []extensionsv1alpha1.File, *extensionsv1alpha1.InPlaceUpdatesStatus, error)

	// Delete is invoked when the [extensionsv1alpha1.OperatingSystemConfig]
	// resource is deleted.
	//
	// Implementations should take care of cleaning up any resources
	// (e.g. systemd units, files, etc.), which were created by the
	// Extension.
	//
	// Implementations must wait until all resources managed by the
	// extension have been gracefully cleaned up.
	Delete(context.Context, logr.Logger, *extensionsv1alpha1.OperatingSystemConfig) error

	// ForceDelete is invoked when the shoot cluster associated with the
	// [extensionsv1alpha1.OperatingSystemConfig] is deleted in a forceful
	// manner.
	//
	// Implementations should take care of unblocking the deletion flow by
	// attempting to cleanup any related resources, and skip waiting for
	// external resources, if they cannot be deleted gracefully.
	//
	// If some resources managed by the extension implementation cannot be
	// deleted gracefully, this method should still succeed, even if some
	// resources are orphaned.
	ForceDelete(context.Context, logr.Logger, *extensionsv1alpha1.OperatingSystemConfig) error

	// Restore restores the operating system config from a previously saved
	// state.
	//
	// This method is invoked when the shoot cluster associated with the
	// [extensionsv1alpha1.OperatingSystemConfig] resource is being restored
	// on the target seed cluster.
	//
	// Implementations may use the persisted data in the .status.state field
	// for restoring the state, when the shoot is being migrated to a
	// different seed cluster.
	Restore(context.Context, logr.Logger, *extensionsv1alpha1.OperatingSystemConfig) ([]byte, []extensionsv1alpha1.Unit, []extensionsv1alpha1.File, *extensionsv1alpha1.InPlaceUpdatesStatus, error)

	// Migrate prepares the extension for migration.
	//
	// This method is invoked when the shoot cluster associated with the
	// [extensionsv1alpha1.OperatingSystemResource] resource is being
	// migrated to another seed cluster.
	//
	// Implementations should take care of storing any required state in the
	// .status.state field, so that it can later be restored from this
	// state.
	Migrate(context.Context, logr.Logger, *extensionsv1alpha1.OperatingSystemConfig) error
}

type AddArgs struct {
	// Actuator is an OperatingSystemConfig actuator.
	Actuator Actuator
	// ControllerOptions are the controller options used for creating a controller.
	// The options.Reconciler is always overridden with a reconciler created from the
	// given actuator.
	ControllerOptions controller.Options
	// Predicates are the predicates to use.
	// If unset, GenerationChangedPredicate will be used.
	Predicates []predicate.Predicate
	// Types are the similar types which can be combined with a logic or,
	// of the resource considered for reconciliation.
	Types []string
	// ExtensionClasses defines the extension classes this controller is responsible for.
	ExtensionClasses []extensionsv1alpha1.ExtensionClass
}