Merge branch 'main' into ci-cd-with-github-action

Author: MinhHuynh2307

.github/workflows/build.yml

@@ -15,4 +15,4 @@ jobs:
           distribution: 'temurin'
           java-version: '21'
       - name: Maven Clean Verify
-        run: mvn -B -ntp clean verify
+        run: mvn -B -ntp clean verify

.github/workflows/deploy.yml

@@ -0,0 +1,103 @@
+name: Deploy Workflow
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs:
+      build_number:
+        description: "The build number to deploy (optional)"
+        required: false
+        type: string
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    env:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_IMAGE_NAME: product-service
+      DOCKER_COMPOSE_APP_SERVICE_NAME: product-service
+      DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+      EC2_SSH_PRIVATE_KEY: ${{ secrets.EC2_SSH_PRIVATE_KEY }}
+      EC2_PUBLIC_IP_ADDRESS: ${{ secrets.EC2_PUBLIC_IP_ADDRESS }}
+      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+    steps:
+      - name: Checkout
+        if: ${{ github.event.inputs.build_number == '' }}
+        uses: actions/checkout@v4
+      - name: Send slack message with github commit url
+        run: >
+          curl -X POST -H 'Content-type: application/json'
+          --data '{"text":":rocket: Deployment started for commit: ${{ github.event.head_commit.message }} - https://github.com/${{ github.repository }}/commit/${{ github.sha }}"}' 
+          ${{ env.SLACK_WEBHOOK_URL }}
+      - name: JDK
+        if: ${{ github.event.inputs.build_number == '' }}
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+      - name: Generate Build Number
+        run: |
+          if [ -n "${{ github.event.inputs.build_number }}" ]; then
+            BUILD_NUMBER=${{ github.event.inputs.build_number }}
+            echo "using provided build number: $BUILD_NUMBER"
+            curl -X POST -H 'Content-type: application/json' --data "{\"text\":\":package: Using provided build number: $BUILD_NUMBER\"}" ${{ env.SLACK_WEBHOOK_URL }}
+          else
+            BUILD_NUMBER=$(date +'%d%m%Y%H%M%S')
+            echo "using generated build number: $BUILD_NUMBER"
+            curl -X POST -H 'Content-type: application/json' --data "{\"text\":\":gear: Generated new build number: $BUILD_NUMBER\"}" ${{ env.SLACK_WEBHOOK_URL }}
+          fi
+          echo "BUILD_NUMBER=$BUILD_NUMBER" >> $GITHUB_ENV
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ env.DOCKER_USERNAME }}
+          password: ${{ env.DOCKER_PASSWORD }}
+      - name: Check if provided docker image exists
+        if: ${{ github.event.inputs.build_number != '' }}
+        run: |
+          IMAGE="${{ env.DOCKER_USERNAME }}/${{ env.DOCKER_IMAGE_NAME }}:$BUILD_NUMBER"
+          echo "checking if $IMAGE exists"
+          if ! docker manifest inspect "$IMAGE" > /dev/null 2>&1; then
+            echo "provided image $IMAGE does not exist. exiting..."
+            curl -X POST -H 'Content-type: application/json' --data "{\"text\":\":x: :warning: Provided image $IMAGE does not exist! Exiting deployment...\"}" ${{ env.SLACK_WEBHOOK_URL }}
+            exit 1
+          fi
+          echo "provided image $IMAGE exists ✅"
+          curl -X POST -H 'Content-type: application/json' --data "{\"text\":\":white_check_mark: Image $IMAGE exists and ready for deployment\"}" ${{ env.SLACK_WEBHOOK_URL }}
+          echo "IMAGE=$IMAGE" >> $GITHUB_ENV
+
+      - name: Maven Clean Verify
+        if: ${{ github.event.inputs.build_number == '' }}
+        run: |
+          curl -X POST -H 'Content-type: application/json' --data "{\"text\":\":hammer_and_wrench: Building and deploying to Docker Hub...\"}" ${{ env.SLACK_WEBHOOK_URL }}
+          mvn -B -ntp clean verify jib:build -Ddocker.image.tag=$BUILD_NUMBER
+          curl -X POST -H 'Content-type: application/json' --data "{\"text\":\":white_check_mark: Successfully built and pushed to Docker Hub\"}" ${{ env.SLACK_WEBHOOK_URL }}
+      - name: Setup SSH Agent
+        uses: webfactory/ssh-agent@v0.9.0
+        with:
+          ssh-private-key: ${{ env.EC2_SSH_PRIVATE_KEY }}
+      - name: SSH To EC2 and Deploy
+        run: |
+          curl -X POST -H 'Content-type: application/json' --data '{"text":":cloud: Deploying to AWS EC2..."}' ${{ env.SLACK_WEBHOOK_URL }}
+          ssh -o StrictHostKeyChecking=no ec2-user@$EC2_PUBLIC_IP_ADDRESS << EOF
+            cd ~
+            sed -i 's|image: '"$DOCKER_USERNAME"'/'"$DOCKER_IMAGE_NAME"':.*$|image: '"$DOCKER_USERNAME"'/'"$DOCKER_IMAGE_NAME"':'"$BUILD_NUMBER"'|' docker-compose.yml
+            docker-compose pull
+            docker-compose up -d '$DOCKER_COMPOSE_APP_SERVICE_NAME'
+            docker image prune -f
+            docker ps
+            echo "$BUILD_NUMBER" > build-number.txt
+          EOF
+          curl -X POST -H 'Content-type: application/json' --data "{\"text\":\":tada: Successfully deployed to AWS EC2\"}" ${{ env.SLACK_WEBHOOK_URL }}
+      - name: Send slack message with status
+        if: always()
+        run: |
+          if [ "${{ job.status }}" == "success" ]; then
+            EMOJI=":tada:"
+            MESSAGE="Deployment completed successfully!"
+          else
+            EMOJI=":x:"
+            MESSAGE="Deployment failed!"
+          fi
+          curl -X POST -H 'Content-type: application/json' --data "{\"text\":\"$EMOJI $MESSAGE - Job status: ${{ job.status }}\"}" ${{ env.SLACK_WEBHOOK_URL }}

