diff --git a/README.md b/README.md index cd52b47..52528ef 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Backstage Infrastructure -This project uses [CDK](https://docs.aws.amazon.com/cdk/latest/guide/home.html) to deploy a containerized version of your backstage instance along with the required infrastructure in into a AWS account, to host your own [Backstage](https://backstage.io) based service. It creates two independent stacks which deploy pipelines, infrastructure, and app image containers to AWS. +This project uses [CDK](https://docs.aws.amazon.com/cdk/latest/guide/home.html) to deploy a containerized version of your backstage instance along with the required infrastructure into a AWS account, to host your own [Backstage](https://backstage.io) based service. It creates two independent stacks which deploy pipelines, infrastructure, and app image containers to AWS. It is assumed you have more than a passing familiarity with: - CDK - AWS @@ -10,7 +10,7 @@ It is assumed you have more than a passing familiarity with: > WARNING! Deploying these stacks to AWS will incur costs! ## Versions -If you are looking for the orgininal version of this cdk stack without the use of pipelines see the `original` branch in this repo. +If you are looking for the original version of this cdk stack without the use of pipelines see the `original` branch in this repo. ## Prerequisites you will need to have at least the following installed and configured: @@ -22,7 +22,7 @@ and you will need to have your backstage application code in a separate repo fro ## The backstage stack and pipeline This stack creates multiple environments within a ECS Fargate cluster along with Aurora postgres dbs for persistence, and puts those behind application load balancers with a custom domain name. -Finally it builds a codepipeline called the `backstage-app-pipline` which builds and deploys a new container image based on commits to a separate `backstage` repo where the backstage app code resides and triggers an ECS deployment update. Once this cdk stack is deployed, you only need to update your backstage application code to update the current running application. +Finally, it builds a codepipeline called the `backstage-app-pipline` which builds and deploys a new container image based on commits to a separate `backstage` repo where the backstage app code resides and triggers an ECS deployment update. Once this cdk stack is deployed, you only need to update your backstage application code to update the current running application. ## The infrastructure pipeline The infra pipeline stack creates a codepipeline to both update itself and to deploy the backstage stack described above. In this way this set of infrastructure code is self-updating and self-healing, and requires no manual intervention after the initial manual deployment of the infra-pipeline stack. @@ -33,7 +33,7 @@ The infra pipeline stack creates a codepipeline to both update itself and to dep ## Documentation - [Pipelines Descriptions](./docs/pipelines.md) -- [Application Infrstructure](./docs/stack.md) +- [Application Infrastructure](./docs/stack.md) - [Settings and Configuration](./docs/settings.md) - [Bootstrap the Stacks](./docs/bootstrap.md) - [Deployment](./docs/deploy.md) @@ -45,4 +45,4 @@ The infra pipeline stack creates a codepipeline to both update itself and to dep - Remove aws integration user and use an ECS role for AWS auth. - add dynamic route53 domain creation in the backstage-stack. - Add creation of ECR repository to the backstage-stack. - - add Code* notification and connection creation to backstage-stack. \ No newline at end of file + - add Code* notification and connection creation to backstage-stack.