broker

Documentation

Index

• func BuildBrokerConfigFromEnv(useTokenCAForEndpoint bool) (*rest.Config, string, error)
• func NewFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, ...) federate.Federator
• type ResourceConfig
• type Syncer
  • func NewSyncer(config SyncerConfig) (*Syncer, error)
  • func NewSyncerWithDetail(config *SyncerConfig, localClient, brokerClient dynamic.Interface, ...) (*Syncer, error)
  • func (s *Syncer) GetBrokerFederator() federate.Federator
  • func (s *Syncer) Start(stopCh <-chan struct{}) error
• type SyncerConfig

Functions

func BuildBrokerConfigFromEnv

func BuildBrokerConfigFromEnv(useTokenCAForEndpoint bool) (*rest.Config, string, error)

func NewFederator

func NewFederator(dynClient dynamic.Interface, restMapper meta.RESTMapper, brokerNamespace,
	localClusterID string) federate.Federator

Types

type ResourceConfig

type ResourceConfig struct {
	// SourceNamespace the namespace in the local source from which to retrieve the local resources to sync.
	LocalSourceNamespace string

	// LocalResourceType the type of the local resources to sync to the broker.
	LocalResourceType runtime.Object

	// LocalTransform function used to transform a local resource to the equivalent broker resource.
	LocalTransform syncer.TransformFunc

	// OnSuccessfulSync function invoked after a successful sync operation.
	LocalOnSuccessfulSync syncer.OnSuccessfulSyncFunc

	// LocalResourcesEquivalent function to compare two local resources for equivalence. See ResourceSyncerConfig.ResourcesEquivalent
	// for more details.
	LocalResourcesEquivalent syncer.ResourceEquivalenceFunc

	// BrokerResourceType the type of the broker resources to sync to the local source.
	BrokerResourceType runtime.Object

	// BrokerTransform function used to transform a broker resource to the equivalent local resource.
	BrokerTransform syncer.TransformFunc

	// BrokerResourcesEquivalent function to compare two broker resources for equivalence. See ResourceSyncerConfig.ResourcesEquivalent
	// for more details.
	BrokerResourcesEquivalent syncer.ResourceEquivalenceFunc
}

type Syncer

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

func NewSyncer

func NewSyncer(config SyncerConfig) (*Syncer, error)

NewSyncer creates a Syncer that performs bi-directional syncing of resources between a local source and a central broker.

func NewSyncerWithDetail

func NewSyncerWithDetail(config *SyncerConfig, localClient, brokerClient dynamic.Interface, restMapper meta.RESTMapper) (*Syncer, error)

NewSyncerWithDetail creates a Syncer with given additional detail. This function is intended for unit tests.

func (*Syncer) GetBrokerFederator

func (s *Syncer) GetBrokerFederator() federate.Federator

func (*Syncer) Start

func (s *Syncer) Start(stopCh <-chan struct{}) error

type SyncerConfig

type SyncerConfig struct {
	// LocalRestConfig the REST config used to access the local resources to sync.
	LocalRestConfig *rest.Config

	// LocalNamespace the namespace in the local source to which resources from the broker will be synced.
	LocalNamespace string

	// LocalClusterID the ID of the local cluster. This is used to avoid loops when syncing the same resources between
	// the local and broker sources. If local resources are transformed to different broker resource types then
	// specify an empty LocalClusterID to disable this loop protection.
	LocalClusterID string

	// BrokerRestConfig the REST config used to access the broker resources to sync. If not specified, the config is
	// built from environment variables via BuildBrokerConfigFromEnv.
	BrokerRestConfig *rest.Config

	// BrokerNamespace the namespace in the broker to which resources from the local source will be synced. If not
	// specified, the namespace is obtained from an environment variable via BuildBrokerConfigFromEnv.
	BrokerNamespace string

	// ResourceConfigs the configurations for resources to sync
	ResourceConfigs []ResourceConfig

	// Scheme used to convert resource objects. By default the global k8s Scheme is used.
	Scheme *runtime.Scheme
}