syncer

Documentation

Index

• type Interface
  • func NewResourceSyncer(config *ResourceSyncerConfig) (Interface, error)
• type Operation
  • func (o Operation) String() string
• type ResourceSyncerConfig
• type SyncDirection
• type TransformFunc

Types

type Interface

type Interface interface {
	Start(stopCh <-chan struct{}) error
}

func NewResourceSyncer

func NewResourceSyncer(config *ResourceSyncerConfig) (Interface, error)

type Operation

type Operation int

const (
	Create Operation = iota
	Update
	Delete
)

func (Operation) String

func (o Operation) String() string

type ResourceSyncerConfig

type ResourceSyncerConfig struct {
	// Name of this syncer used for logging.
	Name string

	// SourceClient the client used to obtain the resources to sync.
	SourceClient dynamic.Interface

	// SourceNamespace the namespace of the resources to sync.
	SourceNamespace string

	// LocalClusterID the cluster ID of the source client. This is used in conjunction with Direction to avoid
	// loops when syncing the same resources between the local and remote sources.
	LocalClusterID string

	// Direction specifies how resources are synced. It is assumed that resources emanating from a remote source have
	// the cluster ID label specified by federate.ClusterIDLabelKey set appropriately. If set to LocalToRemote, only
	// resources that do not have a cluster ID label are synced. This avoids re-syncing non-local resources. If set to
	// RemoteToLocal, resources whose cluster ID label matches LocalClusterID are not synced. This avoids syncing
	// local resources from the remote source.
	Direction SyncDirection

	// RestMapper used to obtain GroupVersionResources.
	RestMapper meta.RESTMapper

	// Federator used to perform the syncing.
	Federator federate.Federator

	// ResourceType the type of the resources to sync.
	ResourceType runtime.Object

	// Transform function used to transform resources prior to syncing.
	Transform TransformFunc

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

type SyncDirection

type SyncDirection int

const (
	// Resources are synced from a local source to a remote source.
	LocalToRemote SyncDirection = iota

	// Resources are synced from a remote source to a local source.
	RemoteToLocal
)

type TransformFunc

type TransformFunc func(from runtime.Object, op Operation) (runtime.Object, bool)

TransformFunc is invoked prior to syncing to transform the resource or evaluate if it should be synced. If nil is returned, the resource is not synced and, if the second return value is true, the resource is re-queued to be retried later.