storytold/terraform-aws-observability-accelerator
2
0
Fork 0
mirror of https://github.com/storytold/terraform-aws-observability-accelerator.git synced 2026-10-09 00:09:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs (#172)

Browse Source
This commit is contained in:
Rodrigue Koffi
2023-06-06 08:19:22 +02:00
committed by GitHub
parent 0392f5bda0
commit 1f16bec27f
7 changed files with 92 additions and 303 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/eks-cluster-with-vpc/README.md
+1 -90
View File
@@ -8,93 +8,4 @@ This example deploys the following Basic EKS Cluster with VPC
- Creates Internet gateway for Public Subnets and NAT Gateway for Private Subnets
- Creates EKS Cluster Control plane with one managed node group
## How to Deploy
### Prerequisites
Ensure that you have installed the following tools in your Mac or Windows Laptop before start working with this module and run Terraform Plan and Apply
1. [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
2. [Kubectl](https://Kubernetes.io/docs/tasks/tools/)
3. [Terraform](https://learn.hashicorp.com/tutorials/terraform/install-cli)
### Minimum IAM Policy
> **Note**: The policy resource is set as `*` to allow all resources, this is not a recommended practice.
You can find the policy [here](min-iam-policy.json)
### Deployment Steps
#### Step 1: Clone the repo using the command below
```sh
git clone https://github.com/aws-observability/terraform-aws-observability-accelerator.git
```
#### Step 2: Run Terraform INIT
Initialize a working directory with configuration files
```sh
cd examples/eks-cluster-with-vpc/
terraform init
```
#### Step 3: Run Terraform PLAN
Verify the resources created by this execution
```sh
export TF_VAR_aws_region=<ENTER YOUR REGION> # Select your own region
export TF_VAR_cluster_name=<ENTER YOUR CLUSTER NAME> # Enter your cluster name
terraform plan
```
#### Step 4: Finally, Terraform APPLY
**Deploy the pattern**
```sh
terraform apply
```
Enter `yes` to apply.
### Configure `kubectl` and test cluster
EKS Cluster details can be extracted from terraform output or from AWS Console to get the name of cluster.
This following command used to update the `kubeconfig` in your local machine where you run kubectl commands to interact with your EKS Cluster.
#### Step 5: Run `update-kubeconfig` command
`~/.kube/config` file gets updated with cluster details and certificate from the below command
aws eks --region <enter-your-region> update-kubeconfig --name <cluster-name>
#### Step 6: List all the worker nodes by running the command below
kubectl get nodes
#### Step 7: List all the pods running in `kube-system` namespace
kubectl get pods -n kube-system
## Cleanup
To clean up your environment, destroy the Terraform modules in reverse order.
Destroy the Kubernetes Add-ons, EKS cluster with Node groups and VPC
```sh
terraform destroy -target="module.eks_blueprints_kubernetes_addons" -auto-approve
terraform destroy -target="module.eks_blueprints" -auto-approve
terraform destroy -target="module.vpc" -auto-approve
```
Finally, destroy any additional resources that are not in the above modules
```sh
terraform destroy -auto-approve
```
You can view the full documentation for this example [here](https://aws-observability.github.io/terraform-aws-observability-accelerator/helpers/new-eks-cluster/)