praefect

Documentation

Overview

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

Index

• func GetBuildTime() string
• func GetVersion() string
• func GetVersionString() string
• func WithLatencyMetric(h metrics.Histogram) func(*ReplMgr)
• func WithQueueMetric(g metrics.Gauge) func(*ReplMgr)
• type BackoffFunc
  • func ExpBackoffFunc(start time.Duration, max time.Duration) BackoffFunc
• type Coordinator
  • func NewCoordinator(l *logrus.Entry, ds datastore.Datastore, nodeMgr nodes.Manager, ...) *Coordinator
  • func (c *Coordinator) FailoverRotation()
  • func (c *Coordinator) RegisterProtos(protos ...*descriptor.FileDescriptorProto) error
• type ReplMgr
  • func NewReplMgr(virtualStorage string, log *logrus.Entry, datastore datastore.Datastore, ...) ReplMgr
  • func (r ReplMgr) ProcessBacklog(ctx context.Context, b BackoffFunc) error
• type ReplMgrOpt
  • func WithReplicator(r Replicator) ReplMgrOpt
  • func WithWhitelist(whitelistedRepos []string) ReplMgrOpt
• type Replicator
• type Server
  • func NewServer(c *Coordinator, repl ReplMgr, grpcOpts []grpc.ServerOption, l *logrus.Entry, ...) *Server
  • func (srv *Server) GracefulStop()
  • func (srv *Server) RegisterServices()
  • func (srv *Server) Serve(l net.Listener, secure bool) error
  • func (srv *Server) Shutdown(ctx context.Context) error
  • func (srv *Server) Stop()

Functions

func GetBuildTime

func GetBuildTime() string

GetBuildTime returns the time at which the build took place

func GetVersion

func GetVersion() string

GetVersion returns the semver compatible version number

func GetVersionString

func GetVersionString() string

GetVersionString returns a standard version header

func WithLatencyMetric

func WithLatencyMetric(h metrics.Histogram) func(*ReplMgr)

WithLatencyMetric is an option to set the queue size prometheus metric

func WithQueueMetric

func WithQueueMetric(g metrics.Gauge) func(*ReplMgr)

WithQueueMetric is an option to set the queue size prometheus metric

Types

type BackoffFunc

type BackoffFunc func() (backoff, backoffReset)

BackoffFunc is a function that n turn provides a pair of functions backoff and backoffReset

func ExpBackoffFunc

func ExpBackoffFunc(start time.Duration, max time.Duration) BackoffFunc

ExpBackoffFunc generates a backoffFunc based off of start and max time durations

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 NewCoordinator

func NewCoordinator(l *logrus.Entry, ds datastore.Datastore, nodeMgr nodes.Manager, conf config.Config, fileDescriptors ...*descriptor.FileDescriptorProto) *Coordinator

NewCoordinator returns a new Coordinator that utilizes the provided logger

func (*Coordinator) FailoverRotation

func (c *Coordinator) FailoverRotation()

FailoverRotation waits for the SIGUSR1 signal, then promotes the next secondary to be primary

func (*Coordinator) RegisterProtos

func (c *Coordinator) RegisterProtos(protos ...*descriptor.FileDescriptorProto) error

RegisterProtos allows coordinator to register new protos on the fly

type ReplMgr

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

ReplMgr is a replication manager for handling replication jobs

func NewReplMgr

func NewReplMgr(virtualStorage string, log *logrus.Entry, datastore datastore.Datastore, nodeMgr nodes.Manager, opts ...ReplMgrOpt) ReplMgr

NewReplMgr initializes a replication manager with the provided dependencies and options

func (ReplMgr) ProcessBacklog

func (r ReplMgr) ProcessBacklog(ctx context.Context, b BackoffFunc) error

ProcessBacklog will process queued jobs. It will block while processing jobs.

type ReplMgrOpt

type ReplMgrOpt func(*ReplMgr)

ReplMgrOpt allows a replicator to be configured with additional options

func WithReplicator

func WithReplicator(r Replicator) ReplMgrOpt

WithReplicator overrides the default replicator

func WithWhitelist

func WithWhitelist(whitelistedRepos []string) ReplMgrOpt

WithWhitelist will configure a whitelist for repos to allow replication

type Replicator

type Replicator interface {
	// Replicate propagates changes from the source to the target
	Replicate(ctx context.Context, job datastore.ReplJob, source, target *grpc.ClientConn) error
	// Destroy will remove the target repo on the specified target connection
	Destroy(ctx context.Context, job datastore.ReplJob, target *grpc.ClientConn) error
}

Replicator performs the actual replication logic between two nodes

type Server

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

Server is a praefect server

func NewServer

func NewServer(c *Coordinator, repl ReplMgr, grpcOpts []grpc.ServerOption, l *logrus.Entry, nodeManager nodes.Manager, conf config.Config) *Server

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

func (*Server) GracefulStop

func (srv *Server) GracefulStop()

GracefulStop stops the praefect server gracefully

func (*Server) RegisterServices

func (srv *Server) RegisterServices()

RegisterServices will register any services praefect needs to handle rpcs on its own

func (*Server) Serve

func (srv *Server) Serve(l net.Listener, secure bool) error

Serve starts serving requests from the listener

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

func (srv *Server) Stop()

Stop stops the praefect server