package envoy

import "github.com/hashicorp/nomad/helper/envoy"

Package envoy provides a high level view of the variables that go into selecting an envoy version.

Index

Constants

const (
	// SidecarMetaParam is the parameter name used to configure the connect sidecar
	// at the client level. Setting this option in client configuration takes the
	// lowest precedence.
	//
	// If this meta option is not set in client configuration, it defaults to
	// ImageFormat, so that Nomad will defer envoy version selection to Consul.
	SidecarMetaParam = "connect.sidecar_image"

	// SidecarConfigVar is used as the default config.image value for connect
	// sidecar proxies, when they are injected in the job connect mutator.
	SidecarConfigVar = "${meta." + SidecarMetaParam + "}"

	// GatewayMetaParam is the parameter name used to configure the connect gateway
	// at the client level. Setting this option in client configuration takes the
	// lowest precedence.
	//
	// If this meta option is not set in client configuration, it defaults to
	// ImageFormat, so that Nomad will defer envoy version selection to Consul.
	GatewayMetaParam = "connect.gateway_image"

	// GatewayConfigVar is used as the default config.image value for connect
	// gateway proxies, when they are injected in the job connect mutator.
	GatewayConfigVar = "${meta." + GatewayMetaParam + "}"

	// ImageFormat is the default format string used for official envoy Docker
	// images with the tag being the semver of the version of envoy. Nomad fakes
	// interpolation of ${NOMAD_envoy_version} by replacing it with the version
	// string for envoy that Consul reports as preferred.
	//
	// Folks wanting to build and use custom images while still having Nomad refer
	// to specific versions as preferred by Consul would set meta.connect.sidecar_image
	// to something like: "custom/envoy:${NOMAD_envoy_version}".
	ImageFormat = "docker.io/envoyproxy/envoy:v" + VersionVar

	// VersionVar will be replaced with the Envoy version string when
	// used in the meta.connect.sidecar_image variable.
	VersionVar = "${NOMAD_envoy_version}"

	// DefaultConnectLogLevel is the log level set in the node meta by default
	// to be used by Consul Connect sidecar tasks.
	DefaultConnectLogLevel = "info"

	// DefaultConnectLogLevel is the node attribute for the DefaultConnectLogLevel
	DefaultConnectLogLevelParam = "connect.log_level"

	// DefaultConnectProxyConcurrency is the default number of worker threads the
	// connect sidecar should be configured to use.
	//
	// https://www.envoyproxy.io/docs/envoy/latest/operations/cli#cmdoption-concurrency
	DefaultConnectProxyConcurrency = "1"

	// DefaultConnectProxyConcurrencyParam is the node attribute for the
	// DefaultConnectProxyConcurrency
	DefaultConnectProxyConcurrencyParam = "connect.proxy_concurrency"

	// DefaultTransparentProxyUID is the default UID of the Envoy proxy
	// container user, for use with transparent proxy
	DefaultTransparentProxyUID = "101"

	// DefaultTransparentProxyUIDParam is the node attribute for the
	// DefaultTransparentProxyUID
	DefaultTransparentProxyUIDParam = "connect.transparent_proxy.default_uid"

	// DefaultTransparentProxyOutboundPort is the default outbound port for the
	// Envoy proxy, for use with transparent proxy. Note the default value
	// patches the default TransparentProxy service default for
	// OutboundListenerPort. If the cluster admin sets this value to something
	// non-default, they'll need to update the metadata on all the nodes to
	// match. See also:
	// https://developer.hashicorp.com/consul/docs/connect/config-entries/service-defaults#transparentproxy
	DefaultTransparentProxyOutboundPort = "15001"

	// DefaultTransparentProxyOutboundPortParam is the node attribute for the
	// DefaultTransparentProxyOutboundPort
	DefaultTransparentProxyOutboundPortParam = "connect.transparent_proxy.default_outbound_port"
)

Functions

func PortLabel

func PortLabel(prefix, service, suffix string) string

PortLabel creates a consistent port label using the inputs of a prefix, service name, and optional suffix. The prefix should be the Kind part of TaskKind the envoy is being configured for.

Source Files

envoy.go

Version
v1.10.0 (latest)
Published
Apr 9, 2025
Platform
linux/amd64
Imports
1 packages
Last checked
2 days ago

Tools for package owners.