translator

package
v1.10.22 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 28, 2022 License: Apache-2.0 Imports: 50 Imported by: 13

README

Gloo Translation

The Gloo Translator is responsible for converting a Gloo Proxy into an xDS Snapshot. It does this in the following order:

  1. Compute Cluster subsystem resources (Clusters, ClusterLoadAssignments)
  2. Compute Listener subsystem resources (RouteConfigurations, Listeners)
  3. Generate an xDS Snapshot
  4. Return the xDS Snapshot, ResourceReports and ProxyReport

Inputs

Cluster Subsystem Translation

Cluster Translation
ClusterLoadAssignment Translation

Listener Subsystem Translation

The Listener subsystem handles downstream request processing.

It is composed of:

  1. RouteConfigurations
  2. Listeners
RouteConfiguration Translation
Listener Translation

Outputs

Documentation

Index

Constants

View Source 
const (
	DefaultHttpStatPrefix = "http"
)
View Source 
const EnvoyLb = "envoy.lb"
View Source 
const SoloAnnotations = "io.solo.annotations"

Variables

View Source 
var (
	DefaultHealthCheckTimeout  = &duration.Duration{Seconds: 5}
	DefaultHealthCheckInterval = prototime.DurationToProto(time.Millisecond * 100)
	DefaultThreshold           = &wrappers.UInt32Value{
		Value: 5,
	}

	NilFieldError = func(fieldName string) error {
		return eris.Errorf("The field %s cannot be nil", fieldName)
	}
)
View Source 
var (
	NoDestinationSpecifiedError = errors.New("must specify at least one weighted destination for multi destination routes")

	SubsetsMisconfiguredErr = errors.New("route has a subset config, but the upstream does not")
)
View Source 
var (
	ClusterConnectionTimeout = time.Second * 5
)

Functions

func CheckForDuplicateFilterChainMatches added in v1.4.13 

func CheckForDuplicateFilterChainMatches(filterChains []*envoy_config_listener_v3.FilterChain, listenerReport *validationapi.ListenerReport)

Check for identical FilterChains to avoid the envoy error that occurs here: https://github.com/envoyproxy/envoy/blob/v1.15.0/source/server/filter_chain_manager_impl.cc#L162-L166 Note: this is NOT address non-equal but overlapping FilterChainMatches, which is a separate check here: https://github.com/envoyproxy/envoy/blob/50ef0945fa2c5da4bff7627c3abf41fdd3b7cffd/source/server/filter_chain_manager_impl.cc#L218-L354 Given the complexity of the overlap detection implementation, we don't want to duplicate that behavior here. We may want to consider invoking envoy from a library to detect overlapping and other issues, which would build off this discussion: https://github.com/solo-io/gloo/issues/2114 Visible for testing

func ClusterToUpstreamRef added in v1.6.10 

func ClusterToUpstreamRef(cluster string) (*core.ResourceRef, error)

returns the ref of the upstream for a given cluster

func ConsolidateSslConfigurations added in v1.9.25 

func ConsolidateSslConfigurations(sslConfigurations []*v1.SslConfig) []*v1.SslConfig

func DataSourceFromString 

func DataSourceFromString(str string) *envoy_config_core_v3.DataSource

func EnvoyCacheResourcesListToFnvHash added in v1.6.3 

func EnvoyCacheResourcesListToFnvHash(resources []envoycache.Resource) uint64

func EnvoyCacheResourcesListToHash added in v1.6.3 

func EnvoyCacheResourcesListToHash(resources []envoycache.Resource) uint64

deprecated, slower than EnvoyCacheResourcesListToFnvHash

func GlooMatcherToEnvoyMatcher added in v1.0.0 

func GlooMatcherToEnvoyMatcher(ctx context.Context, matcher *matchers.Matcher) envoy_config_route_v3.RouteMatch

utility function to transform gloo matcher to envoy route matcher

func MakeRdsResources added in v1.0.0 

func MakeRdsResources(routeConfigs []*envoy_config_route_v3.RouteConfiguration) envoycache.Resources

func MergeSslConfig added in v1.9.25 

func MergeSslConfig(dst, src *v1.SslConfig) *v1.SslConfig

Merges the fields of src into dst. The fields in dst that have non-zero values will not be overwritten.

func NewAccessLogWithConfig added in v0.18.1 

func NewAccessLogWithConfig(name string, config proto.Message) (envoyal.AccessLog, error)

func NewFilterWithTypedConfig added in v1.5.0 

func NewFilterWithTypedConfig(name string, config proto.Message) (*envoy_config_listener_v3.Filter, error)

func NewHttpListenerNetworkFilterTranslator added in v1.9.25 

func NewHttpListenerNetworkFilterTranslator(
	parentListener *v1.Listener,
	listener *v1.HttpListener,
	report *validationapi.HttpListenerReport,
	plugins []plugins.HttpFilterPlugin,
	hcmPlugins []plugins.HttpConnectionManagerPlugin,
	routeConfigName string,
) *httpNetworkFilterTranslator

func ParseTypedConfig added in v1.5.0 

