ktoc

Documentation

Index

• Variables
• type KtoCSource
  • func NewKtoCSource(controller connector.ConnectController, syncer Syncer, ctx context.Context, ...) *KtoCSource
  • func (t *KtoCSource) BroadcastListener(stopCh <-chan struct{}, syncPeriod time.Duration)
  • func (t *KtoCSource) Delete(key string, _ interface{}) error
  • func (t *KtoCSource) Informer() cache.SharedIndexInformer
  • func (t *KtoCSource) Lock()
  • func (t *KtoCSource) Run(ch <-chan struct{})
  • func (t *KtoCSource) Unlock()
  • func (t *KtoCSource) Upsert(key string, raw interface{}) error
• type KtoCSyncer
  • func NewKtoCSyncer(controller connector.ConnectController, ...) *KtoCSyncer
  • func (s *KtoCSyncer) Lock()
  • func (s *KtoCSyncer) Run(ctx context.Context)
  • func (s *KtoCSyncer) Sync(rs []*connector.CatalogRegistration)
  • func (s *KtoCSyncer) Unlock()
• type SyncJob
  • func (job *SyncJob) GetDoneCh() <-chan struct{}
  • func (job *SyncJob) JobName() string
  • func (job *SyncJob) Run()
• type Syncer

Variables

var (
	ProtocolHTTP = constants.ProtocolHTTP
	ProtocolGRPC = constants.ProtocolGRPC
)

Types

type KtoCSource

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

KtoCSource implements controller.Resource to sync RegisteredInstances resource types from K8S.

func NewKtoCSource

func NewKtoCSource(controller connector.ConnectController,
	syncer Syncer,
	ctx context.Context,
	msgBroker *messaging.Broker,
	kubeClient kubernetes.Interface,
	discClient connector.ServiceDiscoveryClient) *KtoCSource

func (*KtoCSource) BroadcastListener

func (t *KtoCSource) BroadcastListener(stopCh <-chan struct{}, syncPeriod time.Duration)

BroadcastListener listens for broadcast messages from the message broker

func (*KtoCSource) Delete

func (t *KtoCSource) Delete(key string, _ interface{}) error

Delete implements the controller.Resource interface.

func (*KtoCSource) Informer

func (t *KtoCSource) Informer() cache.SharedIndexInformer

Informer implements the controller.Resource interface.

func (*KtoCSource) Lock

func (t *KtoCSource) Lock()

func (*KtoCSource) Run

func (t *KtoCSource) Run(ch <-chan struct{})

Run implements the controller.Backgrounder interface.

func (*KtoCSource) Unlock

func (t *KtoCSource) Unlock()

func (*KtoCSource) Upsert

func (t *KtoCSource) Upsert(key string, raw interface{}) error

Upsert implements the controller.Resource interface.

type KtoCSyncer

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

KtoCSyncer is a Syncer that takes the set of registrations and registers them with cloud. It also watches cloud for changes to the services and ensures the local set of registrations represents the source of truth, overwriting any external changes to the services.

func NewKtoCSyncer

func NewKtoCSyncer(controller connector.ConnectController,
	discClient connector.ServiceDiscoveryClient) *KtoCSyncer

func (*KtoCSyncer) Lock

func (s *KtoCSyncer) Lock()

func (*KtoCSyncer) Run

func (s *KtoCSyncer) Run(ctx context.Context)

Run is the long-running runloop for reconciling the local set of services to register with the remote state.

func (*KtoCSyncer) Sync

func (s *KtoCSyncer) Sync(rs []*connector.CatalogRegistration)

Sync implements Syncer.

func (*KtoCSyncer) Unlock

func (s *KtoCSyncer) Unlock()

type SyncJob

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

SyncJob is the job to sync

func (*SyncJob) GetDoneCh

func (job *SyncJob) GetDoneCh() <-chan struct{}

GetDoneCh returns the channel, which when closed, indicates the job has been finished.

func (*SyncJob) JobName

func (job *SyncJob) JobName() string

JobName implementation for this job, for logging purposes

func (*SyncJob) Run

func (job *SyncJob) Run()

Run is the logic unit of job

type Syncer

type Syncer interface {
	// Sync is called to sync the full set of registrations.
	Sync([]*connector.CatalogRegistration)
}

Syncer is responsible for syncing a set of cloud catalog registrations. An external system manages the set of registrations and periodically updates the Syncer. The Syncer should keep the remote system in sync with the given set of registrations.