Minor fixes and readme changes

Signed-off-by: Akhil <2100030084@kluniversity.in>

Author: git-user-9

.github/workflows/deploy.yml

@@ -83,6 +83,7 @@ jobs:
         S3_BUCKET=$(terraform output -raw s3_log_bucket)
         echo "INSTANCE_IP=$INSTANCE_IP" >> $GITHUB_ENV
         echo "S3_BUCKET=$S3_BUCKET" >> $GITHUB_ENV
+        
         echo "📦 App IP: $INSTANCE_IP"
         echo "🪣 S3 Bucket: $S3_BUCKET"
 
@@ -95,14 +96,17 @@ jobs:
     # Validate App Health
     - name: Validate App Health
       run: |
-        echo "🔎 Checking app health at http://${INSTANCE_IP}:80"
+        echo -e "\n📦 Full Response from App:\n"
+        curl -s http://${{ env.INSTANCE_IP }}:80 || echo "❌ Failed to get response"
+        echo -e "\n"
+        echo "Checking app health at http://${{ env.INSTANCE_IP }}:80"
         for i in {1..10}; do
-          STATUS=$(curl -o /dev/null -s -w "%{http_code}" http://${INSTANCE_IP}:80)
+          STATUS=$(curl -o /dev/null -s -w "%{http_code}" http://${{ env.INSTANCE_IP }}:80)
           if [[ "$STATUS" == "200" ]]; then
             echo "✅ App is healthy (HTTP 200)"
             exit 0
           else
-            echo "Attempt $i: HTTP $STATUS"
+            echo "Attempt $i: got HTTP $STATUS"
             sleep 10
           fi
         done

README.md

@@ -16,7 +16,7 @@ tech_eazy_devops_git-user-9/
 ├── terraform/                 # Terraform configurations
 │   ├── main.tf                # Main Terraform configuration file
 │   ├── outputs.tf             # Defines Terraform outputs (e.g., EC2 public IP)
-│   ├── variables.tf           # Public variables file for EC2 and other details
+│   ├── variables.tf           # Common variables (e.g., region, key pair name)
 │   ├── dev_config.tfvars      # Variable values for 'Dev' environment
 │   ├── prod_config.tfvars     # Variable values for 'Prod' environment
 ├── scripts/                   # Shell scripts for configuration and log validation
@@ -47,6 +47,38 @@ tech_eazy_devops_git-user-9/
 
 ---
 
+## 🔑 **Step: Configure Terraform Variables**
+
+Before triggering deployment, update the Terraform configuration files for your AWS environment:
+
+1. Open `terraform/variables.tf`
+2. Set the default values for common variables like EC2 Key Pair name:
+
+```hcl
+variable "key_name" {
+  default = "your-ec2-keypair-name" # Set your AWS Key Pair name
+}
+```
+
+3. Edit `terraform/dev_config.tfvars` and `terraform/prod_config.tfvars`:
+
+* Example (`dev_config.tfvars`):
+
+```hcl
+key_name      = "your-ec2-keypair-name"
+```
+
+* Example (`prod_config.tfvars`):
+
+```hcl
+key_name      = "your-ec2-keypair-name"
+```
+
+⚠️ Ensure your EC2 Key Pair exists in the selected AWS region. 
+*ap-south-1 (Mumbai) is being used by default in this project, so kindly create a ec2 key pair on this region for smoother experience during execution. Otherwise kindly change ap-south-1 at all places to your preferred region*
+
+---
+
 ## 🔐 **How to Get SSH Private Key from .pem File**
 
 When you create an AWS EC2 Key Pair, AWS provides a `.pem` file. To use this in GitHub Actions, you must convert it to a format that can be stored as a secret.
@@ -83,31 +115,70 @@ The deployment is managed via GitHub Actions.
 * **Git Tags**: `deploy-dev` (for Dev), `deploy-prod` (for Prod)
 * **Manual Trigger**: Run from GitHub Actions → Select Stage (dev/prod)
 
+---
+
+#### 🏷️ **Trigger Deployment via Git Tags**
+
+To deploy to **Dev** or **Prod**, create and push the appropriate Git tag:
+
+*⚠️ Make sure your working directory is clean (git status) before creating tags to avoid pushing unwanted changes.*
+
+##### For Dev Environment:
+
+```bash
+git tag deploy-dev
+git push origin deploy-dev
+```
+
+##### For Prod Environment:
+
+```bash
+git tag deploy-prod
+git push origin deploy-prod
+```
+
+The GitHub Actions workflow will automatically detect the tag and deploy to the respective environment.
+
+---
+
+---
+
 ### 📖 Overview of Workflow
 
 The workflow performs the following steps:
 
 1. **Checkout Repository** – Fetches the code from the repository.
+
 2. **Configure AWS Credentials** – Uses GitHub Secrets to authenticate with AWS.
+
 3. **Setup Terraform** – Installs Terraform and initializes configuration.
+
 4. **Determine Stage** – Sets the target environment (dev or prod) based on trigger type.
-5. **Provision App EC2 Instance (Write Access)** –
+
+5. **Provision App EC2 Instance (Write Access)**
 
    * Deploys the first EC2 instance with **write access to S3**.
    * Installs required software (Java, Maven, Git, etc.).
    * Pulls source code from the repository and builds the Maven application.
    * Runs the application and pushes logs (system and app logs) to the S3 bucket.
-6. **Provision Verifier EC2 Instance (Read Access)** –
+
+6. **Provision Verifier EC2 Instance (Read Access)**
 
    * Deploys a second EC2 instance with **read-only access to S3**.
    * Uses AWS CLI to pull logs from the S3 bucket to the instance.
-7. **Log Validation via SSH** –
+
+7. **Log Validation via SSH**
 
    * SSH into the Verifier EC2 instance.
    * Validates that required logs exist in S3.
    * Prints the last 20 lines of each log for inspection.
+
 8. **App Health Check** – Ensures the application is healthy (HTTP 200 response).
+
 9. **Destroy Infrastructure** – After validation, destroys all provisioned resources and cleans up Terraform workspaces.
 
+
 This workflow fully automates the lifecycle: provisioning, deployment, validation, and cleanup, ensuring no manual intervention is needed during the process.
 
+---
+

terraform/dev_config.tfvars

@@ -3,7 +3,7 @@ key_name      = "ssh-key-ec2" #change this to your key-pair name
 # ami_id            = "ami-0f918f7e67a3323f0"
 stage             = "dev"
 shutdown_minutes  = 30
-s3_bucket_name    = "techeazy-logs-dev-unique123ss" # Change this!
+s3_bucket_name    = "techeazy-logs-unique123ss" # Change this!
 aws_region        = "ap-south-1"
 repo_url          = "https://github.com/techeazy-consulting/techeazy-devops"
 verifier_lifetime = 25

terraform/prod_config.tfvars

@@ -3,7 +3,7 @@ key_name      = "ssh-key-ec2" #change this to your key-pair name
 # ami_id            = "ami-0f918f7e67a3323f0"
 stage             = "prod"
 shutdown_minutes  = 25
-s3_bucket_name    = "techeazy-logs-prod-unique123ss" # Change this!
+s3_bucket_name    = "techeazy-logs-unique123ss" # Change this!
 aws_region        = "ap-south-1"
 repo_url          = "https://github.com/techeazy-consulting/techeazy-devops"
 verifier_lifetime = 25