sync

Documentation

Index

• func RemoteNameForLocalObject(localObj ctrlruntimeclient.Object) *reconcile.Request
• type Context
  • func NewContext(local, remote context.Context) Context
• type ObjectStateStore
• type ResourceSyncer
  • func NewResourceSyncer(log *zap.SugaredLogger, localClient ctrlruntimeclient.Client, ...) (*ResourceSyncer, error)
  • func (s *ResourceSyncer) Process(ctx Context, remoteObj *unstructured.Unstructured) (requeue bool, err error)

Functions

func RemoteNameForLocalObject

func RemoteNameForLocalObject(localObj ctrlruntimeclient.Object) *reconcile.Request

Types

type Context

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

func NewContext

func NewContext(local, remote context.Context) Context

type ObjectStateStore

type ObjectStateStore interface {
	Get(source syncSide) (*unstructured.Unstructured, error)
	Put(obj *unstructured.Unstructured, clusterName string, subresources []string) error
}

type ResourceSyncer

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

func NewResourceSyncer

func NewResourceSyncer(
	log *zap.SugaredLogger,
	localClient ctrlruntimeclient.Client,
	remoteClient ctrlruntimeclient.Client,
	pubRes *syncagentv1alpha1.PublishedResource,
	localCRD *apiextensionsv1.CustomResourceDefinition,
	remoteAPIGroup string,
	mutator mutation.Mutator,
	stateNamespace string,
) (*ResourceSyncer, error)

func (*ResourceSyncer) Process

func (s *ResourceSyncer) Process(ctx Context, remoteObj *unstructured.Unstructured) (requeue bool, err error)

Process is the primary entrypoint for object synchronization. This function will create/update the local primary object (i.e. the copy of the remote object), sync any local status back to the remote object and then also synchronize all related resources. It also handles object deletion and will clean up the local objects when a remote object is gone. Each of these steps can potentially end the current processing and return (true, nil). In this case, the caller should re-fetch the remote object and call Process() again (most likely in the next reconciliation). Only when (false, nil) is returned is the entire process finished.