diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..e7a16ee --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We, as members, contributors, and leaders, pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +info@localstack.cloud. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d2d9f94 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contributing Guidelines + +Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional +documentation, we greatly value feedback and contributions from our community. + +Please read through this document before submitting any issues or pull requests to ensure we have all the necessary +information to effectively respond to your bug report or contribution. + + +## Reporting Bugs/Feature Requests + +We welcome you to use the GitHub issue tracker to report bugs or suggest features. + +When filing an issue, please check existing open or recently closed issues to make sure somebody else hasn't already +reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: + +* A reproducible test case or series of steps +* The version of our code being used +* Any modifications you've made relevant to the bug +* Anything unusual about your environment or deployment + + +## Contributing via Pull Requests +Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure the following: + +1. You are working against the latest source on the *main* branch. +2. You check existing open and recently merged pull requests to make sure someone else hasn't addressed the problem already. +3. You open an issue to discuss any significant work - we would hate to waste your time. + +To send us a pull request, please: + +1. Fork the repository. +2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. +3. Ensure local tests pass. +4. Commit to your fork using clear commit messages. +5. Send us a pull request, answering any default questions in the pull request interface. +6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. + +GitHub provides additional documents on [forking a repository](https://help.github.com/articles/fork-a-repo/) and +[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). + + +## Finding contributions to work on +Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start. + + +## Code of Conduct +Please review the adopted [code of conduct](CODE_OF_CONDUCT.md) and make sure you follow the guidelines. + + +## Licensing + +See the [LICENSE](LICENSE) file for our project's licensing. By contributing, you agree that your contributions will be licensed under the existing license. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..061fa11 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 LocalStack GmbH + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 2c88763..8ea937a 100644 --- a/README.md +++ b/README.md @@ -1,233 +1,161 @@ -### ๐ŸŒ Overview +# ECS Fargate Deployment using CDK -The sample application, utilizing the AWS Cloud Development Kit (AWS CDK) ๐Ÿ› ๏ธ, orchestrates the deployment of a -containerized application ๐Ÿ“ฆ on AWS Fargate within an Amazon ECS (Elastic Container Service) cluster. The CDK -infrastructure-as-code model allows developers to define cloud resources using familiar programming languages ๐Ÿ–ฅ๏ธ. +| Key | Value | +| ------------ | --------------------------------------------------------------------------- | +| Environment | LocalStack, AWS | +| Services | ECS, Fargate, ALB, ECR, VPC | +| Integrations | AWS CDK, AWS CLI, Docker, LocalStack | +| Categories | Compute, Networking | +| Level | Intermediate | +| Use Case | ECS Code-Mounting, ECS Debugging | +| GitHub | [Repository link](https://github.com/localstack-samples/sample-cdk-ecs-elb) | -![Solution](./docs/img/solution-diags.drawio.png "Solution") +## Introduction + +This sample demonstrates how to deploy a containerized application on AWS Fargate using the AWS Cloud Development Kit (CDK). The application infrastructure includes a VPC, ECS cluster, Fargate service, Docker image hosted in ECR, and an Application Load Balancer (ALB) for traffic routing. To test this application sample, we will demonstrate how you use LocalStack to deploy the infrastructure on your developer machine and run the application locally. We will also show how to use ECS code-mounting to apply code changes instantly without rebuilds, and how to debug the application with a Node.js debugger. -### ๐Ÿ”‘ Key Components +## Architecture -- **๐ŸŒ VPC and Cluster:** - The script initiates a new Virtual Private Cloud (VPC) and an ECS Cluster, ensuring a secure ๐Ÿ” and isolated network - environment and a logical grouping of ECS tasks and services, respectively. +The following diagram shows the architecture that this sample application builds and deploys: -- **๐Ÿณ Docker Image Asset:** - The `DockerImageAsset` class is used to build a Docker image from a local directory (specified path) and push it to - Amazon Elastic Container Registry (ECR). The built image is then used in the ECS task definition. +![Solution](./docs/img/solution-diags.drawio.png "Solution") -- **๐Ÿš€ Task Definition and Container Definition:** - An ECS task definition is created, specifying the Docker image to use, CPU ๐Ÿ–ฅ๏ธ, and memory requirements, network mode, - and logging configuration. A container within this task is defined, specifying port mappings and essential status. +- Virtual Private Cloud (VPC) that sets an isolated network environment to host AWS resources securely. +- [Elastic Container Service (ECS)](https://docs.localstack.cloud/user-guide/aws/ecs/) to manage the deployment and scaling of containerized applications using the Fargate launch type. +- [Elastic Load Balancer (ALB)](https://docs.localstack.cloud/user-guide/aws/elb/) to distribute incoming HTTP/S traffic across ECS tasks. -- **๐Ÿ›ณ๏ธ ECS Fargate Service:** - The ECS service is configured to run on Fargate, which allows running containers without managing the underlying - instances. The service is configured with the above task definition, desired count of tasks, and a circuit breaker for - handling failures. +## Prerequisites -- **โš–๏ธ Application Load Balancer (ALB):** - An ALB is provisioned to distribute incoming HTTP/S traffic across multiple targets, such as ECS tasks, in multiple - Availability Zones. A listener is added to the load balancer to check for connection requests from clients, using the - HTTP protocol and listening on port 80. +- [`localstack` CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) with a [`LOCALSTACK_AUTH_TOKEN`](https://docs.localstack.cloud/getting-started/auth-token/). +- [AWS CLI](https://docs.localstack.cloud/user-guide/integrations/aws-cli/) with the [`awslocal` wrapper](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal). +- [CDK](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/) with the [`cdklocal`](https://www.npmjs.com/package/aws-cdk-local) wrapper. +- [Node.js](https://nodejs.org/en/download/) +- [`make`](https://www.gnu.org/software/make/) (**optional**, but recommended for running the sample application) -- **๐ŸŽฏ Target Group and Health Checks:** - Targets (in this case, the ECS service) are registered with a target group, which the ALB uses to route traffic to. - Health check settings ensure that traffic is routed only to healthy targets. +## Installation -## Getting Started ๐Ÿ +To run the sample application, you need to install the required dependencies. -This guide assumes that you have cloned the repository and are in the project root directory. The following steps will -guide you through the process of building, deploying, and running the sample application both locally and on AWS. We -have a [sample application](https://github.com/localstack-samples/sample-cdk-ecs-elb/tree/main/src) that listens on -port `3000` and returns a JSON response. +First, clone the repository: -### Prerequisites ๐Ÿงฐ +```shell +git clone https://github.com/localstack-samples/sample-cdk-ecs-elb.git +``` -- [Localstack Pro](https://localstack.cloud/pricing/) -- [Docker](https://docs.docker.com/get-docker/) -- [AWS CDK](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#getting_started_install) -- [Node.js](https://nodejs.org/en/download/) -- [cdklocal](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/) -- [jq](https://jqlang.github.io/jq/download/) +Then, navigate to the project directory: -### Install Dependencies ๐Ÿ“ฆ +```shell +cd sample-cdk-ecs-elb +``` -Install the project dependencies using the following command: +Next, install the project dependencies by running the following command: -```bash +```shell make install ``` -## Deploying the Application on Localstack โ˜๏ธ - -### Step 1: Start LocalStack ๐Ÿšฆ +## Deployment -Start the LocalStack server using the following command: +Start LocalStack with the `LOCALSTACK_AUTH_TOKEN` pre-configured: -```bash -export LOCALSTACK_AUTH_TOKEN= -make start-localstack +```shell +localstack auth set-token +localstack start ``` -### Step 2: Deploy the Application ๐Ÿšข - -Deploy your application locally using the following command: +To deploy the sample application, run the following command: -```bash -make deploy-local +```shell +make deploy ``` -This command will deploy your application to the LocalStack. Ensure that there are no errors. - -### Step 3: Run Test Cases ๐Ÿงช +The output will be similar to the following: -Run the application test cases using the following command: +```shell +Outputs: +RepoStack.MyFargateServiceLoadBalancerDNS704F6391 = lb-f6d118e8.elb.localhost.localstack.cloud +RepoStack.MyFargateServiceServiceURL4CF8398A = http://lb-f6d118e8.elb.localhost.localstack.cloud +RepoStack.localstackserviceslb = lb-f6d118e8.elb.localhost.localstack.cloud:4566 +RepoStack.serviceslb = lb-f6d118e8.elb.localhost.localstack.cloud +Stack ARN: +arn:aws:cloudformation:us-east-1:000000000000:stack/RepoStack/75719142 -```bash -make test-local +โœจ Total time: 28.73s ``` -Ensure that all test cases pass and pay attention to any output that is displayed. This step should validate that the -application is functioning as expected. +## Testing -Alternatively, you can also check the application by curling the ALB endpoint. You can find the ALB endpoint in the -LocalStack console or by running the following command: +The output of the deployment will show the URL of the load balancer. You can use this URL to access the application and verify the HTTP response: -```bash -awslocal elbv2 describe-load-balancers --query 'LoadBalancers[0].DNSName' +```shell +make curl ``` -Now you can curl the endpoint using the following command: +The output will be similar to the following: -```bash -make curl-local +```shell +{"message":"Hi LocalStack!"} ``` -The output should be similar to the following: +You can run full end-to-end integration tests using the following command: -```bash -{"message":"Hello, Welcome to Localstack!"} +```shell +make test ``` -### Step 4: Clean Up ๐Ÿงน +## Use Cases -To delete the application from LocalStack, run the following command: +### ECS Code-Mounting -```bash -make destroy-local -``` +In this sample, ECS code-mounting is implemented using Docker bind mounts to enable real-time sync between your local development environment and the ECS task running in LocalStack. -## Deploying the Application on AWS โ˜๏ธ +The CDK configuration defines a volume that maps a local source directory (`src/app`) to a container path (`/app`) inside the ECS task. When deployed via `cdklocal`, LocalStack translates this into a Docker bind mount. -### Step 1: Deploy the Application ๐Ÿšข +To make use of this: -Deploy your application to AWS using the following command: +- Add a volume definition in your ECS task for the local source directory. +- Mount that volume inside your container at the desired path. +- Enable auto-reloading in your application (e.g., `--watch` for Node.js) to reflect code changes instantly. -```bash -make deploy -``` +This approach allows you to test and iterate faster, as demonstrated by editing a file in `src/app` and immediately seeing the updated response when invoking the ECS service. -This command will deploy your application to AWS. Ensure that there are no errors. +> [!NOTE] +> LocalStack uses real Docker bind mounts to emulate AWS ECS volume behavior locally, making it ideal for fast feedback loops during development. -### Step 2: Run Test Cases Against AWS๐Ÿงช +### ECS Debugging -Run the application test cases using the following command: +This sample also demonstrates how to enable remote debugging for Node.js applications running inside ECS tasks on LocalStack. By exposing a debugging port and connecting via Visual Studio Code, you can inspect, step through, and troubleshoot your running containerized application. -```bash -make test -``` +The setup uses the `ECS_DOCKER_FLAGS` environment variable to configure Docker to expose the Node.js debugger on port `9229` and enable debugging with `--inspect-brk`. When LocalStack starts the ECS task, it passes these flags to the Docker container, enabling remote inspection. -Alternatively, you can also check the application by curling the ALB endpoint. You can find the ALB endpoint in the AWS -console or by running the following command: +> [!NOTE] +> You can either set `ECS_DOCKER_FLAGS="-e NODE_OPTIONS=--inspect-brk=0.0.0.0:9229 -p 9229:9229"` to your LocalStack startup configuration, or use a sample [`docker-compose.yml` file](devops-tooling/docker-compose.yml) provided in the repository. -```bash -make curl-aws -``` +To make use of this: -The output should be similar to the following: +- Set `ECS_DOCKER_FLAGS` to include port mapping and debugging options. +- Restart LocalStack with this configuration. +- Define VSCode tasks and launch configurations to wait for and attach to the remote debugger (samples available in `.vscode` directory). +- Add breakpoints in your code and use the debugger UI to inspect execution. -```bash -{"message":"Hello, Welcome to Localstack!"} -``` - -## ๐Ÿงน Cleaning Up +Once configured, you can `curl` the ELB endpoint to trigger the application and hit breakpoints set in your VSCode editor. -To delete the application from AWS, run the following command: +Combined with code-mounting, this setup allows live debugging without needing to rebuild Docker images, making your iteration loop faster. -```bash -make destroy -``` - -## ๐Ÿš€ Configuring Visual Studio Code for Efficient Remote Node.js Debugging - -Setting up Visual Studio Code for remote Node.js debugging enables smoother and more intuitive development workflows. -This guide will walk you through the essential steps to configure your VSCode efficiently for remote debugging of your -Node.js applications. ๐Ÿ› ๏ธ๐Ÿ” - -1๏ธโƒฃ **Configure LocalStack for remote Node.js debugging** ๐Ÿ› ๏ธ - -First, we need to configure LocalStack to enable remote debugging of Node.js applications. In devops-tooling/docker-compose.yml file, uncomment **ECS_DOCKER_FLAGS** line to enable required configuration for remote debugging. - - -2๏ธโƒฃ **Adding a Task to Wait for Remote Debugger Server** ๐Ÿ•ฐ๏ธ - -First, let's ensure that VSCode waits for the remote debugger server to be available. Add a new task by creating or -modifying the `.vscode/tasks.json` file in your project directory. - - ```json - { - "version": "2.0.0", - "tasks": [ - { - "label": "Wait Remote Debugger Server", - "type": "shell", - "command": "while [[ -z $(docker ps | grep :9229) ]]; do sleep 1; done; sleep 1;" - } - ] -} - ``` - -3๏ธโƒฃ **Setting up Debugging Configuration** ๐ŸŽ›๏ธ - -Next, define how VSCode should connect to the remote Node.js application. Create a new `launch.json` file or modify an -existing one from the *Run and Debug* tab, then add the following configuration. - - ```json - { - "version": "0.2.0", - "configurations": [ - { - "address": "127.0.0.1", - "localRoot": "${workspaceFolder}", - "name": "Attach to Remote Node.js", - "port": 9229, - "remoteRoot": "/app", - "request": "attach", - "type": "node", - "preLaunchTask": "Wait Remote Debugger Server" - } - ] -} - ``` - -4๏ธโƒฃ **Start LocalStack** - -Start the LocalStack server using the following command: - -```bash -export LOCALSTACK_AUTH_TOKEN= -make start-localstack -``` +## Summary -5๏ธโƒฃ **Running the Debugger** ๐Ÿƒ +This sample application demonstrates how to provision, deploy, and test a containerized Node.js application on AWS Fargate using AWS CDK and LocalStack. It showcases the following patterns: -Finally, run the debugger by selecting the *Attach to Remote Node.js* configuration from the *Run and Debug* tab. You -can now set breakpoints and debug your Node.js application running in a Docker container. ๐Ÿณ +- Defining and deploying core AWS resources, such as VPC, ECS, Fargate, and Elastic Load Balancer, using AWS CDK. +- Building and pushing Docker images to Amazon ECR, and integrating them into ECS task definitions. +- Configuring Visual Studio Code for remote debugging of ECS tasks running in LocalStack. +- Using bind mounts with ECS to mount code from the host filesystem into the ECS container for quick hot-reloads. +- Utilizing `cdklocal` and `awslocal` to streamline local deployment and testing workflows. -## ๐Ÿ“š Resources ๐Ÿ“š +## Learn More -- [LocalStack CLI Documentation](https://docs.localstack.cloud/getting-started/installation/) -- [LocalStack API Documentation](https://docs.localstack.cloud/user-guide/aws/feature-coverage/) -- [Localstack CDK Documentation](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/) -- [AWS CDK Documentation](https://docs.aws.amazon.com/cdk/latest/guide/home.html) -- [AWS CLI Documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) +- [Deep Dive tutorial into ECS hot-reloading & debugging](https://blog.localstack.cloud/developing-debugging-aws-ecs-tasks-localstack-vs-code/) (**recommended**) +- [ECS Code-Mounting](https://docs.localstack.cloud/user-guide/aws/ecs/#mounting-local-directories-for-ecs-tasks) +- [Use bind mounts with Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bind-mounts.html) +- [Remote Debugging for ECS with LocalStack](https://docs.localstack.cloud/user-guide/aws/ecs/#remote-debugging) +- [Deploying AWS CDK applications with LocalStack](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/) diff --git a/devops-tooling/docker-compose.yml b/devops-tooling/docker-compose.yml index 91613e2..5c7674a 100644 --- a/devops-tooling/docker-compose.yml +++ b/devops-tooling/docker-compose.yml @@ -15,6 +15,6 @@ services: - LAMBDA_RUNTIME_ENVIRONMENT_TIMEOUT=90 - PERSIST_ALL=${PERSIST_ALL-false} - LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN-} - # - ECS_DOCKER_FLAGS=-e NODE_OPTIONS=--inspect-brk=0.0.0.0:9229 -p 9229:9229 # Optional flag required for remote debugging + - ECS_DOCKER_FLAGS=-e NODE_OPTIONS=--inspect-brk=0.0.0.0:9229 -p 9229:9229 # Optional flag required for remote debugging volumes: - /var/run/docker.sock:/var/run/docker.sock # Mount the Docker socket into the container