managedgeneric

Documentation

Index

• func ControllerName(kind string) string
• type ConnectionDetails
• type ExternalClient
• type ExternalClientFns
  • func (e ExternalClientFns) Close()
  • func (e ExternalClientFns) Create(ctx context.Context, mg resource.Managed) error
  • func (e ExternalClientFns) Delete(ctx context.Context, mg resource.Managed) error
  • func (e ExternalClientFns) Observe(ctx context.Context, mg resource.Managed) (ExternalObservation, error)
• type ExternalConnecter
• type ExternalConnectorFn
  • func (ec ExternalConnectorFn) Connect(ctx context.Context, mg resource.Managed) (ExternalClient, error)
• type ExternalObservation
• type NopClient
  • func (c *NopClient) Close()
  • func (c *NopClient) Create(ctx context.Context, mg resource.Managed) error
  • func (c *NopClient) Delete(ctx context.Context, mg resource.Managed) error
  • func (c *NopClient) Observe(ctx context.Context, mg resource.Managed) (ExternalObservation, error)
• type NopConnecter
  • func (c *NopConnecter) Connect(_ context.Context, _ resource.Managed) (ExternalClient, error)
• type Reconciler
  • func NewReconciler(m manager.Manager, of resource.ManagedKind, o ...ReconcilerOption) *Reconciler
  • func (r *Reconciler) Reconcile(_ context.Context, req reconcile.Request) (reconcile.Result, error)
• type ReconcilerOption
  • func WithExternalConnecter(c ExternalConnecter) ReconcilerOption
  • func WithFinalizer(f resource.Finalizer) ReconcilerOption
  • func WithLogger(l logging.Logger) ReconcilerOption
  • func WithParser(l logging.Logger) ReconcilerOption
  • func WithPollInterval(after time.Duration) ReconcilerOption
  • func WithRecorder(er event.Recorder) ReconcilerOption
  • func WithTimeout(duration time.Duration) ReconcilerOption

Functions

func ControllerName

func ControllerName(kind string) string

ControllerName returns the recommended name for controllers that use this package to reconcile a particular kind of managed resource.

Types

type ConnectionDetails

type ConnectionDetails map[string][]byte

ConnectionDetails created or updated during an operation on an external resource, for example usernames, passwords, endpoints, ports, etc.

type ExternalClient

type ExternalClient interface {
	// Observe the external resource the supplied Managed resource represents,
	// if any. Observe implementations must not modify the external resource,
	// but may update the supplied Managed resource to reflect the state of the
	// external resource.
	Observe(ctx context.Context, mg resource.Managed) (ExternalObservation, error)

	// Create an external resource per the specifications of the supplied
	// Managed resource. Called when thr diff reports that the associated
	// external resource does not exist.
	Create(ctx context.Context, mg resource.Managed) error

	// Delete the external resource upon deletion of its associated Managed
	// resource. Called when the managed resource has been deleted.
	Delete(ctx context.Context, mg resource.Managed) error

	// Close the gnmi connection to the system proxy cache
	Close()
}

An ExternalClient manages the lifecycle of an external resource. None of the calls here should be blocking. All of the calls should be idempotent. For example, Create call should not return AlreadyExists error if it's called again with the same parameters or Delete call should not return error if there is an ongoing deletion or resource does not exist.

type ExternalClientFns

type ExternalClientFns struct {
	ObserveFn func(ctx context.Context, mg resource.Managed) (ExternalObservation, error)
	CreateFn  func(ctx context.Context, mg resource.Managed) error
	//UpdateFn           func(ctx context.Context, mg resource.ManagedGeneric, obs ExternalObservation) error
	DeleteFn func(ctx context.Context, mg resource.Managed) error
	//GetSystemConfigFn  func(ctx context.Context, mg resource.ManagedGeneric) (*ygotnddp.Device, error)
	//GetRunningConfigFn func(ctx context.Context, mg resource.ManagedGeneric) ([]byte, error)
	CloseFn func()
}

ExternalClientFns are a series of functions that satisfy the ExternalClient interface.

func (ExternalClientFns) Close

func (e ExternalClientFns) Close()

GetResourceName returns the resource matching the path

func (ExternalClientFns) Create

func (e ExternalClientFns) Create(ctx context.Context, mg resource.Managed) error

Create an external resource per the specifications of the supplied Managed resource.

func (ExternalClientFns) Delete

func (e ExternalClientFns) Delete(ctx context.Context, mg resource.Managed) error

Delete the external resource upon deletion of its associated Managed resource.

func (ExternalClientFns) Observe

