sanitizer

Documentation

Index

• type RouteReplacingSanitizer
  • func NewRouteReplacingSanitizer(cfg *v1.GlooOptions_InvalidConfigPolicy) (*RouteReplacingSanitizer, error)
  • func (s *RouteReplacingSanitizer) SanitizeSnapshot(ctx context.Context, glooSnapshot *v1.ApiSnapshot, ...) (envoycache.Snapshot, error)
• type UpstreamRemovingSanitizer
  • func NewUpstreamRemovingSanitizer() *UpstreamRemovingSanitizer
  • func (s *UpstreamRemovingSanitizer) SanitizeSnapshot(ctx context.Context, glooSnapshot *v1.ApiSnapshot, ...) (envoycache.Snapshot, error)
• type XdsSanitizer
• type XdsSanitizers
  • func (s XdsSanitizers) SanitizeSnapshot(ctx context.Context, glooSnapshot *v1.ApiSnapshot, ...) (envoycache.Snapshot, error)

Types

type RouteReplacingSanitizer

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

func NewRouteReplacingSanitizer

func NewRouteReplacingSanitizer(cfg *v1.GlooOptions_InvalidConfigPolicy) (*RouteReplacingSanitizer, error)

func (*RouteReplacingSanitizer) SanitizeSnapshot

func (s *RouteReplacingSanitizer) SanitizeSnapshot(
	ctx context.Context,
	glooSnapshot *v1.ApiSnapshot,
	xdsSnapshot envoycache.Snapshot,
	reports reporter.ResourceReports,
) (envoycache.Snapshot, error)

type UpstreamRemovingSanitizer

type UpstreamRemovingSanitizer struct{}

func NewUpstreamRemovingSanitizer

func NewUpstreamRemovingSanitizer() *UpstreamRemovingSanitizer

func (*UpstreamRemovingSanitizer) SanitizeSnapshot

func (s *UpstreamRemovingSanitizer) SanitizeSnapshot(
	ctx context.Context,
	glooSnapshot *v1.ApiSnapshot,
	xdsSnapshot envoycache.Snapshot,
	reports reporter.ResourceReports,
) (envoycache.Snapshot, error)

If there are any errors on upstreams, this function tries to remove the correspondent clusters and endpoints from the xDS snapshot. If the snapshot is still consistent after these mutations and there are no errors related to other resources, we are good to send it to Envoy.

type XdsSanitizer

type XdsSanitizer interface {
	SanitizeSnapshot(
		ctx context.Context,
		glooSnapshot *v1.ApiSnapshot,
		xdsSnapshot envoycache.Snapshot,
		reports reporter.ResourceReports,
	) (envoycache.Snapshot, error)
}

an XdsSanitizer modifies an xds snapshot before it is stored in the xds cache the if the sanitizer returns an error, Gloo will not update the xds cache with the snapshot else Gloo will assume the snapshot is valid to send to Envoy

type XdsSanitizers

type XdsSanitizers []XdsSanitizer

func (XdsSanitizers) SanitizeSnapshot

func (s XdsSanitizers) SanitizeSnapshot(
	ctx context.Context,
	glooSnapshot *v1.ApiSnapshot,
	xdsSnapshot envoycache.Snapshot,
	reports reporter.ResourceReports,
) (envoycache.Snapshot, error)