AWS_DEPLOYMENT_CHECKLIST.md

@@ -0,0 +1,92 @@
+# Quick AWS Deployment Checklist
+
+## ✅ What You Need to Do in AWS Console
+
+### 1. Create S3 Bucket
+- Go to **S3** → **Create bucket**
+- Name: `yourcompany-product-images-prod` (unique name)
+- Region: Same as your EC2 (e.g., `us-east-1`)
+- Encryption: Enable (SSE-S3)
+- **Save bucket name**
+
+### 2. Create IAM Policy
+- Go to **IAM** → **Policies** → **Create policy**
+- Use JSON tab, paste:
+```json
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": ["s3:GetObject", "s3:PutObject", "s3:DeleteObject", "s3:HeadObject"],
+            "Resource": "arn:aws:s3:::YOUR-BUCKET-NAME/*"
+        },
+        {
+            "Effect": "Allow",
+            "Action": ["s3:ListBucket"],
+            "Resource": "arn:aws:s3:::YOUR-BUCKET-NAME"
+        }
+    ]
+}
+```
+- Replace `YOUR-BUCKET-NAME` with your bucket name
+- Name: `ProductServiceS3Policy`
+
+### 3. Create IAM Role (Recommended)
+- Go to **IAM** → **Roles** → **Create role**
+- Select **EC2** → **Next**
+- Attach `ProductServiceS3Policy` → **Next**
+- Name: `EC2-S3-Access-Role` → **Create role**
+
+### 4. Attach Role to EC2
+- Go to **EC2** → **Instances**
+- Select your instance → **Actions** → **Security** → **Modify IAM role**
+- Select `EC2-S3-Access-Role` → **Update**
+
+### 5. Update Application Configuration
+
+Create `application-prod.properties` or use environment variables:
+
+```properties
+aws.region=us-east-1
+aws.s3.bucket=your-bucket-name-here
+aws.s3.endpoint-override=
+aws.s3.path-style-enabled=false
+aws.access-key-id=
+aws.secret-access-key=
+```
+
+**Note**: Leave access keys empty if using IAM role (recommended)
+
+### 6. Deploy Application
+```bash
+# Build
+mvn clean package
+
+# Copy to EC2
+scp -i key.pem target/product-service.jar ec2-user@your-ec2-ip:~/app/
+
+# SSH into EC2
+ssh -i key.pem ec2-user@your-ec2-ip
+
+# Run with production config
+cd ~/app
+java -jar product-service.jar --spring.config.location=application-prod.properties
+```
+
+## 🔐 Alternative: Using Access Keys (Less Secure)
+
+If not using IAM role, create IAM user:
+- **IAM** → **Users** → **Create user**
+- Attach `ProductServiceS3Policy`
+- Create access key → **Save keys securely**
+- Set environment variables on EC2:
+```bash
+export AWS_ACCESS_KEY_ID=your-key-id
+export AWS_SECRET_ACCESS_KEY=your-secret-key
+```
+
+---
+
+**See `AWS_DEPLOYMENT_GUIDE.md` for detailed step-by-step instructions.**
+