ECS Compose-X
latest

ECS Compose-X

  • ECS Compose-X
  • Requirements
  • Installation
  • ECS Compose-X as an AWS CloudFormation Macro
  • Contributing

Compatibility Matrix

  • AWS ECS (and AWS Fargate) Features
    • Container Definition
    • Task Definition
    • Service Definition
    • Cluster definition
  • Docker Compose
    • services
      • deploy
    • volumes
    • network
  • Docker AWS ECS Plugin
  • AWS IAM Policies from AWS SAM
    • Example

Docker Compose syntax

  • services
  • volumes
    • Understand Local volumes vs shared volumes vs persistent volumes
    • Implementation in the AWS + Docker ECS Plugin
    • Implementation in ECS Compose-X
      • Define a volume for the task only
      • Define a shared volume between tasks
      • Define a shared volume using AWS EFS
        • Using the ECS Plugin syntax reference
        • Using the ECS Compose-X specific reference
  • secrets
    • Syntax
      • Name
      • LinksTo
      • JsonKeys
        • SecretKey
        • VarName
        • Transform
    • Examples
  • networks
  • logging
    • Supported drivers
      • awslogs

Services-level Extension Fields

  • deploy
    • resources
      • replicas
      • labels
        • ecs.task.family
        • ecs.depends.condition
  • x-scaling
    • Range
    • TargetScaling
      • CpuTarget / RamTarget
      • ScaleInCooldown / ScaleOutCooldown
      • DisableScaleIn
  • x-iam
    • PermissionsBoundary
    • Policies
    • ManagedPolicies
  • x-network
    • UseCloudmap
    • Ingress definition
      • Syntax reference
    • Map VPC subnets to docker-compose networks
  • x-logging
    • RetentionInDays
    • Examples
  • x-xray
    • Syntax reference
    • Example
    • IAM permissions
  • x-codeguru-profiler
    • Syntax reference / Examples
    • Code Example

Compose-X syntax

  • Common syntax for x-resources
    • Properties
    • Lookup
      • Tags
      • RoleArn
    • Settings
      • EnvNames
      • Subnets
    • Services
  • x-dynamodb
    • Properties
    • Settings
    • Lookup
    • Services
  • x-rds
    • Syntax
    • Properties
      • Using properties
    • MacroParameters
      • PermissionsBoundary
      • RdsFeatures
    • Services
      • Access types
    • Settings
    • Lookup
    • Defaults
      • Credentials
    • Examples
  • x-docdb
    • Syntax
    • Properties
    • MacroParameters
      • Instances
      • DBClusterParameterGroup
    • Services
      • Access types
    • Settings
    • Lookup
    • Credentials
    • Examples
  • x-elastic_cache
    • Properties
    • MacroParameters
      • ParameterGroup
    • Settings
    • Services
    • Lookup
    • Examples
  • x-s3
    • Create or use existing S3 buckets to use for your applications
      • Properties
      • MacroParameters
        • NameSeparator
        • ExpandRegionToBucket
        • ExpandAccountIdToBucket
      • Services
      • Lookup
      • IAM Permissions
      • Examples
  • x-efs
    • Syntax reference
    • Properties
    • MacroParameters
      • EnforceIamAuth
    • Settings
      • Subnets
    • Lookup
    • Use
    • Examples
    • Filesystem, Access Point and services access
      • Access point per “container” within the task definition
  • x-appmesh
    • Syntax
    • Properties
      • MeshName
      • MeshOwner
      • EgressPolicy
    • Settings
      • nodes
        • Syntax
        • Examples
      • routers
        • Definition
        • Syntax
        • match
      • services
        • Syntax
      • Examples
    • AWS AppMesh & AWS Cloud Map for services mesh & discovery
    • Nodes
    • Routers
      • Services
      • The other things ECS ComposeX takes care of for you
  • x-dns
    • Syntax
    • Examples
  • x-elbv2
    • Syntax
    • Properties
    • MacroParameters
      • Ingress
      • Other attribute shortcuts
    • Services
      • name
      • protocol
      • port
      • healthcheck
    • Listeners
    • Target Groups
      • name
      • access
      • AuthenticateCognitoConfig
      • AuthenticateOidcConfig
    • Examples
  • x-acm
    • Syntax
    • Properties
    • MacroParameters
      • DomainNames
      • HostedZoneId
    • Services
    • Example
  • x-kinesis
    • Syntax reference
    • Properties
    • MacroParameters
    • Settings
      • EnvNames
    • Services
    • Examples
    • IAM permissions
  • x-sqs
    • Define your AWS SQS Queues and service scaling based on messages queue depth
      • Syntax
      • Properties
        • Mandatory Properties
        • Special properties
      • Services
        • IAM Permissions
      • Lookup
      • Scaling
      • Special Features
        • Redrive policy
      • Settings
      • Examples
  • x-sns
    • Syntax
    • Properties
    • Lookup
    • Examples
  • x-events
    • Properties
    • MacroParameters
    • Settings
    • Services
      • name
      • TaskCount
      • DeleteDefaultService
  • x-kms
    • Syntax
    • Properties
    • Settings
      • Alias
    • Examples
    • Services
    • IAM Permissions
  • x-vpc
    • Define a new VPC for your services or use an existing one
      • Syntax Reference
        • Create
      • Lookup
      • Use
      • Default VPC Network design
        • Default range
  • x-cluster
    • Properties
    • Lookup
    • Use
  • x-alarms
    • Properties
    • MacroParameters
      • CompositeExpression
    • Services
    • Topics
      • TopicArn
      • x-sns
      • NotifyOn
    • Examples
  • spot_config
    • Define settings in the configs section

