Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
baixiac committed Feb 7, 2024
1 parent dcc2daa commit 814d0d1
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,19 @@ terraform plan
terraform apply --auto-approve
```

Created resources:
* VPC featuring both public and private subnets
* Internet and NAT gateways
* EKS cluster with distinct DMZ and worker node groups
* EKS coredns, kube-proxy, vpc-cni and aws-ebs-csi-driver addons
* EBS storage classes referenced by PVCs
* IRSAs for VPC CNI and EBS CSI controllers
* Default EC2 instances
* Default network ACLs and route tables
* KMS keys and CloudWatch logs groups
* Essential IAM policies, roles, users and user groups for accessing these resources


## Connect to and verify the cluster
```
# Make sure to use --region if the cluster is deployed in non-default region and --profile if the cluster is deployed in a non-default AWS account
Expand All @@ -77,6 +90,20 @@ terraform plan
terraform apply --auto-approve
```

Optional resource creations are disabled by default. To enable the creation of a specific resource named `X`, navigate to [config/terraform.tfvars](./config/terraform.tfvars) and update the value of `enable_X` to `true` before applying the tempate.

Created resources (if all enabled):
* EIP allocated for the load balancer created by Ingress-NGINX
* Karpenter provisioner, the node template and the SQS interruption queue
* MSK cluster featuring Kafka brokers and zookeepers
* RDS instance running managementportal, appserver and rest_sources_auth databases
* Route53 zone and records accompanied by IRSAs for external DNS and Cert Manager
* S3 buckets for intermediate-output-storage, output-storage and velero-backups
* VPC endpoint for S3
* SES SMTP endpoint
* CloudWatch event rules and targets
* Essential IAM policies, roles, users for accessing these resources

## Known limitations
* Since EBS has been chosen as the default storage, node groups will be created in a single AZ due to the mounting restriction.
* Sometimes Terraform tries to replace the existing MSK cluster while re-applying the templates even if there is no change on the cluster. Mitigate this with `terraform untaint aws_msk_cluster.msk_cluster`.
Expand Down

0 comments on commit 814d0d1

Please sign in to comment.