func (e ExternalClientFns) Observe(ctx context.Context, mg resource.Managed) (ExternalObservation, error)

Observe the external resource the supplied Managed resource represents, if any.

type ExternalConnecter

type ExternalConnecter interface {
	// Connect to the provider specified by the supplied managed resource and
	// produce an ExternalClient.
	Connect(ctx context.Context, mg resource.Managed) (ExternalClient, error)
}

An ExternalConnecter produces a new ExternalClient given the supplied Managed resource.

type ExternalConnectorFn

type ExternalConnectorFn func(ctx context.Context, mg resource.Managed) (ExternalClient, error)

An ExternalConnectorFn is a function that satisfies the ExternalConnecter interface.

func (ExternalConnectorFn) Connect

func (ec ExternalConnectorFn) Connect(ctx context.Context, mg resource.Managed) (ExternalClient, error)

Connect to the provider specified by the supplied managed resource and produce an ExternalClient.

type ExternalObservation

type ExternalObservation struct {
	// HasData can be true when a managed resource is created, but the
	// device had already data in that resource. The data needs to get aligned
	// with the intended MGR data
	Exists bool
	// IsUpToDate should be true if the corresponding MGR
	// appears to be up-to-date with the cr spec
	IsUpToDate bool
}

An ExternalObservation is the result of an observation of an external resource.

type NopClient

type NopClient struct{}

A NopClient does nothing.

func (*NopClient) Close

func (c *NopClient) Close()

func (*NopClient) Create

func (c *NopClient) Create(ctx context.Context, mg resource.Managed) error

Create does nothing. It returns an empty ExternalCreation and no error.

func (*NopClient) Delete

func (c *NopClient) Delete(ctx context.Context, mg resource.Managed) error

Delete does nothing. It never returns an error.

func (*NopClient) Observe

func (c *NopClient) Observe(ctx context.Context, mg resource.Managed) (ExternalObservation, error)

Observe does nothing. It returns an empty ExternalObservation and no error.

type NopConnecter

type NopConnecter struct{}

A NopConnecter does nothing.

func (*NopConnecter) Connect

func (c *NopConnecter) Connect(_ context.Context, _ resource.Managed) (ExternalClient, error)

Connect returns a NopClient. It never returns an error.

type Reconciler

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

A Reconciler reconciles managed resources by creating and managing the lifecycle of an external resource, i.e. a resource in an external network device through an API. Each controller must watch the managed resource kind for which it is responsible.

func NewReconciler

func NewReconciler(m manager.Manager, of resource.ManagedKind, o ...ReconcilerOption) *Reconciler

NewReconciler returns a Reconciler that reconciles managed resources of the supplied ManagedKind with resources in an external network device. It panics if asked to reconcile a managed resource kind that is not registered with the supplied manager's runtime.Scheme. The returned Reconciler reconciles with a dummy, no-op 'external system' by default; callers should supply an ExternalConnector that returns an ExternalClient capable of managing resources in a real system.

func (*Reconciler) Reconcile

func (r *Reconciler) Reconcile(_ context.Context, req reconcile.Request) (reconcile.Result, error)

Reconcile a managed resource with an external resource.

type ReconcilerOption

type ReconcilerOption func(*Reconciler)

A ReconcilerOption configures a Reconciler.

func WithExternalConnecter

func WithExternalConnecter(c ExternalConnecter) ReconcilerOption

WithExternalConnecter specifies how the Reconciler should connect to the API used to sync and delete external resources.

func WithFinalizer

func WithFinalizer(f resource.Finalizer) ReconcilerOption

WithFinalizer specifies how the Reconciler should add and remove finalizers to and from the managed resource.

func WithLogger

func WithLogger(l logging.Logger) ReconcilerOption

WithLogger specifies how the Reconciler should log messages.

func WithParser

func WithParser(l logging.Logger) ReconcilerOption

func WithPollInterval

func WithPollInterval(after time.Duration) ReconcilerOption

WithPollInterval specifies how long the Reconciler should wait before queueing a new reconciliation after a successful reconcile. The Reconciler requeues after a specified duration when it is not actively waiting for an external operation, but wishes to check whether an existing external resource needs to be synced to its ndd Managed resource.

func WithRecorder

func WithRecorder(er event.Recorder) ReconcilerOption

WithRecorder specifies how the Reconciler should record events.

func WithTimeout

func WithTimeout(duration time.Duration) ReconcilerOption

WithTimeout specifies the timeout duration cumulatively for all the calls happen in the reconciliation function. In case the deadline exceeds, reconciler will still have some time to make the necessary calls to report the error such as status update.