plugins

Documentation

Index

• type Plugin
• type PostTranslationContext
• type PostTranslationPlugin
• type RouteContext
• type RoutePlugin
• type TranslatedGateway

Types

type Plugin

type Plugin interface{}

Plugin is an empty type for base plugins, currently no base methods.

type PostTranslationContext

type PostTranslationContext struct {
	// TranslatedGateways is the list of Gateways that were generated in a single translation run
	TranslatedGateways []TranslatedGateway
}

type PostTranslationPlugin

type PostTranslationPlugin interface {
	// ApplyPostTranslationPlugin is executed once at the end of a translation run
	ApplyPostTranslationPlugin(
		ctx context.Context,
		postTranslationContext *PostTranslationContext,
	) error
}

type RouteContext

type RouteContext struct {
	// top-level gw Listener
	Listener *gwv1.Listener
	// 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 {
	// ApplyRoutePlugin is called for each Match in a given Rule
	ApplyRoutePlugin(
		ctx context.Context,
		routeCtx *RouteContext,
		outputRoute *v1.Route,
	) error
}

type TranslatedGateway

type TranslatedGateway struct {
	// Gateway is the input object that produced the Proxy
	Gateway gwv1.Gateway
}