gateway

Documentation

Index

• type APIExtensionPlugin
• type APIServerOption
  • func WithAPIExtensions(plugins []APIExtensionPlugin) APIServerOption
  • func WithAuthMiddleware(name string) APIServerOption
  • func WithFiberMiddleware(middlewares ...FiberMiddleware) APIServerOption
  • func WithMetricsPlugins(plugins []MetricsPlugin) APIServerOption
• type APIServerOptions
  • func (o *APIServerOptions) Apply(opts ...APIServerOption)
• type CapabilityBackendPlugin
• type FiberMiddleware
• type Gateway
  • func NewGateway(ctx context.Context, conf *config.GatewayConfig, opts ...GatewayOption) *Gateway
  • func (g *Gateway) CapabilitiesStore() capabilities.BackendStore
  • func (g *Gateway) ListenAndServe() error
  • func (g *Gateway) MustRegisterCollector(collector prometheus.Collector)
  • func (g *Gateway) StorageBackend() storage.Backend
  • func (g *Gateway) TLSConfig() *tls.Config
• type GatewayAPIServer
  • func NewAPIServer(ctx context.Context, cfg *v1beta1.GatewayConfigSpec, lg *zap.SugaredLogger, ...) *GatewayAPIServer
  • func (s *GatewayAPIServer) ConfigureBootstrapRoutes(storageBackend storage.Backend, installer capabilities.Installer)
  • func (s *GatewayAPIServer) ListenAndServe() error
  • func (s *GatewayAPIServer) Shutdown() error
• type GatewayOption
  • func WithAPIServerOptions(opts ...APIServerOption) GatewayOption
  • func WithCapabilityBackendPlugins(plugins []CapabilityBackendPlugin) GatewayOption
  • func WithLifecycler(lc config.Lifecycler) GatewayOption
  • func WithSystemPlugins(plugins []plugins.ActivePlugin) GatewayOption
• type GatewayOptions
  • func (o *GatewayOptions) Apply(opts ...GatewayOption)
• type MetricsEndpointHandler
  • func NewMetricsEndpointHandler() *MetricsEndpointHandler
  • func (h *MetricsEndpointHandler) ListenAndServe(listener net.Listener) error
  • func (h *MetricsEndpointHandler) MustRegister(collectors ...prometheus.Collector)
• type MetricsPlugin
• type SystemPlugin

Types

type APIExtensionPlugin

type APIExtensionPlugin = plugins.TypedActivePlugin[apiextensions.GatewayAPIExtensionClient]

type APIServerOption

type APIServerOption func(*APIServerOptions)

func WithAPIExtensions

func WithAPIExtensions(plugins []APIExtensionPlugin) APIServerOption

func WithAuthMiddleware

func WithAuthMiddleware(name string) APIServerOption

func WithFiberMiddleware

func WithFiberMiddleware(middlewares ...FiberMiddleware) APIServerOption

func WithMetricsPlugins

func WithMetricsPlugins(plugins []MetricsPlugin) APIServerOption

type APIServerOptions

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

func (*APIServerOptions) Apply

func (o *APIServerOptions) Apply(opts ...APIServerOption)

type CapabilityBackendPlugin

type CapabilityBackendPlugin = plugins.TypedActivePlugin[capability.BackendClient]

type FiberMiddleware

type FiberMiddleware = func(*fiber.Ctx) error

type Gateway

type Gateway struct {
	GatewayOptions
	// contains filtered or unexported fields
}

func NewGateway

func NewGateway(ctx context.Context, conf *config.GatewayConfig, opts ...GatewayOption) *Gateway

func (*Gateway) CapabilitiesStore

func (g *Gateway) CapabilitiesStore() capabilities.BackendStore

Implements management.CapabilitiesDataSource

func (*Gateway) ListenAndServe

func (g *Gateway) ListenAndServe() error

func (*Gateway) MustRegisterCollector

func (g *Gateway) MustRegisterCollector(collector prometheus.Collector)

func (*Gateway) StorageBackend

func (g *Gateway) StorageBackend() storage.Backend

Implements management.CoreDataSource

func (*Gateway) TLSConfig

func (g *Gateway) TLSConfig() *tls.Config

Implements management.CoreDataSource

type GatewayAPIServer

type GatewayAPIServer struct {
	APIServerOptions
	// contains filtered or unexported fields
}

func NewAPIServer

func NewAPIServer(
	ctx context.Context,
	cfg *v1beta1.GatewayConfigSpec,
	lg *zap.SugaredLogger,
	opts ...APIServerOption,
) *GatewayAPIServer

func (*GatewayAPIServer) ConfigureBootstrapRoutes

func (s *GatewayAPIServer) ConfigureBootstrapRoutes(
	storageBackend storage.Backend,
	installer capabilities.Installer,
)

func (*GatewayAPIServer) ListenAndServe

func (s *GatewayAPIServer) ListenAndServe() error

func (*GatewayAPIServer) Shutdown

func (s *GatewayAPIServer) Shutdown() error

type GatewayOption

type GatewayOption func(*GatewayOptions)

func WithAPIServerOptions

func WithAPIServerOptions(opts ...APIServerOption) GatewayOption

func WithCapabilityBackendPlugins

func WithCapabilityBackendPlugins(plugins []CapabilityBackendPlugin) GatewayOption

func WithLifecycler

func WithLifecycler(lc config.Lifecycler) GatewayOption

func WithSystemPlugins

func WithSystemPlugins(plugins []plugins.ActivePlugin) GatewayOption

type GatewayOptions

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

func (*GatewayOptions) Apply

func (o *GatewayOptions) Apply(opts ...GatewayOption)

type MetricsEndpointHandler

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

func NewMetricsEndpointHandler

func NewMetricsEndpointHandler() *MetricsEndpointHandler

func (*MetricsEndpointHandler) ListenAndServe

func (h *MetricsEndpointHandler) ListenAndServe(listener net.Listener) error

func (*MetricsEndpointHandler) MustRegister

func (h *MetricsEndpointHandler) MustRegister(collectors ...prometheus.Collector)

type MetricsPlugin

type MetricsPlugin = plugins.TypedActivePlugin[prometheus.Collector]

type SystemPlugin

type SystemPlugin = plugins.TypedActivePlugin[system.SystemPluginServer]