plugins

Documentation

Index

• func FilterStageComparison(a, b FilterStage) int
• func StagedFilterListContainsName(filters StagedHttpFilterList, filterName string) bool
• type EndpointPlugin
• type FilterStage
  • func AfterStage(wellKnown WellKnownFilterStage) FilterStage
  • func BeforeStage(wellKnown WellKnownFilterStage) FilterStage
  • func DuringStage(wellKnown WellKnownFilterStage) FilterStage
  • func RelativeToStage(wellKnown WellKnownFilterStage, weight int) FilterStage
• type HttpConnectionManagerPlugin
• type HttpFilterPlugin
• type InitParams
• type ListenerPlugin
• type Params
• type Plugin
• type PluginRegistry
• type PluginRegistryFactory
• type ResourceGeneratorPlugin
• type RouteActionParams
• type RouteActionPlugin
• type RouteParams
• type RoutePlugin
• type StagedHttpFilter
  • func MustNewStagedFilter(name string, config proto.Message, stage FilterStage) StagedHttpFilter
  • func NewStagedFilter(name string, config proto.Message, stage FilterStage) (StagedHttpFilter, error)
  • func NewStagedFilterWithConfig(name string, config proto.Message, stage FilterStage) (StagedHttpFilter, error)
• type StagedHttpFilterList
  • func (s StagedHttpFilterList) Len() int
  • func (s StagedHttpFilterList) Less(i, j int) bool
  • func (s StagedHttpFilterList) Swap(i, j int)
• type StagedNetworkFilter
• type StagedNetworkFilterList
  • func (s StagedNetworkFilterList) Len() int
  • func (s StagedNetworkFilterList) Less(i, j int) bool
  • func (s StagedNetworkFilterList) Swap(i, j int)
• type TcpFilterChainPlugin
• type UpstreamPlugin
• type VirtualHostParams
• type VirtualHostPlugin
• type WeightedDestinationPlugin
• type WellKnownFilterStage

Functions

func FilterStageComparison

func FilterStageComparison(a, b FilterStage) int

FilterStageComparison helps implement the sort.Interface Less function for use in other implementations of sort.Interface returns -1 if less than, 0 if equal, 1 if greater than It is not sufficient to return a Less bool because calling functions need to know if equal or greater when Less is false

func StagedFilterListContainsName

func StagedFilterListContainsName(filters StagedHttpFilterList, filterName string) bool

StagedFilterListContainsName checks for a given named filter. This is not a check of the type url but rather the now mostly unused name

Types

type EndpointPlugin

type EndpointPlugin interface {
	Plugin
	ProcessEndpoints(params Params, in *v1.Upstream, out *envoy_config_endpoint_v3.ClusterLoadAssignment) error
}

EndpointPlugin modifies an Envoy ClusterLoadAssignment (formerly known as an Endpoint) which has been created for the input Gloo Upstream. This allows the ClusterLoadAssignments to be edited before being sent to Envoy via EDS. NOTE: If one wishes to also modify the corresponding envoy Cluster the above UpstreamPlugin interface should be used.

type FilterStage

type FilterStage struct {
	RelativeTo WellKnownFilterStage
	Weight     int
}

func AfterStage

func AfterStage(wellKnown WellKnownFilterStage) FilterStage

func BeforeStage

func BeforeStage(wellKnown WellKnownFilterStage) FilterStage

func DuringStage

func DuringStage(wellKnown WellKnownFilterStage) FilterStage

func RelativeToStage

func RelativeToStage(wellKnown WellKnownFilterStage, weight int) FilterStage

type HttpConnectionManagerPlugin

type HttpConnectionManagerPlugin interface {
	Plugin
	ProcessHcmNetworkFilter(params Params, parentListener *v1.Listener, listener *v1.HttpListener, out *envoyhttp.HttpConnectionManager) error
}

HttpConnectionManager Plugins

type HttpFilterPlugin

type HttpFilterPlugin interface {
	Plugin
	HttpFilters(params Params, listener *v1.HttpListener) ([]StagedHttpFilter, error)
}

type InitParams

type InitParams struct {
	Ctx      context.Context
	Settings *v1.Settings
}

type ListenerPlugin

