api

Documentation

Index

• func IsSwaggerEmbedded() bool
• type API
  • func (a *API) AddPeer(ctx context.Context, req *v1.AddPeerRequest) (*v1.AddPeerResponse, error)
  • func (a *API) GetGlobalConfig(_ context.Context, group *v1.Group) (*structpb.Struct, error)
  • func (a *API) GetPeers(context.Context, *emptypb.Empty) (*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) RemovePeer(ctx context.Context, req *v1.RemovePeerRequest) (*v1.RemovePeerResponse, error)
  • func (a *API) Version(context.Context, *emptypb.Empty) (*v1.VersionResponse, error)
• type GRPCServer
  • func NewGRPCServer(ctx context.Context, server GRPCServer) *GRPCServer
  • func (s *GRPCServer) Shutdown(context.Context)
  • func (s *GRPCServer) Start()
• type HTTPServer
  • func NewHTTPServer(options *Options) *HTTPServer
  • func (s *HTTPServer) Shutdown(ctx context.Context)
  • func (s *HTTPServer) Start()
• 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 IAPIServer
• type Options

Functions

func IsSwaggerEmbedded

func IsSwaggerEmbedded() bool

Types

type API

type API struct {
	v1.GatewayDAdminAPIServiceServer

	Options        *Options
	Config         *config.Config
	PluginRegistry *plugin.Registry
	Pools          map[string]map[string]*pool.Pool
	Proxies        map[string]map[string]*network.Proxy
	Servers        map[string]*network.Server
	// contains filtered or unexported fields
}

func (*API) AddPeer

func (a *API) AddPeer(ctx context.Context, req *v1.AddPeerRequest) (*v1.AddPeerResponse, error)

AddPeer adds a new peer to the raft cluster.

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) GetPeers

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

GetPeers returns the raft peers 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) RemovePeer

func (a *API) RemovePeer(ctx context.Context, req *v1.RemovePeerRequest) (*v1.RemovePeerResponse, error)

RemovePeer removes a peer from the raft cluster.

func (*API) Version

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

Version returns the version information of the GatewayD.

type GRPCServer

type GRPCServer struct {
	API *API

	*HealthChecker
	// contains filtered or unexported fields
}

func NewGRPCServer

func NewGRPCServer(ctx context.Context, server GRPCServer) *GRPCServer

NewGRPCServer creates a new gRPC server.

func (*GRPCServer) Shutdown

func (s *GRPCServer) Shutdown(context.Context)

Shutdown shuts down the gRPC server.

func (*GRPCServer) Start

func (s *GRPCServer) Start()

Start starts the gRPC server.

type HTTPServer

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

func NewHTTPServer

func NewHTTPServer(options *Options) *HTTPServer

NewHTTPServer creates a new HTTP server.

func (*HTTPServer) Shutdown

func (s *HTTPServer) Shutdown(ctx context.Context)

Shutdown shuts down the HTTP server.

func (*HTTPServer) Start

func (s *HTTPServer) Start()

Start starts the HTTP server.

type HealthChecker

type HealthChecker struct {
	grpc_health_v1.UnimplementedHealthServer

	Servers map[string]*network.Server
	// contains filtered or unexported fields
}

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 IAPIServer

type IAPIServer interface {
	Start()
	Shutdown(ctx context.Context)
}

type Options

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