Merge pull request #52 from manikanta-sadurla/feature/update-document

Updated Document

Author: mayank0202

README.md

@@ -5,7 +5,7 @@
 [![Known Vulnerabilities](https://github.com/sourcefuse/terraform-aws-arc-ecs/actions/workflows/snyk.yaml/badge.svg)](https://github.com/sourcefuse/terraform-aws-arc-ecs/actions/workflows/snyk.yaml)
 ## Overview
 
-Terraform Module for AWS ECS by the SourceFuse ARC team.
+SourceFuse's AWS Reference Architecture Terraform module leverages the terraform-aws-modules/terraform-aws-ecs GitHub repository to facilitate the deployment and management of an AWS ECS (Elastic Container Service) cluster. It streamlines the configuration of ECS tasks, services, and related components, providing a scalable and efficient solution for orchestrating containerized applications. With customizable settings for logging, load balancing, and service discovery, the module promotes seamless deployment and management of containerized workloads on AWS.
 
 The module assumes that upstream dependencies, namely networking dependencies, are created upstream and the values are passed into this module via mechanisms such as Terraform data source queries.
 
@@ -20,17 +20,48 @@ The module provisions
 * Utilizes ACM to generate a certificate specific to the ALB.
 * Tags/SSM params - the module tags resources and outputs SSM params that can be used in data source lookups downstream for ECS services to reference to deploy into the cluster.
 
+
 ![Module Structure](./static/arc_ecs_basic_components.png)
 
 Our approach to ECS Fargate clusters is to provision a cluster and allow downstream services to attach to it via convention based data source queries.
 
-**Note**: the example below is does not have a pinned version. Be sure to pin your version. Refer to the `example` folder for a working example version.
-## Usage
+### Prerequisites
+Before using this module, ensure you have the following:
+
+- AWS credentials configured.
+- Terraform installed.
+- A working knowledge of Terraform.
+- Route 53 hosted zone
+- Network
+
+
+## Getting Started
+
+1. **Define the Module**
+
+Initially, it's essential to define a Terraform module, which is organized as a distinct directory encompassing Terraform configuration files. Within this module directory, input variables and output values must be defined in the variables.tf and outputs.tf files, respectively. The following illustrates an example directory structure:
+
+
+```plaintext
+ecs/
+|-- main.tf
+|-- variables.tf
+|-- outputs.tf
+```
+
+
+2. **Define Input Variables**
+
+Inside the `variables.tf` or in `*.tfvars` file, you should define values for the variables that the module requires.
+
+3. **Use the Module in Your Main Configuration**
+In your main Terraform configuration file (e.g., main.tf), you can use the module. Specify the source of the module, and version, For Example
+
 
 ```hcl
 module "ecs" {
-  source      = "sourcefuse/arc-ecs/aws"
-  version     = "1.3.7"
+  source = "sourcefuse/arc-ecs/aws"
+  version     = "1.5.2"
 
   environment = var.environment
   namespace   = var.namespace
@@ -46,7 +77,8 @@ module "ecs" {
   // -------------------------- END ------------------------- //
 
   ## create acm certificate and dns record for health check
-  route_53_zone                 = local.route_53_zone
+  route_53_zone_name            = var.route_53_zone
+  route_53_zone_id              = data.aws_route53_zone.this.id
   acm_domain_name               = "healthcheck-ecs-${var.namespace}-${var.environment}.${local.route_53_zone}"
   acm_subject_alternative_names = []
   health_check_route_53_records = [
@@ -61,6 +93,36 @@ module "ecs" {
 }
 ```
 
+4. **Output Values**
+
+Inside the `outputs.tf` file of the module, you can define output values that can be referenced in the main configuration. For example:
+
+```hcl
+output "cluster_name" {
+  description = "Name of the ECS Cluster"
+  value       = module.ecs.cluster_name
+}
+
+output "health_check_fqdn" {
+  description = "Health check FQDN record created in Route 53."
+  value       = module.ecs.health_check_fqdn
+}
+```
+
+5. **Execute Terraform Commands**
+
+After defining your main configuration, navigate to the directory containing your Terraform files and run the following commands:
+
+
+```bash
+terraform init
+terraform apply
+```
+
+6. **Review and Confirm**
+
+Terraform will display a plan showing the changes it intends to make. Review the plan and confirm by typing 'yes' when prompted.
+
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
@@ -188,6 +250,18 @@ You can append to this array by adding values to `var.additional_ssm_params`.
 
 ## Development
 
+### Versioning 
+
+while Contributing or doing git commit please specify the breaking change in your commit message whether its major,minor or patch
+
+For Example
+
+```sh
+git commit -m "your commit message #major"
+```
+By specifying this , it will bump the version and if you don't specify this in your commit message then by default it will consider patch and will bump that accordingly
+
+
 ### Prerequisites
 
 - [terraform](https://learn.hashicorp.com/terraform/getting-started/install#installing-terraform)
@@ -203,17 +277,6 @@ You can append to this array by adding values to `var.additional_ssm_params`.
   pre-commit install
   ```
 
-### Git commits
-
-while Contributing or doing git commit please specify the breaking change in your commit message whether its major,minor or patch
-
-For Example
-
-```sh
-git commit -m "your commit message #major"
-```
-By specifying this , it will bump the version and if you don't specify this in your commit message then by default it will consider patch and will bump that accordingly
-
 ### Tests
 - Tests are available in `test` directory
 - Configure the dependencies