type ListenerPlugin interface {
	Plugin
	ProcessListener(params Params, in *v1.Listener, out *envoy_config_listener_v3.Listener) error
}

type Params

type Params struct {
	Ctx      context.Context
	Snapshot *v1snap.ApiSnapshot
	Messages map[*core.ResourceRef][]string
}

type Plugin

type Plugin interface {
	// Name returns a unique identifier for a plugin
	Name() string

	// Init is used to re-initialize plugins and is executed for each translation loop
	// This is done for 2 reasons:
	//	1. Each translation run relies on its own context. If a plugin spawns a go-routine
	//		we need to be able to cancel that go-routine on the next translation
	//	2. Plugins are built with the assumption that they will be short lived, only for the
	//		duration of a single translation loop
	Init(params InitParams) error
}

Plugin is a named unit of translation, used to produce Envoy configuration

type PluginRegistry

type PluginRegistry interface {
	GetPlugins() []Plugin
	GetListenerPlugins() []ListenerPlugin
	GetTcpFilterChainPlugins() []TcpFilterChainPlugin
	GetHttpFilterPlugins() []HttpFilterPlugin
	GetHttpConnectionManagerPlugins() []HttpConnectionManagerPlugin
	GetVirtualHostPlugins() []VirtualHostPlugin
	GetResourceGeneratorPlugins() []ResourceGeneratorPlugin
	GetUpstreamPlugins() []UpstreamPlugin
	GetEndpointPlugins() []EndpointPlugin
	GetRoutePlugins() []RoutePlugin
	GetRouteActionPlugins() []RouteActionPlugin
	GetWeightedDestinationPlugins() []WeightedDestinationPlugin
}

A PluginRegistry is used to provide Plugins to relevant translators Historically, all plugins were passed around as an argument, and each translator would iterate over all plugins, and only apply the relevant ones. This interface enables translators to only know of the relevant plugins

type PluginRegistryFactory

type PluginRegistryFactory func(ctx context.Context) PluginRegistry

A PluginRegistryFactory generates a PluginRegistry It is executed each translation loop, ensuring we have up to date configuration of all plugins

type ResourceGeneratorPlugin

type ResourceGeneratorPlugin interface {
	Plugin
	GeneratedResources(params Params,
		inClusters []*envoy_config_cluster_v3.Cluster,
		inEndpoints []*envoy_config_endpoint_v3.ClusterLoadAssignment,
		inRouteConfigurations []*envoy_config_route_v3.RouteConfiguration,
		inListeners []*envoy_config_listener_v3.Listener,
	) ([]*envoy_config_cluster_v3.Cluster, []*envoy_config_endpoint_v3.ClusterLoadAssignment, []*envoy_config_route_v3.RouteConfiguration, []*envoy_config_listener_v3.Listener, error)
}

ResourceGeneratorPlugin modifies a set of xDS resources before they are persisted as a Snapshot

type RouteActionParams

type RouteActionParams struct {
	RouteParams
	Route *v1.Route
}

type RouteActionPlugin

type RouteActionPlugin interface {
	Plugin
	ProcessRouteAction(params RouteActionParams, inAction *v1.RouteAction, out *envoy_config_route_v3.RouteAction) error
}

RouteActionPlugin modifies an Envoy RouteAction which has been created for the input Gloo Route. NOTE: any route action plugin can be implemented as a route plugin suggestion: if your plugin requires configuration from a RoutePlugin field, implement the RoutePlugin interface

type RouteParams

type RouteParams struct {
	VirtualHostParams
	VirtualHost *v1.VirtualHost
}

type RoutePlugin

type RoutePlugin interface {
	Plugin
	ProcessRoute(params RouteParams, in *v1.Route, out *envoy_config_route_v3.Route) error
}

RoutePlugin modifies an Envoy Route which has been created for the input Gloo Route. This allows the routes in a RouteConfiguration to be edited before being send to Envoy via RDS.

type StagedHttpFilter

type StagedHttpFilter struct {
	HttpFilter *envoyhttp.HttpFilter
	Stage      FilterStage
}

func MustNewStagedFilter

func MustNewStagedFilter(name string, config proto.Message, stage FilterStage) StagedHttpFilter

