senglin / node-aws-workspace

An AWS Development Environment for NodeJS

An AWS Development Environment for NodeJS

Purpose

1. Provides a template for building Node Applications for AWS using Visual Studio Code, along with the associated tools.
2. A containerized development environment using the Remote-Containers extension.

Requirements

1. Visual Studio Code
2. Remote - Containers extension for Visual Studio Code
3. Docker

Installed Frameworks

1. AWS CLI
2. AWS SAM CLI
3. AWS Fargate CLI (forked version at senglin/fargatecli)
4. AWS Toolkit for VS Code
5. Docker (Docker In Docker)
6. Git
7. Node v14.2.0
8. Ruby
9. Curl, Wget

Developing inside a Container

1. Clone this repository or copy just the .devcontainer folder into your own local git repository folder. You can also run the following script in your terminal.

bash <(wget -qO- https://raw.githubusercontent.com/senglin/node-aws-workspace/master/install.sh)

2. Start VS Code, and in a new window, click on the quick actions Status Bar item in the lower left corner.
3. Select Remote-Containers:Reopen in Container.
4. From the menu, select Terminal -> New Terminal. You can now use the installed tools to clone, develop and deploy to AWS.

Expectation

1. Development in performed using a non-root user account (without sudo capabilities) - i.e. vscode user.
2. The container application inherits host's AWS Configuration. The ~/.aws folder is accessibled from the container.
3. The container app reuses ssh private key configuration from the host. SSH-AGENT settings are forwarded to the container application.

Variants of containerization

The behavior of the docker command in the container is configured via VSC_DIND environment variables, in devcontainer.json file.

Value	Description
root	Docker CLI in container accesses host Docker Engine (root access required)
nonroot	Docker CLI in container accesses host Docker Eingine (nonroot access method)
dind	Start Docker Engine within container when the container starts up. CLI uses container Docker Engine