client

Documentation

Overview

Package client contains the implementation of the xds client used by grpc-lb-v2.

Index

• type Config
  • func NewConfig() (*Config, error)

Types

type Config

type Config struct {
	// BalancerName is the name of the xDS server to connect to.
	BalancerName string
	// Creds contains the credentials to be used while talking to the xDS
	// server, as a grpc.DialOption.
	Creds grpc.DialOption
	// NodeProto contains the basepb.Node proto to be used in xDS calls made to the
	// server.
	NodeProto *basepb.Node
}

Config provides the xDS client with several key bits of information that it requires in its interaction with an xDS server. The Config is initialized from the bootstrap file. If that process fails for any reason, it uses the defaults passed in.

func NewConfig

func NewConfig() (*Config, error)

NewConfig returns a new instance of Config initialized by reading the bootstrap file found at ${GRPC_XDS_BOOTSTRAP}. Bootstrap file is read only on the first invocation of this function, and further invocations end up using the results from the former.

As of today, the bootstrap file only provides the balancer name and the node proto to be used in calls to the balancer. For transport credentials, the default TLS config with system certs is used. For call credentials, default compute engine credentials are used.