Serverless Fargate Tasks

This Serverless plugin will setup a Fargate cluster and setup services and tasks. With this plugin it's fairly easy to setup a (long running) task which would hook up to kinesis streams or SQS endpoints.

The (minimal) config is as follows:

custom:
  fargate:
    role: arn:aws:iam::123456789369:role/myRole
  
    tasks:
      my-task:
        image: 123456789369.dkr.ecr.eu-west-1.amazonaws.com/my-image

Of course, you can customize to your hearts desire, here are all the available options:

custom:
  fargate:
    # you can put global environment variables here, these will be added
    # to all tasks. Optional of course.
    environment:
      foo: bar
    secrets:
      password: /Path/to/ssm/password

    role: arn:aws:iam::123456789369:role/myRole

    tasks:
      my-task:
        name: ${self:service}-${self:provider.stage}-my-task # default will be ${self:service}-${self:provider.stage}-{task-key-here}
        image: 123456789369.dkr.ecr.eu-west-1.amazonaws.com/my-image
        environment:  # optional
          platypus: true
          # local variables will always override global ones
          foo: wut
          # you can also use cloudformation references with eg serverless-pseudo-parameters
          myArn: #{MyResource.Arn}
        secrets:
          password: /Path/to/custom/ssm/password
        cpu: 512  # optional, defaults to 100% -> 1024, see cloudformation docs for valid values
        memory: 2.0GB  # optional, defaults to 2.0GB

Add DataDog Integration

Datadog can collect CloudWatch container insights by default, however Fargate tasks that don't run in a service (e.g., on-demand ephemeral tasks) don't log their metrics. You can easily install the DataDog Fargate agent with the following options:

custom:
  fargate:
    role: arn:aws:iam::123456789369:role/myRole
    
    datadog:
      ssm_api_key: /datadog/api_key  # Replace with the name of your SSM parameter (if in same account as the task), or full ARN
      image_account_id: ${aws:accountId} # Required
      essential: true  # Optional, marks container as essential. Default is false.
      cpu: 10  # Optional, sets the CPU units for the individual container. Defaults to DataDog recommended 10 units.
      memory: 256  # Optional, sets the soft memory limit for the individual container. Defaults to DataDog recommended 256. 
      statsd_enabled: true  # Optional, sets agent to listen to DogStatsD packets on port 8125 from other containers. Default is false.
      
    tasks:
      my-task:
        image: 123456789369.dkr.ecr.eu-west-1.amazonaws.com/my-image

You must ensure the role used for the task has ssm:GetParameters on the DataDog API Key SSM parameter.

Advanced usage

You can override the generated CF task, container, and role properties per task with the override properties:

custom:
  fargate:
    role: arn:aws:iam::123456789369:role/myRole
    
    tasks:
      my-task:
        image: 123456789369.dkr.ecr.eu-west-1.amazonaws.com/my-image

        # these are all optional
        override:
          task:
            Foo: BAR
          container:
            Foo: Bar
          role: ARN