Help us shape the future of Go! Take the 2026 Go Developer Survey

bootstrap

package
v1.8.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 26, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// EnvoyAdminAddress is the listening v4 address of the envoy admin interface.
	EnvoyAdminAddress   = "127.0.0.1"
	EnvoyAdminAddressV6 = "::1"
	// EnvoyAdminPort is the port used to expose admin interface.
	EnvoyAdminPort = 19000

	// DefaultXdsServerPort is the default listening port of the xds-server.
	DefaultXdsServerPort = 18000

	EnvoyStatsPort = 19001

	EnvoyReadinessPort = 19003
	EnvoyReadinessPath = "/ready"
)

Variables

This section is empty.

Functions

func ApplyBootstrapConfig added in v0.6.0

func ApplyBootstrapConfig(boostrapConfig *egv1a1.ProxyBootstrap, defaultBootstrap string) (string, error)

ApplyBootstrapConfig applies the bootstrap config to the default bootstrap config and return the result config. The defaultBootstrap is expected to be a YAML string

func GetRenderedBootstrapConfig

func GetRenderedBootstrapConfig(opts *RenderBootstrapConfigOptions) (string, error)

GetRenderedBootstrapConfig renders the bootstrap YAML string

func Validate added in v1.2.0

func Validate(boostrapConfig *egv1a1.ProxyBootstrap) error

Validate ensures that after applying the provided bootstrap configuration, the resulting bootstrap is still OK. This code previously was part of the validate logic in api/v1alpha1/validate, but was moved here to prevent code in the api packages from accessing code from the internal packages.

Types

type MetricSink added in v1.7.0

type MetricSink struct {
	// Address is the address of the metrics sink.
	Address string
	// Port is the port of the metrics sink.
	Port uint32
	// Authority is the gRPC authority header value (typically SNI or hostname).
	Authority string
	// ReportCountersAsDeltas configures counters to use delta temporality.
	ReportCountersAsDeltas bool
	// ReportHistogramsAsDeltas configures histograms to use delta temporality.
	ReportHistogramsAsDeltas bool
	// Headers is a list of headers to send with OTLP export requests.
	Headers []gwapiv1.HTTPHeader
	// ResourceAttributes is a map of resource attributes for the metrics sink.
	ResourceAttributes map[string]string
	// TLS contains upstream TLS configuration for the metrics sink.
	// Nil means no TLS.
	TLS *MetricSinkTLS
}

MetricSink defines an OpenTelemetry metrics sink destination for template rendering.

type MetricSinkTLS added in v1.7.0

type MetricSinkTLS struct {
	// SNI is the Server Name Indication for TLS.
	SNI string
	// UseSystemTrustStore indicates whether to use the system CA trust store.
	UseSystemTrustStore bool
	// CACertificate is the CA certificate for validating the upstream TLS certificate.
	// When set, this takes precedence over UseSystemTrustStore.
	CACertificate []byte
}

MetricSinkTLS defines TLS settings for a metrics sink.

type RenderBootstrapConfigOptions added in v1.1.0

type RenderBootstrapConfigOptions struct {
	IPFamily     *egv1a1.IPFamily
	ProxyMetrics *egv1a1.ProxyMetrics
	// TODO: remove after deprecating host/port in favor of backendRefs.
	ResolvedMetricSinks      []MetricSink
	SdsConfig                SdsConfigPath
	ServiceClusterName       *string
	XdsServerHost            *string
	XdsServerPort            *int32
	AdminServerPort          *int32
	StatsServerPort          *int32
	MaxHeapSizeBytes         uint64
	GatewayNamespaceMode     bool
	TopologyInjectorDisabled bool
	ServiceAccountTokenPath  string
}

type SdsConfigPath added in v1.2.0

type SdsConfigPath struct {
	Certificate string
	TrustedCA   string
	// ServiceAccountToken is the path to the service account token file used for authentication in GatewayNamespaceMode.
	ServiceAccountToken string
}

type StatsMatcherParameters added in v0.6.0

type StatsMatcherParameters struct {
	Exacts             []string
	Prefixes           []string
	Suffixes           []string
	RegularExpressions []string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL