server

Documentation

Index

• type Args
  • func DefaultArgs() *Args
  • func (a *Args) String() string
• type Server
  • func New(a *Args) (*Server, error)
  • func (s *Server) Close() error
  • func (s *Server) Run()
  • func (s *Server) Wait() error

Types

type Args

type Args struct {
	// The path to kube configuration file.
	KubeConfig string

	// resync period to be passed to the K8s machinery.
	ResyncPeriod time.Duration

	// Address to use for Galley's gRPC API.
	APIAddress string

	// Enables gRPC-level tracing
	EnableGRPCTracing bool

	// Maximum size of individual received gRPC messages
	MaxReceivedMessageSize uint

	// Maximum number of outstanding RPCs per connection
	MaxConcurrentStreams uint

	// The logging options to use
	LoggingOptions *log.Options

	// The path to the file which indicates the liveness of the server by its existence.
	// This will be used for k8s liveness probe. If empty, it does nothing.
	LivenessProbeOptions *probe.Options

	// The path to the file for readiness probe, similar to LivenessProbePath.
	ReadinessProbeOptions *probe.Options

	// The introspection options to use
	IntrospectionOptions *ctrlz.Options
}

Args contains the startup arguments to instantiate Galley.

func DefaultArgs

func DefaultArgs() *Args

DefaultArgs allocates an Args struct initialized with Mixer's default configuration.

func (*Args) String

func (a *Args) String() string

String produces a stringified version of the arguments for debugging.

type Server

type Server struct {
	*probe.Probe
	// contains filtered or unexported fields
}

Server is the main entry point into the Galley code.

func New

func New(a *Args) (*Server, error)

New returns a new instance of a Server.

func (*Server) Close

func (s *Server) Close() error

Close cleans up resources used by the server.

func (*Server) Run

func (s *Server) Run()

Run enables Galley to start receiving gRPC requests on its main API port.

func (*Server) Wait

func (s *Server) Wait() error

Wait waits for the server to exit.