grpc

Documentation

Overview

Package grpc provides gRPC utility functions, complementing the more common ones in the github.com/grpc/grpc-go package

Index

• func GetGRPCClientConn(ctx context.Context, name string, opts *Options) (*grpc.ClientConn, error)
• func NewGRPCClientConn(ctx context.Context, opts *Options, other ...grpc.DialOption) (*grpc.ClientConn, error)
• func NewHealthCheckServer() grpc_health.HealthServer
• type Options

Functions

func GetGRPCClientConn

func GetGRPCClientConn(ctx context.Context, name string, opts *Options) (*grpc.ClientConn, error)

GetGRPCClientConn returns a gRPC client connection for the given name. If a connection for that name has already been established the existing connection will be returned. If any options change for that connection, the existing connection will be closed and a new one established.

func NewGRPCClientConn

func NewGRPCClientConn(ctx context.Context, opts *Options, other ...grpc.DialOption) (*grpc.ClientConn, error)

NewGRPCClientConn returns a new gRPC pomerium service client connection.

func NewHealthCheckServer

func NewHealthCheckServer() grpc_health.HealthServer

NewHealthCheckServer returns a basic health checker

Types

type Options

type Options struct {
	// Addrs is the location of the service.  e.g. "service.corp.example:8443"
	Addrs []*url.URL
	// OverrideCertificateName overrides the server name used to verify the hostname on the
	// returned certificates from the server. gRPC internals also use it to override the virtual
	// hosting name if it is set.
	OverrideCertificateName string
	// CA specifies the base64 encoded TLS certificate authority to use.
	CA string
	// CAFile specifies the TLS certificate authority file to use.
	CAFile string
	// RequestTimeout specifies the timeout for individual RPC calls
	RequestTimeout time.Duration
	// ClientDNSRoundRobin enables or disables DNS resolver based load balancing
	ClientDNSRoundRobin bool

	// WithInsecure disables transport security for this ClientConn.
	// Note that transport security is required unless WithInsecure is set.
	WithInsecure bool

	// InstallationID specifies the installation id for telemetry exposition.
	InstallationID string

	// ServiceName specifies the service name for telemetry exposition
	ServiceName string

	// SignedJWTKey is the JWT key to use for signing a JWT attached to metadata.
	SignedJWTKey []byte
}

Options contains options for connecting to a pomerium rpc service.