praefect

Documentation

Overview

Package praefect is a Gitaly reverse proxy for transparently routing gRPC calls to a set of Gitaly services.

Index

• type Coordinator
  • func (c *Coordinator) RegisterNode(storageLoc, listenAddr string) error
• type Logger
• type Server
  • func NewServer(grpcOpts []grpc.ServerOption, l Logger) *Server
  • func (srv *Server) Shutdown(ctx context.Context) error
  • func (srv *Server) Start(lis net.Listener) error

Types

type Coordinator

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

Coordinator takes care of directing client requests to the appropriate downstream server. The coordinator is thread safe; concurrent calls to register nodes are safe.

func (*Coordinator) RegisterNode

func (c *Coordinator) RegisterNode(storageLoc, listenAddr string) error

RegisterNode will direct traffic to the supplied downstream connection when the storage location is encountered.

type Logger

type Logger interface {
	Debugf(format string, args ...interface{})
}

Logger is a simple interface that allows loggers to be dependency injected into the praefect server

type Server

type Server struct {
	*Coordinator
	// contains filtered or unexported fields
}

Server is a praefect server

func NewServer

func NewServer(grpcOpts []grpc.ServerOption, l Logger) *Server

NewServer returns an initialized praefect gPRC proxy server configured with the provided gRPC server options

func (*Server) Shutdown

func (srv *Server) Shutdown(ctx context.Context) error

Shutdown will attempt a graceful shutdown of the grpc server. If unable to gracefully shutdown within the context deadline, it will then forcefully shutdown the server and return a context cancellation error.

func (*Server) Start

func (srv *Server) Start(lis net.Listener) error

Start will start the praefect gRPC proxy server listening at the provided listener. Function will block until the server is stopped or an unrecoverable error occurs.