plugins

Documentation

Index

• type Plugin
• type RouteContext
• type RoutePlugin

Types

type Plugin

type Plugin interface{}

Empty type for base plugins, currently no base methods.

type RouteContext

type RouteContext struct {
	// top-level HTTPRoute
	Route *gwv1.HTTPRoute
	// specific Rule of the HTTPRoute being processed
	Rule *gwv1.HTTPRouteRule
	// specific Match of the Rule being processed (as there may be multiple Matches per Rule)
	Match *gwv1.HTTPRouteMatch
	// Reporter for the correct ParentRef associated with this HTTPRoute
	Reporter reports.ParentRefReporter
}

type RoutePlugin

type RoutePlugin interface {
	// called for each Match in a given Rule
	ApplyRoutePlugin(
		ctx context.Context,
		routeCtx *RouteContext,
		outputRoute *v1.Route,
	) error
}