[20기_임가현, 황서아] spring_vote 미션 제출합니다.

.gitattributes

@@ -0,0 +1,3 @@
+/gradlew text eol=lf
+*.bat text eol=crlf
+*.jar binary

.github/workflows/CICD.yml

@@ -0,0 +1,121 @@
+# github repository actions 페이지에 나타날 이름
+name: CI/CD using github actions & docker
+
+# event trigger
+# main브랜치에 pull request가 발생 되었을 때 실행
+on:
+  pull_request:
+    branches: [ "master" ]
+  push:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v3
+
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Gradle Caching
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+
+      - name: Build Project with Gradle
+        run: |
+          echo ${{ secrets.APPLICATION_SECRET }} | base64 --decode > ./src/main/resources/application-secret.yml
+          ./gradlew bootJar
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Build docker image
+        run: docker build --platform linux/amd64 -t ${{ secrets.DOCKER_USERNAME }}/vote .
+
+      - name: Publish image to docker hub
+        run: docker push ${{ secrets.DOCKER_USERNAME }}/vote:latest
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set Target IP
+        run: |
+          STATUS=$(curl -o /dev/null -w "%{http_code}" "${{ secrets.SERVER_IP }}/env")
+          echo $STATUS
+          if [ $STATUS = 200 ]; then
+            CURRENT_UPSTREAM=$(curl -s "${{ secrets.SERVER_IP }}/env")
+          else
+            CURRENT_UPSTREAM=green
+          fi
+          echo CURRENT_UPSTREAM=$CURRENT_UPSTREAM >> $GITHUB_ENV
+          if [ $CURRENT_UPSTREAM = blue ]; then
+            echo "CURRENT_PORT=8080" >> $GITHUB_ENV
+            echo "STOPPED_PORT=8081" >> $GITHUB_ENV
+            echo "TARGET_UPSTREAM=green" >> $GITHUB_ENV
+          else
+            echo "CURRENT_PORT=8081" >> $GITHUB_ENV
+            echo "STOPPED_PORT=8080" >> $GITHUB_ENV
+            echo "TARGET_UPSTREAM=blue" >> $GITHUB_ENV
+          fi
+
+      - name: Docker Compose
+        uses: appleboy/ssh-action@master
+        with:
+          username: ubuntu
+          host: ${{ secrets.SERVER_IP }}
+          key: ${{ secrets.EC2_SSH_KEY }}
+          script_stop: true
+          script: |
+            export JWT_SECRET_KEY=${{ secrets.JWT_SECRET_KEY }}
+            sudo docker pull ${{ secrets.DOCKER_USERNAME }}/vote:latest
+            sudo docker-compose -f docker-compose-${{env.TARGET_UPSTREAM}}.yml up -d
+
+      - name: Check deploy server URL
+        uses: jtalk/url-health-check-action@v3
+        with:
+          url: http://${{ secrets.SERVER_IP }}:${{ env.STOPPED_PORT }}/env
+          max-attempts: 5
+          retry-delay: 10s
+
+      - name: Change nginx upstream
+        uses: appleboy/ssh-action@master
+        with:
+          username: ubuntu
+          host: ${{ secrets.SERVER_IP }}
+          key: ${{ secrets.EC2_SSH_KEY }}
+          script_stop: true
+          script: |
+            sudo docker exec -i nginxserver bash -c 'echo "set \$service_url ${{env.TARGET_UPSTREAM}};" > etc/nginx/conf.d/service-env.inc && nginx -s reload'
+
+      - name: Stop current server
+        uses: appleboy/ssh-action@master
+        with:
+          username: ubuntu
+          host: ${{ secrets.SERVER_IP }}
+          key: ${{ secrets.EC2_SSH_KEY }}
+          script_stop: true
+          script: |
+            sudo docker stop ${{ env.CURRENT_UPSTREAM }}
+            sudo docker rm ${{ env.CURRENT_UPSTREAM }}
+

