Skip to content

Commit

Permalink
update readme for new module
Browse files Browse the repository at this point in the history
  • Loading branch information
morga471 committed Sep 19, 2024
1 parent a54f827 commit 47fff91
Showing 1 changed file with 3 additions and 69 deletions.
72 changes: 3 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,7 @@
# tfmod-eks
Create an EKS cluster given the specification of the cluster.
# tfmod-eks-dns
This module is designed to add DNS to an EKS cluster through the creation of the route53_zone for the cluster domain.

The module creates an EKS cluster named cluster_name in the region using kuberenetes version cluster_version with eks_ng_desired_size nodes initially. The services in the cluster will be accessible using hostnames for the services ending with the cluster_name.domain fully qualified domain name. The cluster-autoscaler will resize the node group based upon capacity from a minimum of eks_ng_min_size to a maximum of eks_ng_max_size. The eks_instance_types is a prioritized list of instance types to use as the worker nodes. Note that it is best if the vCPU and Mem sizes of all of the instance types are the same.

The cluster is configured with an oidc provider allowing service accounts to be configured with IRSA roles as needed.

## Addons
Addons installed:

* amazon-cloudwatch-observability
* aws-ebs-csi-driver
* aws-efs-csi-driver
* coredns
* kube-proxy
* snapshot-controller

### Apply
Successful completion should show:
```terraform
Apply complete! Resources: 80 added, 0 changed, 0 destroyed.
real 12m24.922s
user 0m17.709s
sys 0m2.079s
```

### Destroy
Successful destroy should show:
```terraform
Destroy complete! Resources: 80 destroyed.
real 10m48.444s
user 0m17.624s
sys 0m2.040s
```

### Verification

To verify the nodes were created, use kubectl like
`kubectl get nodes` which should ouput:

```bash
[morga471@iebcloud terraform]$ k get nodes
NAME STATUS ROLES AGE VERSION
ip-10-129-62-142.us-gov-east-1.compute.internal Ready <none> 4m7s v1.30.1-eks-e564799
```

To verify the pods for the base cluster were created, use kubectl like
`k get pods -A`

```bash
[morga471@iebcloud terraform]$ k get pods -A
NAMESPACE NAME READY STATUS RESTARTS AGE
amazon-cloudwatch amazon-cloudwatch-observability-controller-manager-5c9d9677h2xf 1/1 Running 0 2m58s
amazon-cloudwatch cloudwatch-agent-95g5j 1/1 Running 0 2m52s
amazon-cloudwatch fluent-bit-cnp45 1/1 Running 0 2m58s
kube-system aws-node-dsdqg 2/2 Running 0 3m8s
kube-system coredns-5479bb6d65-c6x79 1/1 Running 0 3m11s
kube-system coredns-5479bb6d65-j74cm 1/1 Running 0 3m11s
kube-system ebs-csi-controller-7cd8c597d7-96j7p 6/6 Running 0 3m10s
kube-system ebs-csi-controller-7cd8c597d7-m48j8 6/6 Running 0 3m9s
kube-system ebs-csi-node-x555s 3/3 Running 0 3m10s
kube-system efs-csi-controller-85c5486b89-rdjk8 3/3 Running 0 3m9s
kube-system efs-csi-controller-85c5486b89-v6fx2 3/3 Running 0 3m9s
kube-system efs-csi-node-tz47s 3/3 Running 0 3m9s
kube-system kube-proxy-qbgbk 1/1 Running 0 4m12s
kube-system snapshot-controller-7f8d9b84dd-7w7qz 1/1 Running 0 3m10s
kube-system snapshot-controller-7f8d9b84dd-nqqsb 1/1 Running 0 3m10s
```

#### Changelog
## Changelog
Change logs are auto-generated with commitizen.

[CHANGELOG.md](CHANGELOG.md)
Expand Down

0 comments on commit 47fff91

Please sign in to comment.