Docker ECS Plugin support

  • Docker ECS Plugin support
    • x-aws-cluster
    • x-aws-pull_credentials
    • x-aws-autoscaling
    • x-aws-policies
    • x-aws-role
    • x-aws-logs_retention
      • x-aws-min_percent & x-aws-max_percent

Additional content

  • History
    • 0.14.0 (2021-03-23)
      • New features
      • Fixes
      • Improvements
    • 0.13.0 (2021-03-10)
      • New Features
      • Fixes
      • Improvements
    • 0.12.0 (2021-01-31)
      • New features
      • Fixes
      • Improvements
      • Special changes
    • 0.11.0 (2021-01-14)
      • New features
      • Improvements
      • Fixes
    • 0.10.0 (2020-12-13)
      • New features
      • Improvements
      • Fixes
      • Other updates and corrections
    • 0.9.0 (2020-11-26)
      • New features
      • Fixes
      • Syntax changes from previous version
    • 0.8.0 (2020-10-09)
      • New features:
      • Closed reported issues:
    • 0.7.0 (2020-08-12)
    • 0.6.0 (2020-08-03)
    • 0.5.3 (2020-07-30)
    • 0.5.2 (2020-07-30)
    • 0.5.1 (2020-07-28)
    • 0.5.0 (2020-07-27)
      • New features
    • 0.4.0 (2020-07-20)
    • 0.3.0 (2020-06-21)
    • 0.2.3 (2020-04-16)
      • New features
    • 0.2.2 (2020-04-10)
    • 0.2.1 (2020-05-03)
      • New features
    • 0.1.3 (2020-04-13)
      • Issues closed
    • 0.1.2 (2020-04-04)
      • Issues closed
    • 0.1.1 (2020-04-02)
    • 0.1.0 (2020-03-24)
  • Extras
    • Plug & Play to existing resources with auto discovery
    • Docker ECS-Plugin x-aws-keys support
    • AWS AppMesh integration
    • Services autoscaling integration
    • Fargate CPU/RAM auto configuration
    • Multiple services, one microservice
  • Philosophy
    • Trying to implement DevOps starting with developers
    • Community focused
    • Ensure things work
    • Provision other AWS resources your services need
    • How does it work?
  • What does ECS Compose-X do differently? Long version
  • Why did I create ECS Compose-X?
  • Why am I not using AWS CDK?
  • Implementing least privileges at the heart of ECS Compose-X

Thanks & Credits

  • Contributors
  • Credits
ECS Compose-X
  • »
  • Search
  • Edit on GitHub

© Copyright 2020-2021, John Mille Revision 62900cfa.

Built with Sphinx using a theme provided by Read the Docs.