ctok

Documentation

Overview

Package ctok implements a syncer from cloud to k8s.

Package ctok contains a reusable abstraction for efficiently watching for changes in resources in a Kubernetes cluster.

Index

• Constants
• func IsSyncCloudNamespace(ns *corev1.Namespace) bool
• type Aggregator
• type CtoKSource
  • func NewCtoKSource(controller connector.ConnectController, syncer *CtoKSyncer, ...) *CtoKSource
  • func (s *CtoKSource) Aggregate(ctx context.Context, svcName MicroSvcName) map[MicroSvcName]*MicroSvcMeta
  • func (s *CtoKSource) Run(ctx context.Context)
• type CtoKSyncer
  • func NewCtoKSyncer(controller connector.ConnectController, ...) *CtoKSyncer
  • func (s *CtoKSyncer) Delete(key string, _ interface{}) error
  • func (s *CtoKSyncer) Informer() cache.SharedIndexInformer
  • func (s *CtoKSyncer) Ready()
  • func (s *CtoKSyncer) Run(ch <-chan struct{})
  • func (s *CtoKSyncer) SetMicroAggregator(microAggregator Aggregator)
  • func (s *CtoKSyncer) SetServices(svcs map[MicroSvcName]MicroSvcDomainName)
  • func (s *CtoKSyncer) Upsert(key string, raw interface{}) error
• type MicroEndpointAddr
  • func (addr MicroEndpointAddr) To16() net.IP
  • func (addr MicroEndpointAddr) To4() net.IP
• type MicroSvcAppProtocol
• type MicroSvcDomainName
• type MicroSvcMeta
• type MicroSvcName
• type MicroSvcPort

Constants

const (
	// K8SQuietPeriod is the time to wait for no service changes before syncing.
	K8SQuietPeriod = 1 * time.Second

	// K8SMaxPeriod is the maximum time to wait before forcing a sync, even
	// if there are active changes going on.
	K8SMaxPeriod = 5 * time.Second

	True  = "true"
	False = "false"
)

const (
	// CloudSourcedServiceLabel defines cloud-sourced service label
	CloudSourcedServiceLabel = "cloud-sourced-service"
	// CloudServiceLabel defines cloud service label
	CloudServiceLabel = "cloud-service"
)

Functions

func IsSyncCloudNamespace

func IsSyncCloudNamespace(ns *corev1.Namespace) bool

IsSyncCloudNamespace if sync namespace

Types

type Aggregator

type Aggregator interface {
	// Aggregate micro services
	Aggregate(context.Context, MicroSvcName) map[MicroSvcName]*MicroSvcMeta
}

Aggregator aggregates micro services

type CtoKSource

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

CtoKSource is the source for the sync that watches cloud services and updates a CtoKSyncer whenever the set of services to register changes.

func NewCtoKSource

func NewCtoKSource(controller connector.ConnectController,
	syncer *CtoKSyncer,
	discClient connector.ServiceDiscoveryClient,
	domain string) *CtoKSource

func (*CtoKSource) Aggregate

func (s *CtoKSource) Aggregate(ctx context.Context, svcName MicroSvcName) map[MicroSvcName]*MicroSvcMeta

Aggregate micro services

func (*CtoKSource) Run

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

Run is the long-running loop for watching cloud services and updating the CtoKSyncer.

type CtoKSyncer

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

CtoKSyncer is the destination where services are registered.

While in practice we only have one syncer (K8S), the interface abstraction makes it easy and possible to test the CtoKSource in isolation.

func NewCtoKSyncer

func NewCtoKSyncer(
	controller connector.ConnectController,
	discClient connector.ServiceDiscoveryClient,
	kubeClient kubernetes.Interface,
	ctx context.Context,
	fsmNamespace string) *CtoKSyncer

NewCtoKSyncer creates a new mesh syncer

func (*CtoKSyncer) Delete

func (s *CtoKSyncer) Delete(key string, _ interface{}) error

Delete implements the controller.Resource interface.

func (*CtoKSyncer) Informer

func (s *CtoKSyncer) Informer() cache.SharedIndexInformer

Informer implements the controller.Resource interface. It tells Kubernetes that we want to watch for changes to Services.

func (*CtoKSyncer) Ready

func (s *CtoKSyncer) Ready()

Ready wait util ready

func (*CtoKSyncer) Run

func (s *CtoKSyncer) Run(ch <-chan struct{})

Run implements the controller.Backgrounder interface.

func (*CtoKSyncer) SetMicroAggregator

func (s *CtoKSyncer) SetMicroAggregator(microAggregator Aggregator)

func (*CtoKSyncer) SetServices

func (s *CtoKSyncer) SetServices(svcs map[MicroSvcName]MicroSvcDomainName)

SetServices is called with the services that should be created. The key is the service name and the destination is the external DNS entry to point to.

func (*CtoKSyncer) Upsert

func (s *CtoKSyncer) Upsert(key string, raw interface{}) error

Upsert implements the controller.Resource interface.

type MicroEndpointAddr

type MicroEndpointAddr string

MicroEndpointAddr defines string as micro endpoint addr

func (MicroEndpointAddr) To16

func (addr MicroEndpointAddr) To16() net.IP

To16 converts the IP address ip to a 16-byte representation. If ip is not an IP address (it is the wrong length), To16 returns nil.

func (MicroEndpointAddr) To4

func (addr MicroEndpointAddr) To4() net.IP

To4 converts the IPv4 address ip to a 4-byte representation. If ip is not an IPv4 address, To4 returns nil.

type MicroSvcAppProtocol

type MicroSvcAppProtocol string

MicroSvcAppProtocol defines app protocol

type MicroSvcDomainName

type MicroSvcDomainName string

MicroSvcDomainName defines string as microservice domain name

type MicroSvcMeta

type MicroSvcMeta struct {
	Ports       map[MicroSvcPort]MicroSvcAppProtocol
	Addresses   map[MicroEndpointAddr]int
	ClusterId   string
	HealthCheck bool
}

MicroSvcMeta defines micro service meta

type MicroSvcName

type MicroSvcName string

MicroSvcName defines string as microservice name

type MicroSvcPort

type MicroSvcPort int

MicroSvcPort defines int as micro service port