config

Documentation

Index

• Constants
• func AgentConfigDirectory() string
• func AgentConfigFile() string
• func AgentDataDirectory() string
• func AgentDockerLogDriverConfiguration() godocker.LogConfig
• func AgentJSONConfigFile() string
• func AgentRemoteTarballKey() (string, error)
• func AgentRemoteTarballMD5Key() (string, error)
• func AgentTarball() string
• func CacheDirectory() string
• func CacheState() string
• func CgroupMountpoint() string
• func DesiredImageLocatorFile() string
• func DockerUnixSocket() (string, bool)
• func GetAgentPartitionBucketRegion(region string) (string, error)
• func HostCertsDirPath() string
• func HostPKIDirPath() string
• func InstanceConfigDirectory() string
• func InstanceConfigFile() string
• func LogDirectory() string
• func Logger() string
• func RunPrivileged() bool
• func RunningInExternal() bool

Constants

const (
	// AgentImageName is the name of the Docker image containing the Agent
	AgentImageName = "amazon/amazon-ecs-agent:latest"

	// AgentContainerName is the name of the Agent container started by this program
	AgentContainerName = "ecs-agent"

	// AgentLogFile is the name of the log file used by the Agent
	AgentLogFile = "ecs-agent.log"

	UnixSocketPrefix = "unix://"

	// Used to mount /proc for agent container
	ProcFS = "/proc"

	// DefaultAgentVersion is the version of the agent that will be
	// fetched if required. This should look like v1.2.3 or an
	// 8-character sha, as is downloadable from S3.
	DefaultAgentVersion = "v1.60.0"

	// AgentPartitionBucketName is the name of the paritional s3 bucket that stores the agent
	AgentPartitionBucketName = "amazon-ecs-agent"

	// DefaultRegionName is the default region to fall back if the user's region is not a region containing
	// the agent bucket
	DefaultRegionName = endpoints.UsEast1RegionID

	// GPUSupportEnvVar indicates that the AMI has support for GPU
	GPUSupportEnvVar = "ECS_ENABLE_GPU_SUPPORT"

	// DockerHostEnvVar is the environment variable that specifies the location of the Docker daemon socket.
	DockerHostEnvVar = "DOCKER_HOST"

	// ExternalEnvVar is the environment variable for specifying whether we are running in external (non-EC2) environment.
	ExternalEnvVar = "ECS_EXTERNAL"

	// DefaultRegionEnvVar is the environment variable for specifying the default AWS region to use.
	DefaultRegionEnvVar = "AWS_DEFAULT_REGION"
)

Functions

func AgentConfigDirectory

func AgentConfigDirectory() string

AgentConfigDirectory returns the location on disk for configuration

func AgentConfigFile

func AgentConfigFile() string

AgentConfigFile returns the location of a file of environment variables passed to the Agent

func AgentDataDirectory

func AgentDataDirectory() string

AgentDataDirectory returns the location on disk where state should be saved

func AgentDockerLogDriverConfiguration

func AgentDockerLogDriverConfiguration() godocker.LogConfig

AgentDockerLogDriverConfiguration returns a LogConfig object suitable for used with the managed container.

func AgentJSONConfigFile

func AgentJSONConfigFile() string

AgentJSONConfigFile returns the location of a file containing configuration expressed in JSON

func AgentRemoteTarballKey

func AgentRemoteTarballKey() (string, error)

AgentRemoteTarballKey is the remote filename of the Agent image, used for populating the cache

func AgentRemoteTarballMD5Key

func AgentRemoteTarballMD5Key() (string, error)

AgentRemoteTarballMD5Key is the remote file of a md5sum used to verify the integrity of the AgentRemoteTarball

func AgentTarball

func AgentTarball() string

AgentTarball returns the location on disk of the cached Agent image

func CacheDirectory

func CacheDirectory() string

CacheDirectory returns the location on disk where Agent images should be cached

func CacheState

func CacheState() string

CacheState returns the location on disk where cache state is stored

func CgroupMountpoint

func CgroupMountpoint() string

CgroupMountpoint returns the cgroup mountpoint for the system

func DesiredImageLocatorFile

func DesiredImageLocatorFile() string

DesiredImageLocatorFile returns the location on disk of a well-known file describing an Agent image to load

func DockerUnixSocket

func DockerUnixSocket() (string, bool)

DockerUnixSocket returns the docker socket endpoint and whether it's read from DockerHostEnvVar

func GetAgentPartitionBucketRegion

func GetAgentPartitionBucketRegion(region string) (string, error)

GetAgentPartitionBucketRegion returns the s3 bucket region where ECS Agent artifact is located

func HostCertsDirPath

func HostCertsDirPath() string

HostCertsDirPath() returns the CA store path on the host

func HostPKIDirPath

func HostPKIDirPath() string

HostPKIDirPath() returns the CA store path on the host

func InstanceConfigDirectory

func InstanceConfigDirectory() string

InstanceConfigDirectory returns the location on disk for custom instance configuration

func InstanceConfigFile

func InstanceConfigFile() string

InstanceConfigFile returns the location of a file of custom environment variables

func LogDirectory

func LogDirectory() string

LogDirectory returns the location on disk where logs should be placed

func Logger

func Logger() string

Logger holds the bundled log configuration for seelog

func RunPrivileged

func RunPrivileged() bool

RunPrivileged returns if agent should be invoked with '--privileged'. This is not recommended and may be removed in future versions of amazon-ecs-init.

func RunningInExternal

func RunningInExternal() bool

RunningInExternal returns whether we are running in external (non-EC2) environment.