Skip to content

Commit 5a2db42

Browse files
committed
docs: improved package description to hopefully be more clear
1 parent 8760a27 commit 5a2db42

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

packages/nx-aws-cache-iac/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# NX AWS Cache Infrastructure as Code
22

3-
Sets the infrastructure for the AWS Cache for NX. This is a cache that is shared between all the projects in the monorepo.
4-
It is meant to ease the infrastructure setup of [nx-aws](https://github.com/bojanbass/nx-aws).
3+
The plugin does not enforce any specific infrastructure. It does require you to have certain elements (e.g. an S3 bucket, a user with access to it, etc.). You can create such infrastructure manually or you can use the provided IaC (Infrastructure as Code) to create it automatically.
4+
5+
In order to ease the process of creating the infrastructure, this package provides a CLI that will create the infrastructure for you. It contains the IaC for creating the infrastructure and you can run it by just calling a command. It uses AWS CDK (Cloud Development Kit) to create the infrastructure. The infrastructure is defined in the `lib/nx-aws-cache-iac-stack.ts` file.
6+
7+
The CLI will create a new Stack in your AWS account. The Stack will create a new S3 bucket and an IAM user with access to it. The credentials for the user will be stored in the AWS Secrets Manager.
58

69
## How to deploy the infrastructure
710

0 commit comments

Comments
 (0)