server

Documentation

Index

• Constants
• func RunServer(sa *Args, livenessProbeController, readinessProbeController probe.Controller)
• func StartProbeCheck(livenessProbeController, readinessProbeController probe.Controller, ...)
• func StartProfiling(stop <-chan struct{}, port uint)
• func StartSelfMonitoring(stop <-chan struct{}, port uint)
• type Args
  • func DefaultArgs() *Args
  • func (a *Args) String() string
• type Server
  • func New(a *Args) (*Server, error)
  • func (s *Server) Address() net.Addr
  • func (s *Server) Close() error
  • func (s *Server) Run()

Constants

const (
	//DefaultProbeCheckInterval defines default probeCheck interval
	DefaultProbeCheckInterval = 2 * time.Second
	//DefaultLivenessProbeFilePath defines default livenessProbe filePath
	DefaultLivenessProbeFilePath = "/healthLiveness"
	//DefaultReadinessProbeFilePath defines default readinessProbe filePath
	DefaultReadinessProbeFilePath = "/healthReadiness"
)

Functions

func RunServer

func RunServer(sa *Args, livenessProbeController,
	readinessProbeController probe.Controller)

RunServer start Galley Server mode

func StartProbeCheck

func StartProbeCheck(livenessProbeController, readinessProbeController probe.Controller, stop <-chan struct{})

StartProbeCheck start probe check for Galley

func StartProfiling

func StartProfiling(stop <-chan struct{}, port uint)

StartProfiling start the profiling for Galley

func StartSelfMonitoring

func StartSelfMonitoring(stop <-chan struct{}, port uint)

StartSelfMonitoring start the self monitoring for Galley

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

	// Maximum size of individual received gRPC messages
	MaxReceivedMessageSize uint

	// Maximum number of outstanding RPCs per connection
	MaxConcurrentStreams uint

	// The credential options to use for MCP.
	CredentialOptions *creds.Options

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

	// AccessListFile is the YAML file that specifies ids of the allowed mTLS peers.
	AccessListFile string

	// ConfigPath is the path for Galley specific config files
	ConfigPath string

	// ExcludedResourceKinds is a list of resource kinds for which no source events will be triggered.
	ExcludedResourceKinds []string

	// MeshConfigFile is the path for mesh config
	MeshConfigFile string

	// DNS Domain suffix to use while constructing Ingress based resources.
	DomainSuffix string

	// SinkAddress should be set to the address of a MCP Resource
	// Sink service that Galley will dial out to. Leaving empty disables
	// sink.
	SinkAddress string

	// SinkAuthMode should be set to a name of an authentication plugin,
	// see the istio.io/istio/galley/pkg/autplugins package.
	SinkAuthMode string

	// SinkMeta list of key=values to attach as gRPC stream metadata to
	// outgoing Sink connections.
	SinkMeta []string

	// Enables gRPC-level tracing
	EnableGRPCTracing bool

	// Insecure gRPC service is used for the MCP server. CertificateFile and KeyFile is ignored.
	Insecure bool

	// Enable galley server mode
	EnableServer bool

	// DisableResourceReadyCheck disables the CRD readiness check. This
	// allows Galley to start when not all supported CRD are
	// registered with the kube-apiserver.
	DisableResourceReadyCheck bool
}

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 {
	// 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) Address

func (s *Server) Address() net.Addr

Address returns the Address of the MCP service.

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.