env

Documentation

Overview

Package env provides the environment variables for the installer.

Index

• Constants
• func GetHTTPClient() *http.Client
• type ApmLibLanguage
• type ApmLibVersion
• type Env
  • func FromConfig(config model.Reader) *Env
  • func FromEnv() *Env
  • func (e *Env) ToEnv() []string
• type InstallScriptEnv

Constants

const (
	// APMInstrumentationEnabledAll enables APM instrumentation for all containers.
	APMInstrumentationEnabledAll = "all"
	// APMInstrumentationEnabledDocker enables APM instrumentation for Docker containers.
	APMInstrumentationEnabledDocker = "docker"
	// APMInstrumentationEnabledHost enables APM instrumentation for the host.
	APMInstrumentationEnabledHost = "host"
	// APMInstrumentationNotSet is the default value when the environment variable is not set.
	APMInstrumentationNotSet = "not_set"
)

Functions

func GetHTTPClient

func GetHTTPClient() *http.Client

GetHTTPClient returns an HTTP client with the proxy settings loaded from the environment.

Types

type ApmLibLanguage

type ApmLibLanguage string

ApmLibLanguage is a language defined in DD_APM_INSTRUMENTATION_LIBRARIES env var

type ApmLibVersion

type ApmLibVersion string

ApmLibVersion is the version of the library defined in DD_APM_INSTRUMENTATION_LIBRARIES env var

type Env

type Env struct {
	APIKey         string
	Site           string
	RemoteUpdates  bool
	RemotePolicies bool

	Mirror                      string
	RegistryOverride            string
	RegistryAuthOverride        string
	RegistryUsername            string
	RegistryPassword            string
	RegistryOverrideByImage     map[string]string
	RegistryAuthOverrideByImage map[string]string
	RegistryUsernameByImage     map[string]string
	RegistryPasswordByImage     map[string]string

	DefaultPackagesInstallOverride map[string]bool
	DefaultPackagesVersionOverride map[string]string

	ApmLibraries map[ApmLibLanguage]ApmLibVersion

	AgentMajorVersion string
	AgentMinorVersion string
	AgentUserName     string // windows only

	InstallScript InstallScriptEnv

	CDNEnabled      bool
	CDNLocalDirPath string

	Tags     []string
	Hostname string

	HTTPProxy  string
	HTTPSProxy string
	NoProxy    string
}

Env contains the configuration for the installer.

func FromConfig

func FromConfig(config model.Reader) *Env

FromConfig returns an Env struct with values from the configuration.

func FromEnv

func FromEnv() *Env

FromEnv returns an Env struct with values from the environment.

func (*Env) ToEnv

func (e *Env) ToEnv() []string

ToEnv returns a slice of environment variables from the Env struct.

type InstallScriptEnv

type InstallScriptEnv struct {
	APMInstrumentationEnabled string
}

InstallScriptEnv contains the environment variables for the install script.