Skip to content

Commit

Permalink
docs: improve intro
Browse files Browse the repository at this point in the history
  • Loading branch information
aripalo committed Aug 11, 2022
1 parent 86fcda4 commit c77bab0
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@

<div align="left">


Opinionated CDK Project “Framework” is a set of CDK constructs and utilities aiming to solve many complexities related to configuration, naming, tagging, etc. for multi-account & multi-environment projects that utilize [Continuous Delivery & Deployment](https://continuousdelivery.com/) and [Trunk Based Development](https://trunkbaseddevelopment.com/) with feature branches/environments.

> Things can get quite complex if you:
> - **Deploy a CDK project into multiple different AWS Accounts** <br/>following best practises and separating production from other environments
> - **Manage all the account specific configurations somewhere**<br/>but it's often hard to decide where to store that information and how to access it
> - **Need to map different environments to specific accounts**<br/>as often you may have more application environments than you have AWS accounts
> - **Adjust your infrastructure code for specific environments**<br/>for example cost optimization or backups often behave differently for production vs. development
> - **Potentially use dynamic & short-lived “feature environments”**<br/>e.g. by triggering temporary deployments on Github Pull Requests with a `feature/` branch prefix
> - **Need to setup well-defined tagging**<br/>as proper tagging helps with cost management and even defining backups
> - **Repeat the above steps for multiple CDK projects**<br/>because let's say you develop a lot of microservices in different repositories
>
> &nbsp;&nbsp;&nbsp;&nbsp;– Ari Palo, Lead Technologist, Alma Media
Opinionated CDK “framework” with constructs & utilities for:
- deploying multiple environments to multiple accounts (with many-to-many relationship)
- managing account configuration through standardized props (no more random config files)
- querying account and/or environment specific information within your CDK code
- enabling dynamic & short-lived “feature-environments
- enabling Well-defined tagging
- providing structure & common conventions to CDK projects
- choosing the target account & environment by passing in runtime context:

```sh
npx cdk deploy -c environment=feature/abc-123
```
... which means you don't need to define all the possibile environments ahead of time!
</div>
<br/>
Expand Down

0 comments on commit c77bab0

Please sign in to comment.