api

Documentation

Index

• func IsSwaggerEmbedded() bool
• func StartGRPCAPI(api *API, healthchecker *HealthChecker)
• func StartHTTPAPI(options *Options)
• type API
  • func (a *API) GetGlobalConfig(_ context.Context, group *v1.Group) (*structpb.Struct, error)
  • func (a *API) GetPluginConfig(context.Context, *emptypb.Empty) (*structpb.Struct, error)
  • func (a *API) GetPlugins(context.Context, *emptypb.Empty) (*v1.PluginConfigs, error)
  • func (a *API) GetPools(context.Context, *emptypb.Empty) (*structpb.Struct, error)
  • func (a *API) GetProxies(context.Context, *emptypb.Empty) (*structpb.Struct, error)
  • func (a *API) GetServers(context.Context, *emptypb.Empty) (*structpb.Struct, error)
  • func (a *API) Version(context.Context, *emptypb.Empty) (*v1.VersionResponse, error)
• type HealthChecker
  • func (h *HealthChecker) Check(context.Context, *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)
  • func (h *HealthChecker) Watch(*grpc_health_v1.HealthCheckRequest, grpc_health_v1.Health_WatchServer) error
• type Healthz
• type Options

Functions

func IsSwaggerEmbedded

func IsSwaggerEmbedded() bool

func StartGRPCAPI

func StartGRPCAPI(api *API, healthchecker *HealthChecker)

StartGRPCAPI starts the gRPC API.

func StartHTTPAPI

func StartHTTPAPI(options *Options)

StartHTTPAPI starts the HTTP API.

Types

type API

type API struct {
	v1.GatewayDAdminAPIServiceServer

	Options *Options

	Config         *config.Config
	PluginRegistry *plugin.Registry
	Pools          map[string]*pool.Pool
	Proxies        map[string]*network.Proxy
	Servers        map[string]*network.Server
}

func (*API) GetGlobalConfig

func (a *API) GetGlobalConfig(_ context.Context, group *v1.Group) (*structpb.Struct, error)

GetGlobalConfig returns the global configuration of the GatewayD.

func (*API) GetPluginConfig

func (a *API) GetPluginConfig(context.Context, *emptypb.Empty) (*structpb.Struct, error)

GetPluginConfig returns the plugin configuration of the GatewayD.

func (*API) GetPlugins

func (a *API) GetPlugins(context.Context, *emptypb.Empty) (*v1.PluginConfigs, error)

GetPlugins returns the active plugin configuration of the GatewayD.

func (*API) GetPools

func (a *API) GetPools(context.Context, *emptypb.Empty) (*structpb.Struct, error)

GetPools returns the pool configuration of the GatewayD.

func (*API) GetProxies

func (a *API) GetProxies(context.Context, *emptypb.Empty) (*structpb.Struct, error)

GetProxies returns the proxy configuration of the GatewayD.

func (*API) GetServers

func (a *API) GetServers(context.Context, *emptypb.Empty) (*structpb.Struct, error)

GetServers returns the server configuration of the GatewayD.

func (*API) Version

func (a *API) Version(context.Context, *emptypb.Empty) (*v1.VersionResponse, error)

Version returns the version information of the GatewayD.

type HealthChecker

type HealthChecker struct {
	grpc_health_v1.UnimplementedHealthServer

	Servers map[string]*network.Server
}

func (*HealthChecker) Check

func (h *HealthChecker) Check(
	context.Context, *grpc_health_v1.HealthCheckRequest,
) (*grpc_health_v1.HealthCheckResponse, error)

func (*HealthChecker) Watch

func (h *HealthChecker) Watch(
	*grpc_health_v1.HealthCheckRequest,
	grpc_health_v1.Health_WatchServer,
) error

type Healthz

type Healthz struct {
	Status string `json:"status"`
}

type Options

type Options struct {
	Logger      zerolog.Logger
	GRPCNetwork string
	GRPCAddress string
	HTTPAddress string
	Servers     map[string]*network.Server
}