xds

Documentation

Overview

Package xds contains types that need to be shared between code under google.golang.org/grpc/xds/... and the rest of gRPC.

Index

• func BootstrapContents(opts BootstrapOptions) ([]byte, error)
• func SetupBootstrapFile(opts BootstrapOptions) (func(), error)
• type BootstrapOptions
• type TransportAPI

Functions

func BootstrapContents

func BootstrapContents(opts BootstrapOptions) ([]byte, error)

BootstrapContents returns the contents to go into a bootstrap file, environment, or configuration passed to xds.NewXDSResolverWithConfigForTesting.

func SetupBootstrapFile

func SetupBootstrapFile(opts BootstrapOptions) (func(), error)

SetupBootstrapFile creates a temporary file with bootstrap contents, based on the passed in options, and updates the bootstrap environment variable to point to this file.

Returns a cleanup function which will be non-nil if the setup process was completed successfully. It is the responsibility of the caller to invoke the cleanup function at the end of the test.

Types

type BootstrapOptions

type BootstrapOptions struct {
	// Version is the xDS transport protocol version.
	Version TransportAPI
	// NodeID is the node identifier of the gRPC client/server node in the
	// proxyless service mesh.
	NodeID string
	// ServerURI is the address of the management server.
	ServerURI string
	// ServerListenerResourceNameTemplate is the Listener resource name to fetch.
	ServerListenerResourceNameTemplate string
	// CertificateProviders is the certificate providers configuration.
	CertificateProviders map[string]json.RawMessage
	// Authorities is a list of non-default authorities.
	//
	// In the config, an authority contains {ServerURI, xds-version, creds,
	// features, etc}. Note that this fields only has ServerURI (it's a
	// map[authority-name]ServerURI). The other fields (version, creds,
	// features) are assumed to be the same as the default authority (they can
	// be added later if needed).
	//
	// If the env var corresponding to federation (envconfig.XDSFederation) is
	// set, an entry with empty string as the key and empty server config as
	// value will be added. This will be used by new style resource names with
	// an empty authority.
	Authorities map[string]string
}

BootstrapOptions wraps the parameters passed to SetupBootstrapFile.

type TransportAPI

type TransportAPI int

TransportAPI refers to the API version for xDS transport protocol.

const (
	// TransportV2 refers to the v2 xDS transport protocol.
	TransportV2 TransportAPI = iota
	// TransportV3 refers to the v3 xDS transport protocol.
	TransportV3
)