grpc

Documentation

Index

• Constants
• type APIConfiguration
• type AuthenticationConfiguration
• type AuthorizationConfiguration
• type Error
  • func (e *Error) Error() string
• type InterceptorConfiguration
• type Server
  • func New(config ServerConfiguration) Server
• type ServerConfiguration
• type VersionV1AuthorizationConfiguration
  • func (config *VersionV1AuthorizationConfiguration) RegisterAuthorization(inputLogger *zap.Logger) (unary []grpc.UnaryServerInterceptor, stream []grpc.StreamServerInterceptor)

Constants

const (
	ErrCouldNotListen = "could not start a listener"

	LogStartingServerListAddress = "listenAddress"
	LogStartingServerMessage     = "starting server"
)

const (
	LoggingPackageName = "internal.apiserver.grpc"
)

Types

type APIConfiguration

type APIConfiguration interface {
	RegisterAPI(*grpc.Server)
}

type AuthenticationConfiguration

type AuthenticationConfiguration struct {
	OIDCAudience string
	OIDCURL      string
}

type AuthorizationConfiguration

type AuthorizationConfiguration interface {
	RegisterAuthorization(logger *zap.Logger) ([]grpc.UnaryServerInterceptor, []grpc.StreamServerInterceptor)
}

type Error

type Error struct {
	Message string
	Err     error
}

func (*Error) Error

func (e *Error) Error() string

type InterceptorConfiguration

type InterceptorConfiguration struct {
	AuthenticationEnabled bool
	AuthorizationEnabled  bool
	PrometheusEnabled     bool
	RecoveryEnabled       bool
}

type Server

type Server interface {
	Serve()
}

func New

func New(config ServerConfiguration) Server

type ServerConfiguration

type ServerConfiguration struct {
	Port           string
	Interceptors   InterceptorConfiguration
	Authentication AuthenticationConfiguration
	Authorizations []AuthorizationConfiguration
	APIs           []APIConfiguration

	ErrorChannel chan<- error
	Logger       *zap.Logger
}

type VersionV1AuthorizationConfiguration

type VersionV1AuthorizationConfiguration struct{}

func (*VersionV1AuthorizationConfiguration) RegisterAuthorization

func (config *VersionV1AuthorizationConfiguration) RegisterAuthorization(inputLogger *zap.Logger) (unary []grpc.UnaryServerInterceptor, stream []grpc.StreamServerInterceptor)