CDK patterns for serverless container with AWS Fargate
Project description
cdk-fargate-patterns
CDK patterns for serverless container with AWS Fargate
DualAlbFargateService
Inspired by Vijay Menon from the AWS blog post introduced in 2019, DualAlbFargateService
allows you to create one or many fargate services with both internet-facing ALB and internal ALB associated with all services. With this pattern, fargate services will be allowed to intercommunicat via internal ALB while external inbound traffic will be spread across the same service tasks through internet-facing ALB.
The sample below will create 3 fargate services associated with both external and internal ALBs. The internal ALB will have an alias(internal.svc.local
) auto-configured from Route 53 so services can communite through the private ALB endpoint.
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
DualAlbFargateService(stack, "Service",
spot=True, # FARGATE_SPOT only cluster
tasks=[{
"task": order_task,
"desired_count": 2,
"internal": {"port": 443, "certificate": certificate},
"external": {"port": 80},
# customize the service autoscaling policy
"scaling_policy": {
"max_capacity": 20,
"request_per_target": 1000,
"target_cpu_utilization": 50
}
}, {"task": customer_task, "desired_count": 2, "internal": {"port": 8080}}, {"task": product_task, "desired_count": 2, "internal": {"port": 9090}}
],
route53_ops={
"zone_name": "svc.local",
"external_alb_record_name": "external",
"internal_alb_record_name": "internal"
}
)
Fargate Spot Support
By enabling the spot
property, 100% fargate spot tasks will be provisioned to help you save up to 70%. Check more details about Fargate Spot. This is a handy catch-all flag to force all tasks to be FARGATE_SPOT
only.
To specify mixed strategy with partial FARGATE
and partial FARGATE_SPOT
, specify the capacityProviderStrategy
for individual tasks like
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
DualAlbFargateService(stack, "Service",
tasks=[{
"task": customer_task,
"internal": {"port": 8080},
"desired_count": 2,
"capacity_provider_strategy": [{
"capacity_provider": "FARGATE",
"base": 1,
"weight": 1
}, {
"capacity_provider": "FARGATE_SPOT",
"base": 0,
"weight": 3
}
]
}
]
)
The custom capacity provider strategy will be applied if capacityProviderStretegy
is specified, otherwise, 100% spot will be used when spot: true
. The default policy is 100% Fargate on-demand.
ECS Exec
Simply turn on the enableExecuteCommand
property to enable the ECS Exec support for all services.
ECS deployment circuit breaker
ECS deployment circuit breaker automatically rolls back unhealthy service deployments without the need for manual intervention. By default this feature is enabled, you can opt out with circuitBreaker: false
. Read the docummentation or blog post for more details.
Internal, External or Both
Specify the internal
or external
property to expose your service internally, externally or both.
The certificate
property implies HTTPS
protocol.
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
DualAlbFargateService(stack, "Service",
tasks=[{"task": task1, "internal": {"port": 8080}}, {"task": task2, "external": {"port": 8081}}, {
"task": task3,
"external": {"port": 443, "certificate": my_acm_cert},
"internal": {"port": 8888}
}
]
)
VPC Subnets
By default, all tasks will be deployed in the private subnets. You will need the NAT gateway for the default route associated with the private subnets to ensure the task can successfully pull the container images.
However, you are allowed to specify vpcSubnets
to customize the subnet selection.
To deploy all tasks in public subnets, one per AZ:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
DualAlbFargateService(stack, "Service",
vpc_subnets={
"subnet_type": ec2.SubnetType.PUBLIC,
"one_per_az": True
}, ...
)
This will implicitly enable the auto assign public IP
for each fargate task so the task can successfully pull the container images from external registry. However, the ingress traffic will still be balanced via the external ALB.
To deploy all tasks in specific subnets:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
DualAlbFargateService(stack, "Service",
vpc_subnets={
"subnets": [
ec2.Subnet.from_subnet_id(stack, "sub-1a", "subnet-0e9460dbcfc4cf6ee"),
ec2.Subnet.from_subnet_id(stack, "sub-1b", "subnet-0562f666bdf5c29af"),
ec2.Subnet.from_subnet_id(stack, "sub-1c", "subnet-00ab15c0022872f06")
]
}, ...
)
Sample Application
This repository comes with a sample applicaiton with 3 services in Golang. On deployment, the Order
service will be exposed externally on external ALB port 80
and all requests to the Order
service will trigger sub-requests internally to another other two services(product
and customer
) through the internal ALB and eventually aggregate the response back to the client.
Deploy
To deploy the sample application in you default VPC:
// install first
$ yarn install
// compile the ts to js
$ yarn build
$ npx cdk --app lib/integ.default.js -c use_default_vpc=1 diff
$ npx cdk --app lib/integ.default.js -c use_default_vpc=1 deploy
To deploy with HTTPS-only with existing ACM certificate in your default VPC:
$ npx cdk --app lib/integ.default.js deploy -c use_default_vpc=1 -c ACM_CERT_ARN=<YOUR_ACM_CERT_ARN>
On deployment complete, you will see the external ALB endpoint in the CDK output. cURL
the external HTTP endpoint and you should be able to see the aggregated response.
$ curl http://demo-Servi-EH1OINYDWDU9-1397122594.ap-northeast-1.elb.amazonaws.com
or
$ curl https://<YOUR_CUSTOM_DOMAIN_NAME>
{"service":"order", "version":"1.0"}
{"service":"product","version":"1.0"}
{"service":"customer","version":"1.0"}
WordPress
Use the WordPress
construct to create a serverless WordPress service with AWS Fargate, Amazon EFS filesystem and Aurora serverless database. All credentials auto generated from the AWS Secret Manager and securely inject the credentials into the serverless container with the auto generated IAM task execution role.
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
WordPress(stack, "WP",
aurora_serverless=True,
spot=True,
enable_execute_command=True
)
Laravel
The Laravl
construct is provided as a high-level abstraction that allows you to create a modern Laravel environment running on AWS Fargate
and Amazon Aurora Serverless
. Here comes two variants as the reference:
laravel-bitnami - based on bitnami/laravel with artisan
running as the built-in web server.
laravel-nginx-php-fpm - laravel with nginx and php-fpm maintained by Ernest Chiang.
Simply point code
to your local Laravel codebase and it takes care everything else for you.
Samples
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
#
# laravel-bitnami
#
Laravel(stack, "LaravelBitnamiDemo",
aurora_serverless=True,
spot=True,
enable_execute_command=True,
code=path.join(__dirname, "../services/laravel-bitnami"),
container_port=3000,
loadbalancer={"port": 80}
)
#
# laravel-nginx-php-fpm
#
Laravel(stack, "LaravelNginxDemo",
aurora_serverless=True,
spot=True,
enable_execute_command=True,
code=path.join(__dirname, "../services/laravel-nginx-php-fpm"),
loadbalancer={"port": 80}
)
See integ.laravel.ts for the full code sample.
Local development and testing
The docker-compose.yml is provided with all sample services in the repository. To bring up all services locally, run:
$ cd services
$ docker compose up
Use cURL
to test locally:
curl http://localhost
Response:
{"service":"order","version":"1.0"}
{"service":"product","version":"1.0"}
{"service":"customer","version":"1.0"}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cdk-fargate-patterns-0.2.16.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d361fbde2e5d8ec50a8820caf0ab2514fedb8adf2c298bece2042a0ce1f9f3b |
|
MD5 | bf9f25db6fa33c8bd1b02ca7a1c84af9 |
|
BLAKE2b-256 | 1607202bdd9307af88f3ec7a4a660428b4aed48a2db82497a27e486179e93a00 |
Hashes for cdk_fargate_patterns-0.2.16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3109761fcdacafef1dfbbe92490e160819a89a324db7ac4e29df30a8a6b3af9 |
|
MD5 | 828a3ae15246d46638beded400bc97c3 |
|
BLAKE2b-256 | b4fb1400eaf967c6090dcd9ccaedb89a6643fcab589c84bfec41b3f9c720df9c |