Skip to content

Commit 0e79805

Browse files
committed
Improved documentation in README.md.
1 parent c64846b commit 0e79805

2 files changed

Lines changed: 39 additions & 12 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
# 0.1.1 (Mar 24, 2026)
2+
* Improved documentation in README.md.
3+
14
# 0.1.0 (Mar 10, 2026)
25
* Initial release

README.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,40 @@
1-
# aws-eks
1+
# aws-eks-auto
22

3-
This is a nullstone module to create an AWS-managed Kubernetes Cluster using EKS and Fargate.
4-
This module comes with a `deployers` IAM group that has privileges to perform deployments.
3+
Creates a Kubernetes cluster in Auto mode that uses AWS-managed node groups.
54

6-
## Security & Compliance
5+
## When to use?
76

8-
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
7+
### When Auto Mode is GREAT
8+
- SaaS workloads
9+
- stateless services
10+
- CI runners
11+
- internal platforms
12+
- preview environments (👀 very relevant to you)
13+
- cost optimization focus
14+
- teams without deep k8s infra skills
915

10-
[![Infrastructure Security](https://www.bridgecrew.cloud/badges/github/nullstone-modules/aws-fargate/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=nullstone-modules%2Faws-fargate&benchmark=INFRASTRUCTURE+SECURITY)
11-
[![CIS AWS V1.3](https://www.bridgecrew.cloud/badges/github/nullstone-modules/aws-fargate/cis_aws_13)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=nullstone-modules%2Faws-fargate&benchmark=CIS+AWS+V1.3)
12-
[![PCI-DSS V3.2](https://www.bridgecrew.cloud/badges/github/nullstone-modules/aws-fargate/pci)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=nullstone-modules%2Faws-fargate&benchmark=PCI-DSS+V3.2)
13-
[![NIST-800-53](https://www.bridgecrew.cloud/badges/github/nullstone-modules/aws-fargate/nist)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=nullstone-modules%2Faws-fargate&benchmark=NIST-800-53)
14-
[![ISO27001](https://www.bridgecrew.cloud/badges/github/nullstone-modules/aws-fargate/iso)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=nullstone-modules%2Faws-fargate&benchmark=ISO27001)
15-
[![SOC2](https://www.bridgecrew.cloud/badges/github/nullstone-modules/aws-fargate/soc2)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=nullstone-modules%2Faws-fargate&benchmark=SOC2)
16-
[![HIPAA](https://www.bridgecrew.cloud/badges/github/nullstone-modules/aws-fargate/hipaa)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=nullstone-modules%2Faws-fargate&benchmark=HIPAA)
16+
### When Auto Mode is NOT ideal
17+
- custom networking
18+
- heavy DaemonSet reliance
19+
- GPU tuning
20+
- special storage drivers
21+
- low-level performance control
22+
- platform engineering teams wanting full control
23+
- highly predictable infra topology needs
24+
25+
## Included Addons
26+
27+
AWS automatically manages the following addons:
28+
- VPC CNI
29+
- CoreDNS
30+
- kube-proxy
31+
- Pod Identity Agent
32+
- metrics server
33+
- networking dataplane components
34+
35+
## Limitations
36+
37+
In auto mode, AWS manages a fleet of nodes which prevents you from performing various operations:
38+
1. You cannot run DaemonSets.
39+
2. You cannot SSH into nodes.
40+
3. You cannot optimize pod scheduling; AWS optimizes this.

0 commit comments

Comments
 (0)