MustNewStagedFilter creates an instance of the named filter with the desired stage. Returns a filter even if an error occured. Should rarely be used as disregarding an error is bad practice but does make appending easier. If not directly appending consider using NewStagedFilter instead of this function.

func NewStagedFilter

func NewStagedFilter(name string, config proto.Message, stage FilterStage) (StagedHttpFilter, error)

NewStagedFilter creates an instance of the named filter with the desired stage. Errors if the config is nil or we cannot determine the type of the config. Config type determination may fail if the config is both unknown and has no fields.

func NewStagedFilterWithConfig

func NewStagedFilterWithConfig(name string, config proto.Message, stage FilterStage) (StagedHttpFilter, error)

NewStagedFilterWithConfig creates an instance of the named filter with the desired stage. Deprecated: config is now always needed and so NewStagedFilter should always be used.

type StagedHttpFilterList

type StagedHttpFilterList []StagedHttpFilter

func (StagedHttpFilterList) Len

func (s StagedHttpFilterList) Len() int

func (StagedHttpFilterList) Less

func (s StagedHttpFilterList) Less(i, j int) bool

filters by Relative Stage, Weighting, Name, Config Type-Url, Config Value, and (to ensure stability) index. The assumption is that if two filters are in the same stage, their order doesn't matter, and we just need to make sure it is stable.

func (StagedHttpFilterList) Swap

func (s StagedHttpFilterList) Swap(i, j int)

type StagedNetworkFilter

type StagedNetworkFilter struct {
	NetworkFilter *envoy_config_listener_v3.Filter
	Stage         FilterStage
}

type StagedNetworkFilterList

type StagedNetworkFilterList []StagedNetworkFilter

func (StagedNetworkFilterList) Len

func (s StagedNetworkFilterList) Len() int

func (StagedNetworkFilterList) Less

func (s StagedNetworkFilterList) Less(i, j int) bool

filters by Relative Stage, Weighting, Name, and (to ensure stability) index

func (StagedNetworkFilterList) Swap

func (s StagedNetworkFilterList) Swap(i, j int)

type TcpFilterChainPlugin

type TcpFilterChainPlugin interface {
	Plugin
	CreateTcpFilterChains(params Params, parentListener *v1.Listener, in *v1.TcpListener) ([]*envoy_config_listener_v3.FilterChain, error)
}

type UpstreamPlugin

type UpstreamPlugin interface {
	Plugin
	ProcessUpstream(params Params, in *v1.Upstream, out *envoy_config_cluster_v3.Cluster) error
}

UpstreamPlugin modifies the Envoy Cluster which has been created for the input Gloo Upstream. This allows the Cluster to be edited before being sent to Envoy via CDS

type VirtualHostParams

type VirtualHostParams struct {
	Params
	Proxy        *v1.Proxy
	Listener     *v1.Listener
	HttpListener *v1.HttpListener
}

type VirtualHostPlugin

type VirtualHostPlugin interface {
	Plugin
	ProcessVirtualHost(params VirtualHostParams, in *v1.VirtualHost, out *envoy_config_route_v3.VirtualHost) error
}

type WeightedDestinationPlugin

type WeightedDestinationPlugin interface {
	Plugin
	ProcessWeightedDestination(
		params RouteParams,
		in *v1.WeightedDestination,
		out *envoy_config_route_v3.WeightedCluster_ClusterWeight,
	) error
}

type WellKnownFilterStage

type WellKnownFilterStage int

WellKnownFilterStages are represented by an integer that reflects their relative ordering

const (
	FaultStage     WellKnownFilterStage = iota // Fault injection // First Filter Stage
	CorsStage                                  // Cors stage
	WafStage                                   // Web application firewall stage
	AuthNStage                                 // Authentication stage
	AuthZStage                                 // Authorization stage
	RateLimitStage                             // Rate limiting stage
	AcceptedStage                              // Request passed all the checks and will be forwarded upstream
	OutAuthStage                               // Add auth for the upstream (i.e. aws λ)
	RouteStage                                 // Request is going to upstream // Last Filter Stage
)

The set of WellKnownFilterStages, whose order corresponds to the order used to sort filters If new well known filter stages are added, they should be inserted in a position corresponding to their order