Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/austriantradingmachine/aws-cdk-python-dockerfile
A dockerfile for AWS CDK Python 3.9 development environment
https://github.com/austriantradingmachine/aws-cdk-python-dockerfile
aws-cdk aws-cli debian devcontainers docker node python3
Last synced: about 1 month ago
JSON representation
A dockerfile for AWS CDK Python 3.9 development environment
- Host: GitHub
- URL: https://github.com/austriantradingmachine/aws-cdk-python-dockerfile
- Owner: AustrianTradingMachine
- License: mit
- Created: 2024-08-10T20:38:51.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T17:06:15.000Z (3 months ago)
- Last Synced: 2024-10-13T17:41:43.393Z (2 months ago)
- Topics: aws-cdk, aws-cli, debian, devcontainers, docker, node, python3
- Language: Dockerfile
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AWS CDK Python 3.9 Development Environment
This repository contains a Dockerfile for setting up a development environment for AWS Cloud Development Kit (CDK) using Python 3.9 on Debian Bullseye (11). The image includes Node.js, AWS CLI, and other necessary tools to work with AWS CDK.
## Features
- **Base Image**: Debian Bullseye (11) with Python 3.9.
- **Node.js**: Installed via nvm (Node Version Manager) to manage different Node.js versions.
- **AWS CLI v2**: Installed and configured based on system architecture (amd64/arm64).
- **AWS CDK**: Globally installed for infrastructure as code using Python and AWS.
- **Python Packages**: Python development packages such as pip, venv, setuptools, and wheel are pre-installed.
- **Non-root User**: The image runs as a non-root user (`developer`) for better security.
- **Microsoft DevContainer**: Prepared for usage in the Microsoft DevContainer in Visual Studio Code.
## Getting Started
### Prerequisites
- Docker installed on your local machine.
- A copy of this repository.
- DevContainer Extension installed (If you use the Dockerfile in Microsoft DevContainer)
### Direct usage
#### Building the Docker Image
To build the Docker image, navigate to the directory containing the Dockerfile and run the following command:
```bash
docker build -t aws-cdk-python3.9 .
```
This command will create a Docker image named `aws-cdk-python3.9`.
#### Running the Docker Container
Once the image is built, you can start a container using:
```bash
docker run -it --rm -v $(pwd):/workspaces aws-cdk-python3.9
```
This command runs the container in interactive mode (`-it`), removes it after exit (`--rm`), and mounts the current directory into the container's `/workspaces` directory.
### Usage in DevContainer
Install the Microsoft DevContainers extension from the VS Code marketplace.
#### Shared Volume with Host
Make a local clone of your Github Repository.
Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS) to open the Command Palette.
Enter the command "Dev Containers: Open Folder in Container" in the VSCode Command Palette.
VSCode will open a new window in the Container. You see the new active container environment on the left lower corner.
Once the container is up, you can start coding in your fully configured environment.
The project directory on your Host will be automatically mounted inside the container, so all your changes are saved locally.
#### Isolated Volume
Enter the command "Dev Containers: Clone Repository in Container Volume" in the VSCode Command Palette.
Select the GitHub Repository and the branch you want to load into the Container.
VSCode will open a new window in the Container. You see the new active container environment on the left lower corner.
Once the container is up, you can start coding in your fully configured environment.
The project directory of your GitHub repository will be automatically mounted inside the container, so all your changes are saved locally.
### Using the Container
- **Working Directory**: The container's default working directory is `/workspaces`. Any files you work on will be synced with your host machine's directory.
- **Python**: Use `python3` to run Python scripts.
- **AWS CDK**: Use `cdk` commands for AWS CDK operations.
- **AWS CLI**: Use `aws` to interact with AWS services.
### Customizing the Environment
You can modify the `requirements.txt` and `requirements_dev.txt` files to include additional Python packages. The Dockerfile is set up to automatically install these dependencies when building the image.
### Default included packages:
* aws-cdk-lib
* constructs
* boto3
* pytest
## Troubleshooting
If you encounter issues, consider the following steps:
- **Rebuild the Image**: Sometimes changes might not reflect due to caching. Rebuild the image with the `--no-cache` option:
```bash
docker build --no-cache -t aws-cdk-python3.9 .
```
- **Check Logs**: Use the `docker logs ` command to view container logs if it fails to start.
## Contributing
Feel free to open issues or pull requests if you have any suggestions or improvements.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## References:
* [Debian Docker Image](https://hub.docker.com/_/debian)
* [VSCode Container](
https://code.visualstudio.com/docs/devcontainers/containers)
* [VsCode DevContainer Extension](https://code.visualstudio.com/docs/devcontainers/tutorial)
* [Amazon Linux](https://docs.aws.amazon.com/linux/)