func ParseTypedConfig(c typedConfigObject, config proto.Message) error

func UpstreamToClusterName 

func UpstreamToClusterName(upstream *core.ResourceRef) string

returns the name of the cluster created for a given upstream

func ValidateRouteDestinations added in v0.18.0 

func ValidateRouteDestinations(snap *v1.ApiSnapshot, action *v1.RouteAction) error

func ValidateTcpRouteDestinations added in v1.4.2 

func ValidateTcpRouteDestinations(snap *v1.ApiSnapshot, action *v1.TcpHost_TcpAction) error

func ValidateVirtualHostDomains added in v1.2.5 

func ValidateVirtualHostDomains(virtualHosts []*v1.VirtualHost, httpListenerReport *validationapi.HttpListenerReport)

returns an error if any of the virtualhost domains overlap Visible for testing

Types

type FilterChainTranslator added in v1.9.25 

type FilterChainTranslator interface {
	ComputeFilterChains(params plugins.Params) []*envoy_config_listener_v3.FilterChain
}

type ListenerSubsystemTranslatorFactory added in v1.9.25 

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

The Listener subsystem handles downstream request processing. https://www.envoyproxy.io/docs/envoy/latest/intro/life_of_a_request.html?#high-level-architecture Gloo sends resources to Envoy via xDS. The components of the Listener subsystem that Gloo configures are: 1. Listeners 2. RouteConfiguration Given that Gloo exposes a variety of ListenerTypes (HttpListener, TcpListener, HybridListener), and each of these types affect how resources are generated, we abstract those implementation details behind abstract translators. The ListenerSubsystemTranslatorFactory returns a ListenerTranslator and RouteConfigurationTranslator for a given Gloo Listener

func NewListenerSubsystemTranslatorFactory added in v1.9.25 

func NewListenerSubsystemTranslatorFactory(
	pluginRegistry plugins.PluginRegistry,
	sslConfigTranslator utils.SslConfigTranslator,
) *ListenerSubsystemTranslatorFactory

func (*ListenerSubsystemTranslatorFactory) GetHttpListenerTranslators added in v1.9.25 

func (l *ListenerSubsystemTranslatorFactory) GetHttpListenerTranslators(ctx context.Context, proxy *v1.Proxy, listener *v1.Listener, listenerReport *validationapi.ListenerReport) (
	ListenerTranslator,
	RouteConfigurationTranslator,
)

func (*ListenerSubsystemTranslatorFactory) GetHybridListenerTranslators added in v1.9.25 

func (l *ListenerSubsystemTranslatorFactory) GetHybridListenerTranslators(ctx context.Context, proxy *v1.Proxy, listener *v1.Listener, listenerReport *validationapi.ListenerReport) (
	ListenerTranslator,
	RouteConfigurationTranslator,
)

func (*ListenerSubsystemTranslatorFactory) GetTcpListenerTranslators added in v1.9.25 

func (l *ListenerSubsystemTranslatorFactory) GetTcpListenerTranslators(ctx context.Context, listener *v1.Listener, listenerReport *validationapi.ListenerReport) (
	ListenerTranslator,
	RouteConfigurationTranslator,
)

func (*ListenerSubsystemTranslatorFactory) GetTranslators added in v1.9.25 

func (l *ListenerSubsystemTranslatorFactory) GetTranslators(ctx context.Context, proxy *v1.Proxy, listener *v1.Listener, listenerReport *validationapi.ListenerReport) (
	ListenerTranslator,
	RouteConfigurationTranslator,
)

type ListenerTranslator added in v1.9.25 

type ListenerTranslator interface {
	// A single Gloo Listener produces a single Envoy listener
	// https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/listeners/listeners#arch-overview-listeners
	ComputeListener(params plugins.Params) *envoy_config_listener_v3.Listener
}

type NetworkFilterTranslator added in v1.9.25 

type NetworkFilterTranslator interface {
	ComputeNetworkFilters(params plugins.Params) []*envoy_config_listener_v3.Filter
}

type RouteConfigurationTranslator added in v1.9.25 

type RouteConfigurationTranslator interface {
	// A Gloo listener may produce multiple filter chains. Each one may contain its own route configuration
	// https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/http/http_routing#arch-overview-http-routing
	ComputeRouteConfiguration(params plugins.Params) []*envoy_config_route_v3.RouteConfiguration
}

type Translator 

type Translator interface {
	Translate(
		params plugins.Params,
		proxy *v1.Proxy,
	) (envoycache.Snapshot, reporter.ResourceReports, *validationapi.ProxyReport, error)
}

func NewTranslator 

func NewTranslator(
	sslConfigTranslator utils.SslConfigTranslator,
	settings *v1.Settings,
	pluginRegistryFactory plugins.PluginRegistryFactory,
) Translator

func NewTranslatorWithHasher added in v1.6.3 

func NewTranslatorWithHasher(
	sslConfigTranslator utils.SslConfigTranslator,
	settings *v1.Settings,
	pluginRegistryFactory plugins.PluginRegistryFactory,
	hasher func(resources []envoycache.Resource) uint64,
) Translator

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.