Skip to content

Commit

Permalink
Refactor README.md to include detailed information about the infrastr…
Browse files Browse the repository at this point in the history
…ucture setup and usage
  • Loading branch information
italopessoa committed Sep 19, 2024
1 parent 09d8927 commit 5b9c5e9
Showing 1 changed file with 47 additions and 1 deletion.
48 changes: 47 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,47 @@
# bmb.infra
# bmb.infra
[![Terraform](https://github.com/soat-fiap/bmb.infra/actions/workflows/terraform.yml/badge.svg?branch=main)](https://github.com/soat-fiap/bmb.infra/actions/workflows/terraform.yml)

## Overview
This repository contains Terraform configurations to set up a Virtual Private Cloud (VPC) and an Elastic Kubernetes Service (EKS) cluster on AWS. These components form the core elements of the infrastructure, providing a scalable and secure environment for deploying containerized applications.

## Architecture
The architecture consists of the following components:
- **VPC (Virtual Private Cloud)**: A logically isolated network that provides the foundation for the AWS infrastructure.
- **Subnets**: Public and private subnets spread across multiple Availability Zones for high availability.
- **Internet Gateway**: Allows communication between the VPC and the internet.
- **NAT Gateway**: Enables instances in private subnets to connect to the internet while remaining unreachable from the outside.
- **EKS Cluster (Elastic Kubernetes Service)**: A managed Kubernetes service that simplifies running Kubernetes on AWS without needing to install and operate your own Kubernetes control plane or nodes.
- **Worker Nodes**: EC2 instances that run your containerized applications.

## Resources Created
- **VPC (Virtual Private Cloud)**: A logically isolated network that provides the foundation for the AWS infrastructure.
- **EKS Cluster (Elastic Kubernetes Service)**: A managed Kubernetes service that simplifies running Kubernetes on AWS without needing to install and operate your own Kubernetes control plane or nodes.

## Prerequisites
- Terraform installed on your local machine.
- AWS CLI configured with appropriate credentials.
- An AWS account with necessary permissions to create VPC and EKS resources.

## Usage
1. Clone the repository.
2. Navigate to the directory containing the Terraform files.
3. Initialize Terraform:
```sh
terraform init
```
4. Apply the Terraform configuration:
```sh
terraform apply
```

## Outputs
- **VPC ID**: The ID of the created VPC.
- **EKS Cluster Name**: The name of the created EKS cluster.
- **EKS Cluster Endpoint**: The endpoint URL for the EKS cluster.

## Notes
- Ensure that the AWS region specified in the Terraform configuration matches your desired deployment region.
- Review and customize the Terraform variables as needed to fit your specific requirements.

## License
This project is licensed under the MIT License. See the LICENSE file for more details.

0 comments on commit 5b9c5e9

Please sign in to comment.