.gitignore

@@ -0,0 +1,42 @@
+HELP.md
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+### 환경변수 ###
+.env
+
+application-secret.yml

Dockerfile

@@ -0,0 +1,8 @@
+FROM openjdk:17-jdk-slim
+
+ARG JAR_FILE=/build/libs/*.jar
+ARG PROFILES
+ARG ENV
+
+COPY ${JAR_FILE} app.jar
+ENTRYPOINT ["java", "-Dspring.profiles.active=${PROFILES}", "-Dserver.env=${ENV}", "-jar", "app.jar"]

README.md

@@ -1 +1,180 @@
-# spring_vote_20th
+# spring_vote_20th
+
+## ERD
+전체 ERD
+
+<img width="747" alt="스크린샷 2025-01-05 오후 2 29 35" src="https://github.com/user-attachments/assets/4ee1f4e3-8a45-42b9-ad0a-5ca8425de985" />
+
+- 유저, 파트장 투표, 팀 투표를 분리시켜 구성하였다.
+
+### User
+사용자에 관한 테이블
+
+<img width="344" alt="스크린샷 2025-01-05 오후 2 57 58" src="https://github.com/user-attachments/assets/6b699059-c602-4d4c-bf5e-169549a3e821" />
+
+- 사용자는 name과 password를 통해 로그인을 할 수 있다.
+
+### Leader Vote
+파트장 투표에 관한 테이블
+
+<img width="800" alt="스크린샷 2025-01-05 오후 4 07 38" src="https://github.com/user-attachments/assets/48147c43-fd44-4a0f-87c7-32dbf82b2571" />
+
+- Leader Candidate에는 후보자의 이름과 파트 그리고 후보자 id가 있다.
+- Leader Vote는 투표한 사용자의 id와 사용자가 투표한 후보자 id 그리고 투표 고유 id가 있다.
+- 사용자 id와 후보자 id는 외래키로 받아왔다.
+
+### Team Vote
+팀 투표에 관한 테이블
+
+<img width="594" alt="스크린샷 2025-01-05 오후 4 12 14" src="https://github.com/user-attachments/assets/084b613c-c84b-467a-a327-b37d86c28b6a" />
+
+- Team Candidate는 팀명과 팀 고유 id로 구성되어 있다.
+- Team Vote는 투표한 사용자 id, 사용자가 투표한 팀 id 그리고 투표 고유 id가 있다.
+- 사용자 id와 사용자 id는 외래키로 받아왔다.
+
+## 배포 - blue green 무중단 배포
+### blue green 배포란?
+https://github.com/user-attachments/assets/d603aaa1-c8fc-4ef2-829a-629b2a35b09e
+
+```yaml
+spring:
+  profiles:
+    active: local
+    group:
+      local: local, common, secret
+      blue: blue, common, secret
+      green: green, common, secret
+
+---
+
+spring:
+  config:
+    activate:
+    on-profile: blue
+
+server:
+  port: 8080
+  serverAddress: 13.124.171.94
+
+serverName: blue_server
+
+---
+
+spring:
+  config:
+    activate:
+      on-profile: common
+    import: optional:file:.env[.properties]
+```
+application.yml
+
+
+### nginx load balancing
+- blue server - 8080 port
+- green server - 8081 port
+
+http://52.79.122.106 → nginx로 8080 or 8081 port 중 실행 중인 port로 연결
+
+
+### github action
+```yaml
+
+
+# event trigger
+# main브랜치에 pull request가 발생 되었을 때 실행
+on:
+  pull_request:
+    branches: [ "master" ]
+  push:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    steps:
+      - name: Checkout source
+
+      - name: Setup Java
+
+      - name: Gradle Caching
+
+      - name: Grant execute permission for gradlew
+
+      - name: Build Project with Gradle
+
+      - name: Login to DockerHub
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Build docker image
+        run: docker build --platform linux/amd64 -t ${{ secrets.DOCKER_USERNAME }}/vote .
+
+      - name: Publish image to docker hub
+        run: docker push ${{ secrets.DOCKER_USERNAME }}/vote:latest
+
+  deploy:
+    steps:
+      - name: Set Target IP
+        run: |
+          STATUS=$(curl -o /dev/null -w "%{http_code}" "${{ secrets.SERVER_IP }}/env")
+          echo $STATUS
+          if [ $STATUS = 200 ]; then
+            CURRENT_UPSTREAM=$(curl -s "${{ secrets.SERVER_IP }}/env")
+          else
+            CURRENT_UPSTREAM=green
+          fi
+          echo CURRENT_UPSTREAM=$CURRENT_UPSTREAM >> $GITHUB_ENV
+          if [ $CURRENT_UPSTREAM = blue ]; then
+            echo "CURRENT_PORT=8080" >> $GITHUB_ENV
+            echo "STOPPED_PORT=8081" >> $GITHUB_ENV
+            echo "TARGET_UPSTREAM=green" >> $GITHUB_ENV
+          else
+            echo "CURRENT_PORT=8081" >> $GITHUB_ENV
+            echo "STOPPED_PORT=8080" >> $GITHUB_ENV
+            echo "TARGET_UPSTREAM=blue" >> $GITHUB_ENV
+          fi
+
+      - name: Docker Compose
+        with:
+          script: |
+            export JWT_SECRET_KEY=${{ secrets.JWT_SECRET_KEY }}
+            sudo docker pull ${{ secrets.DOCKER_USERNAME }}/vote:latest
+            sudo docker-compose -f docker-compose-${{env.TARGET_UPSTREAM}}.yml up -d
+
+      - name: Check deploy server URL
+        with:
+          url: http://${{ secrets.SERVER_IP }}:${{ env.STOPPED_PORT }}/env
+
+      - name: Change nginx upstream
+        with:
+          script: |
+            sudo docker exec -i nginxserver bash -c 'echo "set \$service_url ${{env.TARGET_UPSTREAM}};" > etc/nginx/conf.d/service-env.inc && nginx -s reload'
+
+      - name: Stop current server
+        with:
+          script: |
+            sudo docker stop ${{ env.CURRENT_UPSTREAM }}
+            sudo docker rm ${{ env.CURRENT_UPSTREAM }}
+
+```
+
+### trouble shooting
+**JWT_SECRET_KEY를 읽지 못해서 발생하는 빌드 에러**
+
+1. git secrets에 JWT_SECRET_KEY 변수를 추가 → docker-compose 파일을 실행할 때 넣어주려고 했으나 인식하지 못하는 문제가 발생함.
+2. CICD.yml 파일 내에서 $GITHUB_ENV에 JWT_SECRET_KEY값을 저장 → 키가 외부에 노출되면 안되기 때문에 보안 문제 발생
+3. docker-compse.yml 파일에서 직접 추가 → 성공
+    ```yaml
+    environment:
+      - JWT_SECRET_KEY=
+    ```
+
+
+**보안 규칙**
+1. 8080 port, 8081 port를 번갈아가며 사용하기 때문에 두 port에 대한 inbound 규칙 추가
+
+**비밀번호를 인식하지 못하는 문제**
+1. 로그인 기능을 먼저 구현한 뒤, 테이블에 직접 데이터를 넣고 로그인 테스트를 해보았으나 비밀번호를 인식하지 못하여 실패
+2. 비밀번호가 암호화되어 입력되어야 하는데 직접 데이터를 넣었기 때문에 암호화되지 않은 채로 들어가 문제가 생겼음을 인식
+3. 회원가입 구현 후에 다시 로그인을 시도했으나 여전히 비밀번호를 인식하지 못함
+4. import문을 잘못 가지고 왔다는 것을 깨달음... → 해결..^_^