Documentation ¶
Index ¶
- Constants
- type ASMAuthData
- type Container
- func (c *Container) AWSLogAuthExecutionRole() bool
- func (c *Container) BuildContainerDependency(contName string, satisfiedStatus apicontainerstatus.ContainerStatus, ...)
- func (c *Container) BuildResourceDependency(resourceName string, requiredStatus resourcestatus.ResourceStatus, ...)
- func (c *Container) DesiredTerminal() bool
- func (c *Container) GetAppliedStatus() apicontainerstatus.ContainerStatus
- func (c *Container) GetCreatedAt() time.Time
- func (c *Container) GetDesiredStatus() apicontainerstatus.ContainerStatus
- func (c *Container) GetFinishedAt() time.Time
- func (c *Container) GetHealthStatus() HealthStatus
- func (c *Container) GetKnownExitCode() *int
- func (c *Container) GetKnownPortBindings() []PortBinding
- func (c *Container) GetKnownStatus() apicontainerstatus.ContainerStatus
- func (c *Container) GetLabels() map[string]string
- func (c *Container) GetNetworkMode() string
- func (c *Container) GetNetworkSettings() *types.NetworkSettings
- func (c *Container) GetNextKnownStateProgression() apicontainerstatus.ContainerStatus
- func (c *Container) GetSentStatus() apicontainerstatus.ContainerStatus
- func (c *Container) GetStartTimeout() time.Duration
- func (c *Container) GetStartedAt() time.Time
- func (c *Container) GetSteadyStateStatus() apicontainerstatus.ContainerStatus
- func (c *Container) GetStopTimeout() time.Duration
- func (c *Container) GetV3EndpointID() string
- func (c *Container) GetVolumes() []types.MountPoint
- func (c *Container) HasSecretAsEnvOrLogDriver() bool
- func (c *Container) HealthStatusShouldBeReported() bool
- func (c *Container) InjectV3MetadataEndpoint()
- func (c *Container) IsEssential() bool
- func (c *Container) IsInternal() bool
- func (c *Container) IsKnownSteadyState() bool
- func (c *Container) IsMetadataFileUpdated() bool
- func (c *Container) IsRunning() bool
- func (c *Container) KnownTerminal() bool
- func (c *Container) MergeEnvironmentVariables(envVars map[string]string)
- func (c *Container) SetASMDockerAuthConfig(dac types.AuthConfig)
- func (c *Container) SetAppliedStatus(status apicontainerstatus.ContainerStatus) bool
- func (c *Container) SetCreatedAt(createdAt time.Time)
- func (c *Container) SetDesiredStatus(status apicontainerstatus.ContainerStatus)
- func (c *Container) SetFinishedAt(finishedAt time.Time)
- func (c *Container) SetHealthStatus(health HealthStatus)
- func (c *Container) SetKnownExitCode(i *int)
- func (c *Container) SetKnownPortBindings(ports []PortBinding)
- func (c *Container) SetKnownStatus(status apicontainerstatus.ContainerStatus)
- func (c *Container) SetLabels(labels map[string]string)
- func (c *Container) SetMetadataFileUpdated()
- func (c *Container) SetNetworkMode(networkMode string)
- func (c *Container) SetNetworkSettings(networks *types.NetworkSettings)
- func (c *Container) SetRegistryAuthCredentials(credential credentials.IAMRoleCredentials)
- func (c *Container) SetSentStatus(status apicontainerstatus.ContainerStatus)
- func (c *Container) SetStartedAt(startedAt time.Time)
- func (c *Container) SetV3EndpointID(v3EndpointID string)
- func (c *Container) SetVolumes(volumes []types.MountPoint)
- func (c *Container) ShouldCreateWithASMSecret() bool
- func (c *Container) ShouldCreateWithSSMSecret() bool
- func (c *Container) ShouldPullWithASMAuth() bool
- func (c *Container) ShouldPullWithExecutionRole() bool
- func (c *Container) String() string
- type ContainerDependency
- type ContainerOverrides
- type ContainerOverridesCopy
- type ContainerType
- type DependsOn
- type DockerConfig
- type DockerContainer
- type DockerEventType
- type ECRAuthData
- type HealthStatus
- type MountPoint
- type PortBinding
- type RegistryAuthenticationData
- type ResourceDependency
- type Secret
- type TransitionDependenciesMap
- type TransitionDependencySet
- type TransportProtocol
- type VolumeFrom
Constants ¶
const ( // DockerHealthCheckType is the type of container health check provided by docker DockerHealthCheckType = "docker" // AuthTypeECR is to use image pull auth over ECR AuthTypeECR = "ecr" // AuthTypeASM is to use image pull auth over AWS Secrets Manager AuthTypeASM = "asm" // MetadataURIEnvironmentVariableName defines the name of the environment // variable in containers' config, which can be used by the containers to access the // v3 metadata endpoint MetadataURIEnvironmentVariableName = "ECS_CONTAINER_METADATA_URI" // MetadataURIFormat defines the URI format for v3 metadata endpoint MetadataURIFormat = "http://169.254.170.2/v3/%s" // SecretProviderSSM is to show secret provider being SSM SecretProviderSSM = "ssm" // SecretProviderASM is to show secret provider being ASM SecretProviderASM = "asm" // SecretTypeEnv is to show secret type being ENVIRONMENT_VARIABLE SecretTypeEnv = "ENVIRONMENT_VARIABLE" // TargetLogDriver is to show secret target being "LOG_DRIVER", the default will be "CONTAINER" SecretTargetLogDriver = "LOG_DRIVER" )
const ( // UnrecognizedTransportProtocolErrorName is an error where the protocol of the binding is invalid UnrecognizedTransportProtocolErrorName = "UnrecognizedTransportProtocol" // UnparseablePortErrorName is an error where the port configuration is invalid UnparseablePortErrorName = "UnparsablePort" )
const ( // DockerContainerMinimumMemoryInBytes is the minimum amount of // memory to be allocated to a docker container DockerContainerMinimumMemoryInBytes = 4 * 1024 * 1024 // 4MB )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ASMAuthData ¶
type ASMAuthData struct { // CredentialsParameter is set by ACS and specifies the name of the // parameter to retrieve from ASM CredentialsParameter string `json:"credentialsParameter"` // Region is set by ACS and specifies the region to fetch the // secret from Region string `json:"region"` // contains filtered or unexported fields }
ASMAuthData is the authentication data required for Docker private registry auth
func (*ASMAuthData) GetDockerAuthConfig ¶
func (auth *ASMAuthData) GetDockerAuthConfig() types.AuthConfig
GetDockerAuthConfig returns the pull credentials in the auth
func (*ASMAuthData) SetDockerAuthConfig ¶
func (auth *ASMAuthData) SetDockerAuthConfig(dac types.AuthConfig)
SetDockerAuthConfig sets the credentials to pull from ECR in the auth
type Container ¶
type Container struct { // Name is the name of the container specified in the task definition Name string // DependsOn is the field which specifies the ordering for container startup and shutdown. DependsOn []DependsOn `json:"dependsOn,omitempty"` // V3EndpointID is a container identifier used to construct v3 metadata endpoint; it's unique among // all the containers managed by the agent V3EndpointID string // Image is the image name specified in the task definition Image string // ImageID is the local ID of the image used in the container ImageID string // Command is the command to run in the container which is specified in the task definition Command []string // CPU is the cpu limitation of the container which is specified in the task definition CPU uint `json:"Cpu"` // GPUIDs is the list of GPU ids for a container GPUIDs []string // Memory is the memory limitation of the container which is specified in the task definition Memory uint // Links contains a list of containers to link, corresponding to docker option: --link Links []string // VolumesFrom contains a list of container's volume to use, corresponding to docker option: --volumes-from VolumesFrom []VolumeFrom `json:"volumesFrom"` // MountPoints contains a list of volume mount paths MountPoints []MountPoint `json:"mountPoints"` // Ports contains a list of ports binding configuration Ports []PortBinding `json:"portMappings"` // Secrets contains a list of secret Secrets []Secret `json:"secrets"` // Essential denotes whether the container is essential or not Essential bool // EntryPoint is entrypoint of the container, corresponding to docker option: --entrypoint EntryPoint *[]string // Environment is the environment variable set in the container Environment map[string]string `json:"environment"` // Overrides contains the configuration to override of a container Overrides ContainerOverrides `json:"overrides"` // DockerConfig is the configuration used to create the container DockerConfig DockerConfig `json:"dockerConfig"` // RegistryAuthentication is the auth data used to pull image RegistryAuthentication *RegistryAuthenticationData `json:"registryAuthentication"` // HealthCheckType is the mechanism to use for the container health check // currently it only supports 'DOCKER' HealthCheckType string `json:"healthCheckType,omitempty"` // Health contains the health check information of container health check Health HealthStatus `json:"-"` // LogsAuthStrategy specifies how the logs driver for the container will be // authenticated LogsAuthStrategy string // StartTimeout specifies the time value after which if a container has a dependency // on another container and the dependency conditions are 'SUCCESS', 'COMPLETE', 'HEALTHY', // then that dependency will not be resolved. StartTimeout uint // StopTimeout specifies the time value to be passed as StopContainer api call StopTimeout uint // DesiredStatusUnsafe represents the state where the container should go. Generally, // the desired status is informed by the ECS backend as a result of either // API calls made to ECS or decisions made by the ECS service scheduler, // though the agent may also set the DesiredStatusUnsafe if a different "essential" // container in the task exits. The DesiredStatus is almost always either // ContainerRunning or ContainerStopped. // NOTE: Do not access DesiredStatusUnsafe directly. Instead, use `GetDesiredStatus` // and `SetDesiredStatus`. // TODO DesiredStatusUnsafe should probably be private with appropriately written // setter/getter. When this is done, we need to ensure that the UnmarshalJSON // is handled properly so that the state storage continues to work. DesiredStatusUnsafe apicontainerstatus.ContainerStatus `json:"desiredStatus"` // KnownStatusUnsafe represents the state where the container is. // NOTE: Do not access `KnownStatusUnsafe` directly. Instead, use `GetKnownStatus` // and `SetKnownStatus`. // TODO KnownStatusUnsafe should probably be private with appropriately written // setter/getter. When this is done, we need to ensure that the UnmarshalJSON // is handled properly so that the state storage continues to work. KnownStatusUnsafe apicontainerstatus.ContainerStatus `json:"KnownStatus"` // TransitionDependenciesMap is a map of the dependent container status to other // dependencies that must be satisfied in order for this container to transition. TransitionDependenciesMap TransitionDependenciesMap `json:"TransitionDependencySet"` // SteadyStateDependencies is a list of containers that must be in "steady state" before // this one is created // Note: Current logic requires that the containers specified here are run // before this container can even be pulled. // // Deprecated: Use TransitionDependencySet instead. SteadyStateDependencies is retained for compatibility with old // state files. SteadyStateDependencies []string `json:"RunDependencies"` // Type specifies the container type. Except the 'Normal' type, all other types // are not directly specified by task definitions, but created by the agent. The // JSON tag is retained as this field's previous name 'IsInternal' for maintaining // backwards compatibility. Please see JSON parsing hooks for this type for more // details Type ContainerType `json:"IsInternal"` // AppliedStatus is the status that has been "applied" (e.g., we've called Pull, // Create, Start, or Stop) but we don't yet know that the application was successful. // No need to save it in the state file, as agent will synchronize the container status // on restart and for some operation eg: pull, it has to be recalled again. AppliedStatus apicontainerstatus.ContainerStatus `json:"-"` // ApplyingError is an error that occurred trying to transition the container // to its desired state. It is propagated to the backend in the form // 'Name: ErrorString' as the 'reason' field. ApplyingError *apierrors.DefaultNamedError // SentStatusUnsafe represents the last KnownStatusUnsafe that was sent to the ECS // SubmitContainerStateChange API. // TODO SentStatusUnsafe should probably be private with appropriately written // setter/getter. When this is done, we need to ensure that the UnmarshalJSON is // handled properly so that the state storage continues to work. SentStatusUnsafe apicontainerstatus.ContainerStatus `json:"SentStatus"` // MetadataFileUpdated is set to true when we have completed updating the // metadata file MetadataFileUpdated bool `json:"metadataFileUpdated"` // KnownExitCodeUnsafe specifies the exit code for the container. // It is exposed outside of the package so that it's marshalled/unmarshalled in // the JSON body while saving the state. // NOTE: Do not access KnownExitCodeUnsafe directly. Instead, use `GetKnownExitCode` // and `SetKnownExitCode`. KnownExitCodeUnsafe *int `json:"KnownExitCode"` // KnownPortBindingsUnsafe is an array of port bindings for the container. KnownPortBindingsUnsafe []PortBinding `json:"KnownPortBindings"` // VolumesUnsafe is an array of volume mounts in the container. VolumesUnsafe []types.MountPoint `json:"-"` // NetworkModeUnsafe is the network mode in which the container is started NetworkModeUnsafe string `json:"-"` // NetworksUnsafe denotes the Docker Network Settings in the container. NetworkSettingsUnsafe *types.NetworkSettings `json:"-"` // SteadyStateStatusUnsafe specifies the steady state status for the container // If uninitialized, it's assumed to be set to 'ContainerRunning'. Even though // it's not only supposed to be set when the container is being created, it's // exposed outside of the package so that it's marshalled/unmarshalled in the // the JSON body while saving the state SteadyStateStatusUnsafe *apicontainerstatus.ContainerStatus `json:"SteadyStateStatus,omitempty"` // contains filtered or unexported fields }
Container is the internal representation of a container in the ECS agent
func NewContainerWithSteadyState ¶
func NewContainerWithSteadyState(steadyState apicontainerstatus.ContainerStatus) *Container
NewContainerWithSteadyState creates a new Container object with the specified steady state. Containers that need the non default steady state set will use this method instead of setting it directly
func (*Container) AWSLogAuthExecutionRole ¶
AWSLogAuthExecutionRole returns true if the auth is by execution role
func (*Container) BuildContainerDependency ¶
func (c *Container) BuildContainerDependency(contName string, satisfiedStatus apicontainerstatus.ContainerStatus, dependentStatus apicontainerstatus.ContainerStatus)
BuildContainerDependency adds a new dependency container and satisfied status to the dependent container
func (*Container) BuildResourceDependency ¶
func (c *Container) BuildResourceDependency(resourceName string, requiredStatus resourcestatus.ResourceStatus, dependentStatus apicontainerstatus.ContainerStatus)
BuildResourceDependency adds a new resource dependency by taking in the required status of the resource that satisfies the dependency and the dependent container status, whose transition is dependent on the resource. example: if container's PULLED transition is dependent on volume resource's CREATED status, then RequiredStatus=VolumeCreated and dependentStatus=ContainerPulled
func (*Container) DesiredTerminal ¶
DesiredTerminal returns true if the container's desired status is STOPPED
func (*Container) GetAppliedStatus ¶
func (c *Container) GetAppliedStatus() apicontainerstatus.ContainerStatus
GetAppliedStatus returns the transitioning status of container
func (*Container) GetCreatedAt ¶
GetCreatedAt sets the timestamp for container's creation time
func (*Container) GetDesiredStatus ¶
func (c *Container) GetDesiredStatus() apicontainerstatus.ContainerStatus
GetDesiredStatus gets the desired status of the container
func (*Container) GetFinishedAt ¶
GetFinishedAt sets the timestamp for container's stopped time
func (*Container) GetHealthStatus ¶
func (c *Container) GetHealthStatus() HealthStatus
GetHealthStatus returns the container health information
func (*Container) GetKnownExitCode ¶
GetKnownExitCode returns the container exit code
func (*Container) GetKnownPortBindings ¶
func (c *Container) GetKnownPortBindings() []PortBinding
GetKnownPortBindings gets the ports for a container
func (*Container) GetKnownStatus ¶
func (c *Container) GetKnownStatus() apicontainerstatus.ContainerStatus
GetKnownStatus returns the known status of the container
func (*Container) GetNetworkMode ¶
GetNetworkMode returns the network mode of the container
func (*Container) GetNetworkSettings ¶
func (c *Container) GetNetworkSettings() *types.NetworkSettings
GetNetworkSettings returns the networks field in a container
func (*Container) GetNextKnownStateProgression ¶
func (c *Container) GetNextKnownStateProgression() apicontainerstatus.ContainerStatus
GetNextKnownStateProgression returns the state that the container should progress to based on its `KnownState`. The progression is incremental until the container reaches its steady state. From then on, it transitions to `ContainerStopped`.
For example: a. if the steady state of the container is defined as `ContainerRunning`, the progression is: Container: None -> Pulled -> Created -> Running* -> Stopped -> Zombie
b. if the steady state of the container is defined as `ContainerResourcesProvisioned`, the progression is: Container: None -> Pulled -> Created -> Running -> Provisioned* -> Stopped -> Zombie
c. if the steady state of the container is defined as `ContainerCreated`, the progression is: Container: None -> Pulled -> Created* -> Stopped -> Zombie
func (*Container) GetSentStatus ¶
func (c *Container) GetSentStatus() apicontainerstatus.ContainerStatus
GetSentStatus safely returns the SentStatusUnsafe of the container
func (*Container) GetStartTimeout ¶
func (*Container) GetStartedAt ¶
GetStartedAt sets the timestamp for container's start time
func (*Container) GetSteadyStateStatus ¶
func (c *Container) GetSteadyStateStatus() apicontainerstatus.ContainerStatus
GetSteadyStateStatus returns the steady state status for the container. If Container.steadyState is not initialized, the default steady state status defined by `defaultContainerSteadyStateStatus` is returned. The 'pause' container's steady state differs from that of other containers, as the 'pause' container can reach its teady state once networking resources have been provisioned for it, which is done in the `ContainerResourcesProvisioned` state
func (*Container) GetStopTimeout ¶
func (*Container) GetV3EndpointID ¶
GetV3EndpointID returns the v3 endpoint id of container
func (*Container) GetVolumes ¶
func (c *Container) GetVolumes() []types.MountPoint
GetVolumes returns the volumes mounted in a container
func (*Container) HasSecretAsEnvOrLogDriver ¶
func (*Container) HealthStatusShouldBeReported ¶
HealthStatusShouldBeReported returns true if the health check is defined in the task definition
func (*Container) InjectV3MetadataEndpoint ¶
func (c *Container) InjectV3MetadataEndpoint()
InjectV3MetadataEndpoint injects the v3 metadata endpoint as an environment variable for a container
func (*Container) IsEssential ¶
IsEssential returns whether the container is an essential container or not
func (*Container) IsInternal ¶
IsInternal returns true if the container type is `ContainerCNIPause` or `ContainerNamespacePause`. It returns false otherwise
func (*Container) IsKnownSteadyState ¶
IsKnownSteadyState returns true if the `KnownState` of the container equals the `steadyState` defined for the container
func (*Container) IsMetadataFileUpdated ¶
IsMetadataFileUpdated returns true if the metadata file has been once the metadata file is ready and will no longer change
func (*Container) IsRunning ¶
IsRunning returns true if the container's known status is either RUNNING or RESOURCES_PROVISIONED. It returns false otherwise
func (*Container) KnownTerminal ¶
KnownTerminal returns true if the container's known status is STOPPED
func (*Container) MergeEnvironmentVariables ¶
MergeEnvironmentVariables appends additional envVarName:envVarValue pairs to the the container's enviornment values structure
func (*Container) SetASMDockerAuthConfig ¶
func (c *Container) SetASMDockerAuthConfig(dac types.AuthConfig)
SetASMDockerAuthConfig add the docker auth config data to the RegistryAuthentication struct held by the container, this is then passed down to the docker client to pull the image
func (*Container) SetAppliedStatus ¶
func (c *Container) SetAppliedStatus(status apicontainerstatus.ContainerStatus) bool
SetAppliedStatus sets the applied status of container and returns whether the container is already in a transition
func (*Container) SetCreatedAt ¶
SetCreatedAt sets the timestamp for container's creation time
func (*Container) SetDesiredStatus ¶
func (c *Container) SetDesiredStatus(status apicontainerstatus.ContainerStatus)
SetDesiredStatus sets the desired status of the container
func (*Container) SetFinishedAt ¶
SetFinishedAt sets the timestamp for container's stopped time
func (*Container) SetHealthStatus ¶
func (c *Container) SetHealthStatus(health HealthStatus)
SetHealthStatus sets the container health status
func (*Container) SetKnownExitCode ¶
SetKnownExitCode sets exit code field in container struct
func (*Container) SetKnownPortBindings ¶
func (c *Container) SetKnownPortBindings(ports []PortBinding)
SetKnownPortBindings sets the ports for a container
func (*Container) SetKnownStatus ¶
func (c *Container) SetKnownStatus(status apicontainerstatus.ContainerStatus)
SetKnownStatus sets the known status of the container and update the container applied status
func (*Container) SetMetadataFileUpdated ¶
func (c *Container) SetMetadataFileUpdated()
SetMetadataFileUpdated sets the container's MetadataFileUpdated status to true
func (*Container) SetNetworkMode ¶
SetNetworkMode sets the network mode of the container
func (*Container) SetNetworkSettings ¶
func (c *Container) SetNetworkSettings(networks *types.NetworkSettings)
SetNetworkSettings sets the networks field in a container
func (*Container) SetRegistryAuthCredentials ¶
func (c *Container) SetRegistryAuthCredentials(credential credentials.IAMRoleCredentials)
SetRegistryAuthCredentials sets the credentials for pulling image from ECR
func (*Container) SetSentStatus ¶
func (c *Container) SetSentStatus(status apicontainerstatus.ContainerStatus)
SetSentStatus safely sets the SentStatusUnsafe of the container
func (*Container) SetStartedAt ¶
SetStartedAt sets the timestamp for container's start time
func (*Container) SetV3EndpointID ¶
SetV3EndpointID sets the v3 endpoint id of container
func (*Container) SetVolumes ¶
func (c *Container) SetVolumes(volumes []types.MountPoint)
SetVolumes sets the volumes mounted in a container
func (*Container) ShouldCreateWithASMSecret ¶
ShouldCreateWithASMSecret returns true if this container needs to get secret value from AWS Secrets Manager
func (*Container) ShouldCreateWithSSMSecret ¶
ShouldCreateWithSSMSecret returns true if this container needs to get secret value from SSM Parameter Store
func (*Container) ShouldPullWithASMAuth ¶
ShouldPullWithASMAuth returns true if this container needs to retrieve private registry authentication data from ASM
func (*Container) ShouldPullWithExecutionRole ¶
ShouldPullWithExecutionRole returns whether this container has its own ECR credentials
type ContainerDependency ¶
type ContainerDependency struct { // ContainerName defines the container on which a transition depends ContainerName string `json:"ContainerName"` // SatisfiedStatus defines the status that satisfies the dependency SatisfiedStatus apicontainerstatus.ContainerStatus `json:"SatisfiedStatus"` // DependentStatus defines the status that cannot be reached until the // resource satisfies the dependency DependentStatus apicontainerstatus.ContainerStatus `json:"DependentStatus,omitempty"` }
ContainerDependency defines the relationship between a dependent container and its dependency.
type ContainerOverrides ¶
type ContainerOverrides struct {
Command *[]string `json:"command"`
}
ContainerOverrides are overrides applied to the container
func (*ContainerOverrides) UnmarshalJSON ¶
func (overrides *ContainerOverrides) UnmarshalJSON(b []byte) error
UnmarshalJSON overrides the logic for parsing the JSON-encoded ContainerOverrides data This custom unmarshaller is needed because the json sent to us as a string rather than a fully typed object. We support both formats in the hopes that one day everything will be fully typed Note: the `json:",string"` tag DOES NOT apply here; it DOES NOT work with struct types, only ints/floats/etc. We're basically doing that though We also intentionally fail if there are any keys we were unable to unmarshal into our struct
type ContainerOverridesCopy ¶
type ContainerOverridesCopy ContainerOverrides
ContainerOverridesCopy is a type alias that doesn't have a custom unmarshaller so we can unmarshal ContainerOverrides data into something without recursing
type ContainerType ¶
type ContainerType int32
ContainerType represents the type of the internal container created
const ( // ContainerNormal represents the container type for 'Normal' containers // These are the ones specified in the task definition via container // definitions ContainerNormal ContainerType = iota // ContainerEmptyHostVolume represents the internal container type // for the empty volumes container ContainerEmptyHostVolume // ContainerCNIPause represents the internal container type for the // pause container ContainerCNIPause // ContainerNamespacePause represents the internal container type for // sharing either PID or IPC resource namespaces. Regardless if one or // both flags are used, only 1 of these containers need to be active ContainerNamespacePause )
func (*ContainerType) MarshalJSON ¶
func (containerType *ContainerType) MarshalJSON() ([]byte, error)
MarshalJSON overrides the logic for JSON-encoding a ContainerType object
func (ContainerType) String ¶
func (containerType ContainerType) String() string
String converts the container type enum to a string
func (*ContainerType) UnmarshalJSON ¶
func (containerType *ContainerType) UnmarshalJSON(b []byte) error
UnmarshalJSON decodes the container type field in the JSON encoded string into the ContainerType object
type DockerConfig ¶
type DockerConfig struct { // Config is the configuration used to create container Config *string `json:"config"` // HostConfig is the configuration of container related to host resource HostConfig *string `json:"hostConfig"` // Version specifies the docker client API version to use Version *string `json:"version"` }
DockerConfig represents additional metadata about a container to run. It's remodeled from the `ecsacs` api model file. Eventually it should not exist once this remodeling is refactored out.
type DockerContainer ¶
type DockerContainer struct { DockerID string `json:"DockerId"` DockerName string // needed for linking Container *Container }
DockerContainer is a mapping between containers-as-docker-knows-them and containers-as-we-know-them. This is primarily used in DockerState, but lives here such that tasks and containers know how to convert themselves into Docker's desired config format
func (*DockerContainer) String ¶
func (dc *DockerContainer) String() string
String returns a human readable string representation of DockerContainer
type DockerEventType ¶
type DockerEventType int
DockerEventType represents the type of docker events
const ( // ContainerStatusEvent represents the container status change events from docker // currently create, start, stop, die, restart and oom event will have this type ContainerStatusEvent DockerEventType = iota // ContainerHealthEvent represents the container health status event from docker // "health_status: unhealthy" and "health_status: healthy" will have this type ContainerHealthEvent )
func (DockerEventType) String ¶
func (eventType DockerEventType) String() string
type ECRAuthData ¶
type ECRAuthData struct { EndpointOverride string `json:"endpointOverride"` Region string `json:"region"` RegistryID string `json:"registryId"` UseExecutionRole bool `json:"useExecutionRole"` // contains filtered or unexported fields }
ECRAuthData is the authentication details for ECR specifying the region, registryID, and possible endpoint override
func (*ECRAuthData) GetDockerAuthConfig ¶
func (auth *ECRAuthData) GetDockerAuthConfig() types.AuthConfig
GetDockerAuthConfig returns the pull credentials in the auth
func (*ECRAuthData) GetPullCredentials ¶
func (auth *ECRAuthData) GetPullCredentials() credentials.IAMRoleCredentials
GetPullCredentials returns the pull credentials in the auth
func (*ECRAuthData) SetDockerAuthConfig ¶
func (auth *ECRAuthData) SetDockerAuthConfig(dac types.AuthConfig)
SetDockerAuthConfig sets the credentials to pull from ECR in the ecr auth data
func (*ECRAuthData) SetPullCredentials ¶
func (auth *ECRAuthData) SetPullCredentials(creds credentials.IAMRoleCredentials)
SetPullCredentials sets the credentials to pull from ECR in the auth
type HealthStatus ¶
type HealthStatus struct { // Status is the container health status Status apicontainerstatus.ContainerHealthStatus `json:"status,omitempty"` // Since is the timestamp when container health status changed Since *time.Time `json:"statusSince,omitempty"` // ExitCode is the exitcode of health check if failed ExitCode int `json:"exitCode,omitempty"` // Output is the output of health check Output string `json:"output,omitempty"` }
HealthStatus contains the health check result returned by docker
type MountPoint ¶
type MountPoint struct { SourceVolume string `json:"sourceVolume"` ContainerPath string `json:"containerPath"` ReadOnly bool `json:"readOnly"` }
MountPoint describes the in-container location of a Volume and references that Volume by name.
type PortBinding ¶
type PortBinding struct { // ContainerPort is the port inside the container ContainerPort uint16 // HostPort is the port exposed on the host HostPort uint16 // BindIP is the IP address to which the port is bound BindIP string `json:"BindIp"` // Protocol is the protocol of the port Protocol TransportProtocol }
PortBinding represents a port binding for a container
func PortBindingFromDockerPortBinding ¶
func PortBindingFromDockerPortBinding(dockerPortBindings nat.PortMap) ([]PortBinding, apierrors.NamedError)
PortBindingFromDockerPortBinding constructs a PortBinding slice from a docker NetworkSettings.Ports map.
type RegistryAuthenticationData ¶
type RegistryAuthenticationData struct { Type string `json:"type"` ECRAuthData *ECRAuthData `json:"ecrAuthData"` ASMAuthData *ASMAuthData `json:"asmAuthData"` }
RegistryAuthenticationData is the authentication data sent by the ECS backend. Currently, the only supported authentication data is for ECR.
type ResourceDependency ¶
type ResourceDependency struct { // Name defines the Resource on which a transition depends Name string `json:"Name"` // RequiredStatus defines the status that satisfies the dependency RequiredStatus resourcestatus.ResourceStatus `json:"RequiredStatus"` }
ResourceDependency defines the relationship between a dependent container and its resource dependency.
func (*ResourceDependency) GetRequiredStatus ¶
func (rd *ResourceDependency) GetRequiredStatus() resourcestatus.ResourceStatus
GetRequiredStatus returns the required status for the dependency
type Secret ¶
type Secret struct { Name string `json:"name"` ValueFrom string `json:"valueFrom"` Region string `json:"region"` ContainerPath string `json:"containerPath"` Type string `json:"type"` Provider string `json:"provider"` Target string `json:"target"` }
Secret contains all essential attributes needed for ECS secrets vending as environment variables/tmpfs files
func (*Secret) GetSecretResourceCacheKey ¶
GetSecretResourceCacheKey returns the key required to access the secret from the ssmsecret resource
type TransitionDependenciesMap ¶
type TransitionDependenciesMap map[apicontainerstatus.ContainerStatus]TransitionDependencySet
TransitionDependenciesMap is a map of the dependent container status to other dependencies that must be satisfied.
func (*TransitionDependenciesMap) UnmarshalJSON ¶
func (td *TransitionDependenciesMap) UnmarshalJSON(b []byte) error
UnmarshalJSON decodes the TransitionDependencySet tag in the JSON encoded string into the TransitionDependenciesMap object
type TransitionDependencySet ¶
type TransitionDependencySet struct { // ContainerDependencies is the set of containers on which a transition is // dependent. ContainerDependencies []ContainerDependency `json:"ContainerDependencies"` // ResourceDependencies is the set of resources on which a transition is // dependent. ResourceDependencies []ResourceDependency `json:"ResourceDependencies"` }
TransitionDependencySet contains dependencies that impact transitions of containers.
type TransportProtocol ¶
type TransportProtocol int32
TransportProtocol is an enumeration of valid transport protocols
const ( // TransportProtocolTCP represents TCP TransportProtocolTCP TransportProtocol = iota // TransportProtocolUDP represents UDP TransportProtocolUDP )
func NewTransportProtocol ¶
func NewTransportProtocol(protocol string) (TransportProtocol, error)
NewTransportProtocol returns a TransportProtocol from a string in the task
func (*TransportProtocol) MarshalJSON ¶
func (tp *TransportProtocol) MarshalJSON() ([]byte, error)
MarshalJSON overrides the logic for JSON-encoding the TransportProtocol type
func (*TransportProtocol) String ¶
func (tp *TransportProtocol) String() string
String converts TransportProtocol to a string
func (*TransportProtocol) UnmarshalJSON ¶
func (tp *TransportProtocol) UnmarshalJSON(b []byte) error
UnmarshalJSON for TransportProtocol determines whether to use TCP or UDP, setting TCP as the zero-value but treating other unrecognized values as errors
type VolumeFrom ¶
type VolumeFrom struct { SourceContainer string `json:"sourceContainer"` ReadOnly bool `json:"readOnly"` }
VolumeFrom is a volume which references another container as its source.