extensions

Documentation

Index

• type Image
• type K8sGatewayExtensions
  • func NewK8sGatewayExtensions(_ context.Context, params K8sGatewayExtensionsFactoryParameters) (K8sGatewayExtensions, error)
• type K8sGatewayExtensionsFactory
• type K8sGatewayExtensionsFactoryParameters

Types

type Image

type Image struct {
	Repository string
	Tag        string
}

Image contains an image repository (e.g. "gloo-envoy-wrapper") and tag (e.g. "1.17.0").

The Image struct is provided here so that OSS and Enterprise Gloo Gateway can each inject their default image repo/tag (e.g. "gloo-envoy-wrapper" for OSS, "gloo-ee-envoy-wrapper" for EE), for images that differ between OSS and EE. For now, it's only used for the Envoy wrapper image, but could potentially be used for other images in the future.

Users may override the default OSS/EE Envoy image repo/tag (as well as other fields) completely via a GatewayParameters CR attached to a Gateway.

type K8sGatewayExtensions

type K8sGatewayExtensions interface {
	// CreatePluginRegistry returns the PluginRegistry
	CreatePluginRegistry(ctx context.Context) registry.PluginRegistry

	// GetEnvoyImage returns the envoy image and tag used by the proxy deployment.
	GetEnvoyImage() Image

	// GetSdsImage returns the sds image and tag used by the proxy deployment.
	GetSdsImage() Image
}

K8sGatewayExtensions is responsible for providing implementations for translation utilities which have Enterprise variants.

func NewK8sGatewayExtensions

func NewK8sGatewayExtensions(
	_ context.Context,
	params K8sGatewayExtensionsFactoryParameters,
) (K8sGatewayExtensions, error)

NewK8sGatewayExtensions returns the Open Source implementation of K8sGatewayExtensions

type K8sGatewayExtensionsFactory

type K8sGatewayExtensionsFactory func(
	ctx context.Context,
	params K8sGatewayExtensionsFactoryParameters,
) (K8sGatewayExtensions, error)

K8sGatewayExtensionsFactory returns an extensions.K8sGatewayExtensions

type K8sGatewayExtensionsFactoryParameters

type K8sGatewayExtensionsFactoryParameters struct {
	Mgr                     controllerruntime.Manager
	AuthConfigClient        v1.AuthConfigClient
	RouteOptionClient       gatewayv1.RouteOptionClient
	VirtualHostOptionClient gatewayv1.VirtualHostOptionClient
	StatusReporter          reporter.StatusReporter
	KickXds                 func(ctx context.Context)
}

K8sGatewayExtensionsFactoryParameters contains the parameters required to start Gloo K8s Gateway Extensions (including Translator Plugins)