federate

Documentation

Overview

Package federate provides an interface that abstracts the distribution of Kubernetes resources.

Index

• Constants
• type Federator
  • func NewNoopFederator() Federator
  • func NewUpdateFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, ...) Federator
  • func NewUpdateStatusFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, ...) Federator
• type FederatorExt
  • func NewCreateFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, ...) FederatorExt
  • func NewCreateOrUpdateFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, ...) FederatorExt
• type UpdateFn

Constants

const ClusterIDLabelKey = "submariner-io/clusterID"

ClusterIDLabelKey is the key for a label that may be added to federated resources to hold the ID of the cluster from which the resource originated, allowing for filtering of resources emanating from the originating cluster.

Types

type Federator

type Federator interface {
	// Distribute distributes the given resource to all federated clusters.
	// The actual distribution may occur asynchronously in which case any returned error only indicates that the request
	// failed.
	//
	// If the resource was previously distributed and the given resource differs, each previous cluster will receive the
	// updated resource.
	Distribute(ctx context.Context, resource runtime.Object) error

	// Delete stops distributing the given resource and deletes it from all clusters to which it was distributed.
	// The actual deletion may occur asynchronously in which any returned error only indicates that the request
	// failed.
	Delete(ctx context.Context, resource runtime.Object) error
}

Federator provides methods for accessing federated resources.

func NewNoopFederator

func NewNoopFederator() Federator

func NewUpdateFederator

func NewUpdateFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, targetNamespace string, update UpdateFn) Federator

func NewUpdateStatusFederator

func NewUpdateStatusFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, targetNamespace string) Federator

type FederatorExt

type FederatorExt interface {
	Federator

	LogEvents(withName string)
}

func NewCreateFederator

func NewCreateFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, targetNamespace string) FederatorExt

func NewCreateOrUpdateFederator

func NewCreateOrUpdateFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, targetNamespace,
	localClusterID string, keepMetadataField ...string,
) FederatorExt

type UpdateFn

type UpdateFn func(oldObj *unstructured.Unstructured, newObj *unstructured.Unstructured) *unstructured.Unstructured