translator

Documentation

Index

• Constants
• Variables
• func BuildRateLimitServiceConfig(irListener *ir.HTTPListener) *rlsconfv3.RateLimitConfig
• func GetRateLimitServiceConfigStr(pbCfg *rlsconfv3.RateLimitConfig) (string, error)
• type EndpointType
• type ExtraArgs
• type GlobalRateLimitSettings
• type HTTPRouteTranslator
• type OrderedHTTPFilter
• type OrderedHTTPFilters
  • func (o OrderedHTTPFilters) Len() int
  • func (o OrderedHTTPFilters) Less(i, j int) bool
  • func (o OrderedHTTPFilters) Swap(i, j int)
• type TCPRouteTranslator
• type Translator
  • func (t *Translator) Translate(xdsIR *ir.Xds) (*types.ResourceVersionTable, error)
• type UDPRouteTranslator

Constants

const (
	AuthorityHeaderKey = ":authority"
)

const (
	EmptyPath = ""
)

Variables

var EnvoyJSONLogFields = map[string]string{
	"start_time":                        "%START_TIME%",
	"method":                            "%REQ(:METHOD)%",
	"x-envoy-origin-path":               "%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%",
	"protocol":                          "%PROTOCOL%",
	"response_code":                     "%RESPONSE_CODE%",
	"response_flags":                    "%RESPONSE_FLAGS%",
	"response_code_details":             "%RESPONSE_CODE_DETAILS%",
	"connection_termination_details":    "%CONNECTION_TERMINATION_DETAILS%",
	"upstream_transport_failure_reason": "%UPSTREAM_TRANSPORT_FAILURE_REASON%",
	"bytes_received":                    "%BYTES_RECEIVED%",
	"bytes_sent":                        "%BYTES_SENT%",
	"duration":                          "%DURATION%",
	"x-envoy-upstream-service-time":     "%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%",
	"x-forwarded-for":                   "%REQ(X-FORWARDED-FOR)%",
	"user-agent":                        "%REQ(USER-AGENT)%",
	"x-request-id":                      "%REQ(X-REQUEST-ID)%",
	":authority":                        "%REQ(:AUTHORITY)%",
	"upstream_host":                     "%UPSTREAM_HOST%",
	"upstream_cluster":                  "%UPSTREAM_CLUSTER%",
	"upstream_local_address":            "%UPSTREAM_LOCAL_ADDRESS%",
	"downstream_local_address":          "%DOWNSTREAM_LOCAL_ADDRESS%",
	"downstream_remote_address":         "%DOWNSTREAM_REMOTE_ADDRESS%",
	"requested_server_name":             "%REQUESTED_SERVER_NAME%",
	"route_name":                        "%ROUTE_NAME%",
}

Functions

func BuildRateLimitServiceConfig

func BuildRateLimitServiceConfig(irListener *ir.HTTPListener) *rlsconfv3.RateLimitConfig

BuildRateLimitServiceConfig builds the rate limit service configuration based on https://github.com/envoyproxy/ratelimit#the-configuration-format

func GetRateLimitServiceConfigStr

func GetRateLimitServiceConfigStr(pbCfg *rlsconfv3.RateLimitConfig) (string, error)

GetRateLimitServiceConfigStr returns the PB string for the rate limit service configuration.

Types

type EndpointType

type EndpointType int

const (
	EndpointTypeDNS EndpointType = iota
	EndpointTypeStatic
)

const (
	DefaultEndpointType EndpointType = iota
	Static
	EDS
)

type ExtraArgs

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

type GlobalRateLimitSettings

type GlobalRateLimitSettings struct {
	// ServiceURL is the URL of the global
	// rate limit service.
	ServiceURL string

	// Timeout specifies the timeout period for the proxy to access the ratelimit server
	// If not set, timeout is 20000000(20ms).
	Timeout time.Duration

	// FailClosed is a switch used to control the flow of traffic
	// when the response from the ratelimit server cannot be obtained.
	FailClosed bool
}

type HTTPRouteTranslator

type HTTPRouteTranslator struct {
	*ir.HTTPRoute
}

type OrderedHTTPFilter

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

type OrderedHTTPFilters

type OrderedHTTPFilters []*OrderedHTTPFilter

func (OrderedHTTPFilters) Len

func (o OrderedHTTPFilters) Len() int

func (OrderedHTTPFilters) Less

func (o OrderedHTTPFilters) Less(i, j int) bool

func (OrderedHTTPFilters) Swap

func (o OrderedHTTPFilters) Swap(i, j int)

type TCPRouteTranslator

type TCPRouteTranslator struct {
	*ir.TCPRoute
}

type Translator

type Translator struct {
	// GlobalRateLimit holds the global rate limit settings
	// required during xds translation.
	GlobalRateLimit *GlobalRateLimitSettings

	// ExtensionManager holds the config for interacting with extensions when generating xDS
	// resources. Only required during xds translation.
	ExtensionManager *extensionTypes.Manager

	// FilterOrder holds the custom order of the HTTP filters
	FilterOrder []egv1a1.FilterPosition
}

Translator translates the xDS IR into xDS resources.

func (*Translator) Translate

func (t *Translator) Translate(xdsIR *ir.Xds) (*types.ResourceVersionTable, error)

Translate translates the XDS IR into xDS resources

type UDPRouteTranslator

type UDPRouteTranslator struct {
	*ir.UDPRoute
}