syncer

Documentation

Index

• func GetKeyFromProxyMeta(proxy *gloov1.Proxy) string
• func NewTranslatorSyncer(ctx context.Context, translator translator.Translator, ...) v1snap.ApiSyncer
• type MockXdsCache
  • func (*MockXdsCache) ClearSnapshot(node string)
  • func (*MockXdsCache) CreateWatch(envoycache.Request) (value chan envoycache.Response, cancel func())
  • func (*MockXdsCache) Fetch(context.Context, envoycache.Request) (*envoycache.Response, error)
  • func (c *MockXdsCache) GetSnapshot(node string) (envoycache.Snapshot, error)
  • func (*MockXdsCache) GetStatusInfo(string) envoycache.StatusInfo
  • func (c *MockXdsCache) GetStatusKeys() []string
  • func (c *MockXdsCache) SetSnapshot(node string, snapshot envoycache.Snapshot)
• type MockXdsSanitizer
  • func (s *MockXdsSanitizer) SanitizeSnapshot(ctx context.Context, glooSnapshot *v1snap.ApiSnapshot, ...) envoycache.Snapshot
• type NoOpSnapshotSetter
  • func (n *NoOpSnapshotSetter) SetSnapshot(node string, snapshot envoycache.Snapshot)
• type OnProxiesTranslatedFn
• type SnapshotSetter
• type TranslatorSyncerExtension
• type TranslatorSyncerExtensionFactory
• type TranslatorSyncerExtensionParams

Functions

func GetKeyFromProxyMeta

func GetKeyFromProxyMeta(proxy *gloov1.Proxy) string

func NewTranslatorSyncer

func NewTranslatorSyncer(
	ctx context.Context,
	translator translator.Translator,
	xdsCache envoycache.SnapshotCache,
	sanitizer sanitizer.XdsSanitizer,
	reporter reporter.StatusReporter,
	devMode bool,
	extensions []TranslatorSyncerExtension,
	settings *v1.Settings,
	statusMetrics metrics.ConfigStatusMetrics,
	gatewaySyncer *gwsyncer.TranslatorSyncer,
	proxyClient v1.ProxyClient,
	writeNamespace string,
	identity leaderelector.Identity,
	onProxyTranslated OnProxiesTranslatedFn,
	snapshotHistory iosnapshot.History,
) v1snap.ApiSyncer

Types

type MockXdsCache

type MockXdsCache struct {
	Called bool
	// Snap that is set
	SetSnap envoycache.Snapshot
	// Snap that is returned
	GetSnap envoycache.Snapshot
}

Deprecated: Prefer the MockXdsCache that is colocated with our xds functionality in `projects/gloo/pkg/xds`

func (*MockXdsCache) ClearSnapshot

func (*MockXdsCache) ClearSnapshot(node string)

func (*MockXdsCache) CreateWatch

func (*MockXdsCache) CreateWatch(envoycache.Request) (value chan envoycache.Response, cancel func())

func (*MockXdsCache) Fetch

func (*MockXdsCache) Fetch(context.Context, envoycache.Request) (*envoycache.Response, error)

func (*MockXdsCache) GetSnapshot

func (c *MockXdsCache) GetSnapshot(node string) (envoycache.Snapshot, error)

func (*MockXdsCache) GetStatusInfo

func (*MockXdsCache) GetStatusInfo(string) envoycache.StatusInfo

func (*MockXdsCache) GetStatusKeys

func (c *MockXdsCache) GetStatusKeys() []string

func (*MockXdsCache) SetSnapshot

func (c *MockXdsCache) SetSnapshot(node string, snapshot envoycache.Snapshot)

type MockXdsSanitizer

type MockXdsSanitizer struct {
	Called bool
	Snap   envoycache.Snapshot
}

func (*MockXdsSanitizer) SanitizeSnapshot

func (s *MockXdsSanitizer) SanitizeSnapshot(ctx context.Context, glooSnapshot *v1snap.ApiSnapshot, xdsSnapshot envoycache.Snapshot, reports reporter.ResourceReports) envoycache.Snapshot

type NoOpSnapshotSetter

type NoOpSnapshotSetter struct{}

NoOpSnapshotSetter does nothing in it's interface

func (*NoOpSnapshotSetter) SetSnapshot

func (n *NoOpSnapshotSetter) SetSnapshot(node string, snapshot envoycache.Snapshot)

SetSnapshot does nothing, it is a no-op function

type OnProxiesTranslatedFn

type OnProxiesTranslatedFn func(ctx context.Context, proxiesWithReports []translatorutils.ProxyWithReports)

type SnapshotSetter

type SnapshotSetter interface {
	SetSnapshot(node string, snapshot envoycache.Snapshot)
}

SnapshotSetter sets a response snapshot for a node. It exposes only the Set functionality for a SnapshotCache

type TranslatorSyncerExtension

type TranslatorSyncerExtension interface {
	// ID returns the unique identifier for this TranslatorSyncerExtension
	// This represents the Key in the SnapshotCache where Sync() will store results
	ID() string

	// Sync processes an ApiSnapshot and updates reports with Errors/Warnings that it encounters
	// and updates the SnapshotCache entry if possible
	Sync(
		ctx context.Context,
		snap *v1snap.ApiSnapshot,
		settings *v1.Settings,
		snapshotSetter SnapshotSetter,
		reports reporter.ResourceReports)
}

TranslatorSyncerExtension represents a custom sync behavior that updates an entry in the SnapshotCache

type TranslatorSyncerExtensionFactory

type TranslatorSyncerExtensionFactory func(context.Context, TranslatorSyncerExtensionParams) TranslatorSyncerExtension

TranslatorSyncerExtensionFactory generates TranslatorSyncerExtensions

type TranslatorSyncerExtensionParams

type TranslatorSyncerExtensionParams struct {
	Hasher                   func(resources []envoycache.Resource) (uint64, error)
	RateLimitServiceSettings *ratelimit.ServiceSettings
}