reconcile

Documentation

Overview

Package reconcile defines the Reconciler interface; Reconciler is provided to Controllers at creation time as the API implementation.

The implementation is derived from sigs.k8s.io/controller-runtime/pkg/reconcile and the main difference is that Reconciler and Request are resourceGroup aware.

Index

• type Reconciler
• type Request
  • func (r Request) String() string
• type Result

Types

type Reconciler

type Reconciler interface {
	// Reconcile performs a full reconciliation for the resource referred to by the Request.
	// The Controller will requeue the Request to be processed again if an error is non-nil or
	// Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
	Reconcile(context.Context, Request) (Result, error)
}

Reconciler is provided to Controllers at creation time as the API implementation.

type Request

type Request struct {
	ResourceGroup string
	types.NamespacedName
}

Request contains the information necessary to reconcile a resource. This includes the information to uniquely identify the resource - the resourceGroup it belongs to, its Name and Namespace.

func (Request) String

func (r Request) String() string

type Result

type Result = reconcile.Result

Result contains the result of a Reconciler invocation.