env

Documentation

Overview

Package env acts a single source of definition for all environment variables related to the xDS implementation in gRPC.

Index

• Constants
• Variables

Constants

const (
	// BootstrapFileNameEnv is the env variable to set bootstrap file name.
	// Do not use this and read from env directly. Its value is read and kept in
	// variable BootstrapFileName.
	//
	// When both bootstrap FileName and FileContent are set, FileName is used.
	BootstrapFileNameEnv = "GRPC_XDS_BOOTSTRAP"
	// BootstrapFileContentEnv is the env variable to set bootstrapp file
	// content. Do not use this and read from env directly. Its value is read
	// and kept in variable BootstrapFileName.
	//
	// When both bootstrap FileName and FileContent are set, FileName is used.
	BootstrapFileContentEnv = "GRPC_XDS_BOOTSTRAP_CONFIG"
)

Variables

var (
	// BootstrapFileName holds the name of the file which contains xDS bootstrap
	// configuration. Users can specify the location of the bootstrap file by
	// setting the environment variable "GRPC_XDS_BOOSTRAP".
	//
	// When both bootstrap FileName and FileContent are set, FileName is used.
	BootstrapFileName = os.Getenv(BootstrapFileNameEnv)
	// BootstrapFileContent holds the content of the xDS bootstrap
	// configuration. Users can specify the bootstrap config by
	// setting the environment variable "GRPC_XDS_BOOSTRAP_CONFIG".
	//
	// When both bootstrap FileName and FileContent are set, FileName is used.
	BootstrapFileContent = os.Getenv(BootstrapFileContentEnv)
	// V3Support indicates whether xDS v3 API support is enabled, which can be
	// done by setting the environment variable
	// "GRPC_XDS_EXPERIMENTAL_V3_SUPPORT" to "true".
	V3Support = strings.EqualFold(os.Getenv(xdsV3SupportEnv), "true")
	// CircuitBreakingSupport indicates whether circuit breaking support is
	// enabled, which can be done by setting the environment variable
	// "GRPC_XDS_EXPERIMENTAL_CIRCUIT_BREAKING" to "true".
	CircuitBreakingSupport = strings.EqualFold(os.Getenv(circuitBreakingSupportEnv), "true")
	// TimeoutSupport indicates whether support for max_stream_duration in
	// route actions is enabled.  This can be enabled by setting the
	// environment variable "GRPC_XDS_EXPERIMENTAL_ENABLE_TIMEOUT" to "true".
	TimeoutSupport = strings.EqualFold(os.Getenv(timeoutSupportEnv), "true")
)