globals

type GlobalOpts struct {
	// RunOpts are inlined to allow tests to override parameters without changing ENV variables or flags
	RunOpts
	// Version is the version of the CLI, used in help statements and HTTP requests via "User-Agent".
	// Override this via "-X main.version=XXX"
	Version string
	// EnvoyVersionsURL is the path to the envoy-versions.json. Defaults to DefaultEnvoyVersionsURL
	EnvoyVersionsURL string
	// EnvoyVersion is the default version of Envoy to run. Defaults to the contents of "$ConfigHome/envoy-version".
	// When that file is missing, it is generated from ".latestVersion" from the EnvoyVersionsURL. Its
	// value can be in full version major.minor.patch format, e.g. 1.18.1 or without patch component,
	// major.minor, e.g. 1.18.
	EnvoyVersion version.PatchVersion
	// ConfigHome is the directory containing configuration files. Defaults to DefaultConfigHome
	ConfigHome string
	// DataHome is the directory containing Envoy binaries. Defaults to DefaultDataHome
	DataHome string
	// StateHome is the directory containing persistent state like logs. Defaults to DefaultStateHome
	StateHome string
	// RuntimeDir is the directory for ephemeral runtime files. Defaults to DefaultRuntimeDir
	RuntimeDir string
	// HomeDir is the deprecated FUNC_E_HOME directory. When set, legacy paths are used.
	HomeDir string
	// Quiet means don't Logf to Out
	Quiet bool
	// Out is where status messages are written. Defaults to os.Stdout
	Out io.Writer
	// The platform to target for the Envoy install.
	Platform version.Platform
	// GetEnvoyVersions returns Envoy release versions from EnvoyVersionsURL.
	GetEnvoyVersions version.GetReleaseVersions
}

type RunOpts struct {
	// EnvoyPath is the exec.Cmd path to "envoy". Defaults to "$DataHome/envoy-versions/$version/bin/envoy"
	EnvoyPath string
	// EnvoyOut is where to write Envoy's stdout.
	EnvoyOut io.Writer
	// EnvoyErr is where to write Envoy's stderr.
	EnvoyErr io.Writer
	// RunDir is the per-run directory for logs. Generated from StateHome + runID.
	RunDir string
	// TempDir is the per-run directory for ephemeral files. Generated from RuntimeDir + runID.
	TempDir string
	// RunID is the unique identifier for this run. Used in RunDir and TempDir paths.
	RunID string
	// StartupHook is an experimental hook that runs after Envoy starts.
	StartupHook admin.StartupHook
}