https://github.com/aws-samples/sample-developer-environment
AWS Cloud9 and CodeCommit alternative with CI/CD pipeline
https://github.com/aws-samples/sample-developer-environment
aws cloud9 code-server codecommit development development-environment devops git git-remote-s3 terraform visual-studio-code
Last synced: 16 days ago
JSON representation
AWS Cloud9 and CodeCommit alternative with CI/CD pipeline
- Host: GitHub
- URL: https://github.com/aws-samples/sample-developer-environment
- Owner: aws-samples
- License: mit-0
- Created: 2025-03-26T08:55:16.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2025-04-05T17:00:19.000Z (19 days ago)
- Last Synced: 2025-04-05T17:34:12.921Z (19 days ago)
- Topics: aws, cloud9, code-server, codecommit, development, development-environment, devops, git, git-remote-s3, terraform, visual-studio-code
- Language: HCL
- Homepage:
- Size: 689 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# sample-developer-environment
This solution deploys a complete browser-based development environment with VS Code, version control, and automated deployments using a single AWS CloudFormation template.
## Repository Structure
```
.
├── dev/ # Development workspace
│ └── README.md # Development guide
├── release/ # Sample Terraform application
│ ├── main.tf # Core infrastructure
│ ├── provider.tf # AWS provider configuration
│ ├── variables.tf # Input variables
│ ├── versions.tf # Provider versions and backend
│ ├── website.tf # Sample static website
│ └── terraform.tfvars # Variable defaults
└── sample-developer-environment.yml # Main CloudFormation template
```
## Key Features
- Browser-based VS Code using [code-server](https://github.com/coder/code-server) accessed through Amazon CloudFront
- Git version control using [git-remote-s3](https://github.com/awslabs/git-remote-s3) with Amazon S3 storage
- Automated deployments using AWS CodePipeline and AWS CodeBuild
- Password rotation using AWS Secrets Manager (30-day automatic rotation)
- Pre-configured AWS development environment:
- AWS Toolkit for VS Code
- Terraform infrastructure deployment
- Docker support
- Git integration
## Quick Start
1. Launch the AWS CloudFormation template `sample-developer-environment.yml`
2. Choose your initial workspace content:
- Provide a GitHub repository URL in `GitHubRepo` parameter, OR
- Provide S3 bucket name `S3AssetBucket` and `S3AssetPrefix` parameters
3. Access VS Code through the provided CloudFormation output URL
4. Get your password from AWS Secrets Manager (link in outputs)
5. Click *File* > *Open Folder* and navigate to `/home/ec2-user/my-workspace`. This is the git/S3 initialized project directory
6. Test code in `dev`, copy to `release`, commit and push to trigger deployment
## Configuration Options
- `CodeServerVersion` - Version of code-server to install
- `GitHubRepo` - Public repository to clone as initial workspace. Note: Using a custom repository will not include the sample application.
- `S3AssetBucket` - (Optional) S3 bucket containing initial workspace content. Overwrites GitHubRepo if provided
- `S3AssetPrefix` - (Optional) Asset prefix path. Only required when S3AssetBucket is specified.
- `DeployPipeline` - Enable AWS CodePipeline deployments
- `RotateSecret` - Enable AWS Secrets Manager rotation
- `InstanceType` - Supports both ARM and x86 Amazon EC2 instances
## AWS IAM Roles
The environment is configured with two IAM roles:
1. EC2 instance role - Basic permissions for the instance
2. Developer role - Elevated permissions for AWS operations
The developer role has the permissions needed to deploy the sample application. To view or modify these permissions, search for "iamroledeveloper" in the CloudFormation template.
This separation ensures the EC2 instance runs with minimal permissions by default, while allowing controlled elevation of privileges when needed.
ℹ️ **Tip**: Run `echo 'export AWS_PROFILE=developer' >> ~/.bashrc && source ~/.bashrc` to make the developer profile default for all terminal sessions.
## Architecture
The environment runs in a private subnet with CloudFront access, using S3 for git storage and CodePipeline for automated deployments.
## Sample Application
ℹ️ **Note**: The sample application is only available when using the default value for `GitHubRepo`. If you specify either a custom `GitHubRepo` or `S3AssetBucket`, you will need to provide your own Terraform application code.
The repository includes a Terraform application that deploys:
- Static website hosted on Amazon S3
- Amazon CloudFront distribution with AWS WAF protection
- Security headers and AWS KMS encryption
- Amazon CloudWatch logging
The application deploys automatically when you set the CloudFormation parameter `DeployPipeline` to true. Once deployment completes, you can locate the website URL in the final output of the CodeBuild job.
⚠️ **WARNING**: If using CodePipeline (DeployPipeline=true), before removing the CloudFormation stack:
1. Run the 'terraform-destroy' pipeline in CodePipeline
2. Approve the manual approval step when prompted
3. Wait for pipeline completion
Failing to run and approve the destroy pipeline will leave orphaned infrastructure resources in your AWS account that were created by Terraform and will need to be cleaned up manually.
## Security Considerations
⚠️ **IMPORTANT**: This sample uses HTTP for internal traffic between the Application Load Balancer and code-server Amazon EC2 instance. While external traffic is secured through CloudFront HTTPS, it is strongly recommended to:
- Configure end-to-end HTTPS using custom SSL certificates on the ALB
- Update ALB listener and target group to use HTTPS/443
- Use a custom domain name with AWS Certificate Manager (ACM) certificates
## Security
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
## License
This library is licensed under the MIT-0 License. See the LICENSE file.
## Disclaimer
**This repository is intended for demonstration and learning purposes only.**
It is **not** intended for production use. The code provided here is for educational purposes and should not be used in a live environment without proper testing, validation, and modifications.
Use at your own risk. The authors are not responsible for any issues, damages, or losses that may result from using this code in production.