crud

Documentation

Index

• func IsInvalidConfig(err error) bool
• type Interface
• type Patch
  • func NewPatch() *Patch
  • func (p *Patch) SetCreateChange(create interface{})
  • func (p *Patch) SetDeleteChange(delete interface{})
  • func (p *Patch) SetUpdateChange(update interface{})
• type Resource
  • func NewResource(config ResourceConfig) (*Resource, error)
  • func (r *Resource) CRUD() Interface
  • func (r *Resource) EnsureCreated(ctx context.Context, obj interface{}) error
  • func (r *Resource) EnsureDeleted(ctx context.Context, obj interface{}) error
  • func (r *Resource) Name() string
• type ResourceConfig

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Interface

type Interface interface {
	// Name returns the resource's name used for identification.
	Name() string

	// GetCurrentState receives the custom object observed during custom
	// resource watches. Its purpose is to return the current state of the
	// resources being managed by the operator. This can e.g. be some
	// actual data within a configmap as provided by the Kubernetes API.
	// This is not limited to Kubernetes resources though. Another example
	// would be to fetch and return information about Flannel bridges.
	//
	// NOTE GetCurrentState is called on create, delete and update events. When
	// called on create and delete events the provided custom object will be the
	// custom object currently known to the informer. On update events the
	// informer knows about the old and the new custom object. GetCurrentState
	// then receives the new custom object to be able to consume the current state
	// of a system.
	GetCurrentState(ctx context.Context, obj interface{}) (interface{}, error)
	// GetDesiredState receives the custom object observed during custom
	// resource watches. Its purpose is to return the desired state of the
	// resources being managed by the operator. The desired state should
	// always be able to be made up using the information provided by the
	// custom object. This can e.g. be some data within a configmap, how it
	// should be provided by the Kubernetes API. This is not limited to
	// Kubernetes resources though. Another example would be to make up and
	// return information about Flannel bridges, how they should look like
	// on a server host.
	//
	// NOTE GetDesiredState is called on create, delete and update events.
	// When called on create events the provided custom object will be the
	// custom object currently known to the informer. On update events the
	// informer knows about the old and the new custom object.
	// GetDesiredState then receives the new custom object to be able to
	// compute the desired state of a system.
	GetDesiredState(ctx context.Context, obj interface{}) (interface{}, error)

	// NewUpdatePatch is called upon observed custom object change. It receives
	// the observed custom object, the current state as provided by
	// GetCurrentState and the desired state as provided by
	// GetDesiredState. NewUpdatePatch analyses the current and desired
	// state and returns the patch to be applied by Create, Delete, and
	// Update functions. ApplyCreateChange, ApplyDeleteChange, and
	// ApplyUpdateChange are called only when the corresponding patch part
	// was created.
	NewUpdatePatch(ctx context.Context, obj, currentState, desiredState interface{}) (*Patch, error)
	// NewDeletePatch is called upon observed custom object deletion. It
	// receives the deleted custom object, the current state as provided by
	// GetCurrentState and the desired state as provided by
	// GetDesiredState. NewDeletePatch analyses the current and desired
	// state returns the patch to be applied by Create, Delete, and Update
	// functions. ApplyCreateChange, ApplyDeleteChange, and
	// ApplyUpdateChange are called only when the corresponding patch part
	// was created.
	NewDeletePatch(ctx context.Context, obj, currentState, desiredState interface{}) (*Patch, error)

	// ApplyCreateChange receives the new custom object observed during
	// custom resource watches. It also receives the create portion of the
	// Patch provided by NewUpdatePatch or NewDeletePatch.
	// ApplyCreateChange only has to create resources based on its provided
	// input. All other reconciliation logic and state transformation is
	// already done at this point of the reconciliation loop.
	ApplyCreateChange(ctx context.Context, obj, createChange interface{}) error
	// ApplyDeleteChange receives the new custom object observed during
	// custom resource watches. It also receives the delete portion of the
	// Patch provided by NewUpdatePatch or NewDeletePatch.
	// ApplyDeleteChange only has to delete resources based on its provided
	// input. All other reconciliation logic and state transformation is
	// already done at this point of the reconciliation loop.
	ApplyDeleteChange(ctx context.Context, obj, deleteChange interface{}) error
	// ApplyUpdateChange receives the new custom object observed during
	// custom resource watches. It also receives the update portion of the
	// Patch provided by NewUpdatePatch or NewDeletePatch.
	// ApplyUpdateChange has to update resources based on its provided
	// input. All other reconciliation logic and state transformation is
	// already done at this point of the reconciliation loop.
	ApplyUpdateChange(ctx context.Context, obj, updateChange interface{}) error
}

Interface provides set of building blocks of a CRUD Resource business logic being reconciled when observing runtime objects. The interface provides a guideline for an easier way to follow the rather complex intentions of operators' reconciliation in general.

type Patch

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

Patch is a set of information required in order to reconcile the current state towards the desired state. Patch is split into three parts: create, delete and update changes. The parts are passed as arguments to the CRUD Resource's ApplyCreateChange, ApplyDeleteChange and ApplyUpdateChange functions respectively. Patch changes are guaranteed to be applied in that order (i.e. create, update, delete).

func NewPatch

func NewPatch() *Patch

func (*Patch) SetCreateChange

func (p *Patch) SetCreateChange(create interface{})

func (*Patch) SetDeleteChange

func (p *Patch) SetDeleteChange(delete interface{})

func (*Patch) SetUpdateChange

func (p *Patch) SetUpdateChange(update interface{})

type Resource

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

Resource wraps Interface and allows the implemention of complex CRUD Resrouces in a structured way. The usual control flow primitives like canceling the resource itself or canceling the whole reconciliation loop are available. Further benefits are dedicated metrics for the several CRUD Resource steps defined by Interface when wrapped by the metricsresource package.

func NewResource

func NewResource(config ResourceConfig) (*Resource, error)

func (*Resource) CRUD

func (r *Resource) CRUD() Interface

CRUD is not part of the resource.Interface and should not be used. It is exposed for wrapping purposes in the wrapper package.

NOTE This method should not be used outside operatorkit.

func (*Resource) EnsureCreated

func (r *Resource) EnsureCreated(ctx context.Context, obj interface{}) error

func (*Resource) EnsureDeleted

func (r *Resource) EnsureDeleted(ctx context.Context, obj interface{}) error

func (*Resource) Name

func (r *Resource) Name() string

type ResourceConfig

type ResourceConfig struct {
	// CRUD is any CRUD Resource implementation wrapped and properly executed by
	// Resource.
	CRUD   Interface
	Logger micrologger.Logger
}