remote

Documentation

Overview

Package remote implements remote controllers.

Index

• Variables
• func DefaultClusterAPIUserAgent(sourceName string) string
• func NewClusterClient(ctx context.Context, sourceName string, c client.Client, ...) (client.Client, error)
• func RESTConfig(ctx context.Context, sourceName string, c client.Reader, ...) (*restclient.Config, error)
• type ClusterCacheReconciler
  • func (r *ClusterCacheReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)
  • func (r *ClusterCacheReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager, options controller.Options) error
• type ClusterCacheTracker
  • func NewClusterCacheTracker(manager ctrl.Manager, options ClusterCacheTrackerOptions) (*ClusterCacheTracker, error)
  • func NewTestClusterCacheTracker(log logr.Logger, cl client.Client, scheme *runtime.Scheme, ...) *ClusterCacheTracker
  • func (t *ClusterCacheTracker) GetClient(ctx context.Context, cluster client.ObjectKey) (client.Client, error)
  • func (t *ClusterCacheTracker) GetRESTConfig(ctc context.Context, cluster client.ObjectKey) (*rest.Config, error)
  • func (t *ClusterCacheTracker) Watch(ctx context.Context, input WatchInput) error
• type ClusterCacheTrackerOptions
• type ClusterClientGetter
• type Index
• type WatchInput
• type Watcher

Variables

var DefaultIndexes = []Index{nodeProviderIDIndex}

DefaultIndexes is the default list of indexes on a ClusterCacheTracker.

var ErrClusterLocked = errors.New("cluster is locked already")

ErrClusterLocked is returned in methods that require cluster-level locking if the cluster is already locked by another concurrent call.

Functions

func DefaultClusterAPIUserAgent

func DefaultClusterAPIUserAgent(sourceName string) string

DefaultClusterAPIUserAgent returns a User-Agent string built from static global vars.

func NewClusterClient

func NewClusterClient(ctx context.Context, sourceName string, c client.Client, cluster client.ObjectKey) (client.Client, error)

NewClusterClient returns a Client for interacting with a remote Cluster using the given scheme for encoding and decoding objects.

func RESTConfig

func RESTConfig(ctx context.Context, sourceName string, c client.Reader, cluster client.ObjectKey) (*restclient.Config, error)

RESTConfig returns a configuration instance to be used with a Kubernetes client.

Types

type ClusterCacheReconciler

type ClusterCacheReconciler struct {
	// Deprecated: this field is unused and will be dropped in an upcoming release.
	Log     logr.Logger
	Client  client.Client
	Tracker *ClusterCacheTracker

	// WatchFilterValue is the label value used to filter events prior to reconciliation.
	WatchFilterValue string
}

ClusterCacheReconciler is responsible for stopping remote cluster caches when the cluster for the remote cache is being deleted.

func (*ClusterCacheReconciler) Reconcile

func (r *ClusterCacheReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)

Reconcile reconciles Clusters and removes ClusterCaches for any Cluster that cannot be retrieved from the management cluster.

func (*ClusterCacheReconciler) SetupWithManager

func (r *ClusterCacheReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager, options controller.Options) error

type ClusterCacheTracker

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

ClusterCacheTracker manages client caches for workload clusters.

func NewClusterCacheTracker

func NewClusterCacheTracker(manager ctrl.Manager, options ClusterCacheTrackerOptions) (*ClusterCacheTracker, error)

NewClusterCacheTracker creates a new ClusterCacheTracker.

func NewTestClusterCacheTracker

func NewTestClusterCacheTracker(log logr.Logger, cl client.Client, scheme *runtime.Scheme, objKey client.ObjectKey, watchObjects ...string) *ClusterCacheTracker

NewTestClusterCacheTracker creates a new fake ClusterCacheTracker that can be used by unit tests with fake client.

func (*ClusterCacheTracker) GetClient

func (t *ClusterCacheTracker) GetClient(ctx context.Context, cluster client.ObjectKey) (client.Client, error)

GetClient returns a cached client for the given cluster.

func (*ClusterCacheTracker) GetRESTConfig

func (t *ClusterCacheTracker) GetRESTConfig(ctc context.Context, cluster client.ObjectKey) (*rest.Config, error)

GetRESTConfig returns a cached REST config for the given cluster.

func (*ClusterCacheTracker) Watch

func (t *ClusterCacheTracker) Watch(ctx context.Context, input WatchInput) error

Watch watches a remote cluster for resource events. If the watch already exists based on input.Name, this is a no-op.

type ClusterCacheTrackerOptions

type ClusterCacheTrackerOptions struct {
	// Log is the logger used throughout the lifecycle of caches.
	// Defaults to a no-op logger if it's not set.
	Log *logr.Logger

	// ClientUncachedObjects instructs the Client to never cache the following objects,
	// it'll instead query the API server directly.
	// Defaults to never caching ConfigMap and Secret if not set.
	ClientUncachedObjects []client.Object
	Indexes               []Index
}

ClusterCacheTrackerOptions defines options to configure a ClusterCacheTracker.

type ClusterClientGetter

type ClusterClientGetter func(ctx context.Context, sourceName string, c client.Client, cluster client.ObjectKey) (client.Client, error)

ClusterClientGetter returns a new remote client.

type Index

type Index struct {
	Object       client.Object
	Field        string
	ExtractValue client.IndexerFunc
}

Index is a helper to model the info passed to cache.IndexField.

type WatchInput

type WatchInput struct {
	// Name represents a unique watch request for the specified Cluster.
	Name string

	// Cluster is the key for the remote cluster.
	Cluster client.ObjectKey

	// Watcher is the watcher (controller) whose Reconcile() function will be called for events.
	Watcher Watcher

	// Kind is the type of resource to watch.
	Kind client.Object

	// EventHandler contains the event handlers to invoke for resource events.
	EventHandler handler.EventHandler

	// Predicates is used to filter resource events.
	Predicates []predicate.Predicate
}

WatchInput specifies the parameters used to establish a new watch for a remote cluster.

type Watcher

type Watcher interface {
	// Watch watches src for changes, sending events to eventHandler if they pass predicates.
	Watch(src source.Source, eventHandler handler.EventHandler, predicates ...predicate.Predicate) error
}

Watcher is a scoped-down interface from Controller that only knows how to watch.