README.md

be08-4th-200ok-2vent

⚡한화시스템 BEYOND SW캠프 4차 devops 프로젝트⚡

✋ 팀원 소개

TEAM 200ok

박성준(팀장)	김도하	서현지	전현규	조혜인

🛠️ Tech Stack 🛠️

⚙️ Tool ⚙️

💡 프로젝트 소개

2VENT(지역 행사 커뮤니티)

• 사용자에게 주변과 타 지역의 행사 정보를 쉽고 빠르게 제공하는 서비스

• 사용자가 원하는 행사만을 쏙쏙 골라낼 수 있도록 도와줍니다!

• 지도를 이용해 우리나라 행사들의 위치정보를 알고 싶다면~? 행업튀로 고고!

• 지역별! 온라인과 오프라인! 유료와 무료! 등 다양한 조건을 필터링한 결과가 알고 싶다면? 행업튀로 고고!

• 지역별 게시판을 통한 자유로운 소통의 장을 경험하고 싶다면? 행업튀로 고고!

• 다양한 필터 기능을 통해 관심있는 행사만 빠르게 알아봅시다!

• 간편하고 재미있는 행사 탐색, 이제 2VENT와 함께하세요!

🔆 프로젝트 목적 및 기대효과

최근 이벤트데이터센터 분석 결과, 코로나 19 이후 연간 이벤트 및 행사가 2022년도 대비 39%가량 증가하였습니다. 이것으로 코로나 이전 수준으로 회복되고 있는 것을 한 눈에 확인해볼 수 있습니다. 이처럼 많은 사람들이 행사에 참여하고 있는 것을 보고 쉽고 빠르게 사용자들의 관심사에 맞는 행사를 찾아주기 위해 프로젝트를 개발하게 되었습니다.

✔ 사용자들에게 주변과 타 지역의 행사 정보를 쉽고 빠르게 제공합니다.

✔ 다양한 필터 기능을 통해 개인의 관심사에 맞는 행사를 손쉽게 찾을 수 있도록 합니다.

✔ 지역별 게시판을 통해 사용자들이 특정 지역 행사에 대해 자유롭게 의견을 나누고,
게시글과 댓글을 통해 활발하게 소통할 수 있는 커뮤니티를 구축합니다.

✔ 사용자들은 행사 참여와 정보 교환의 편리함을 경험하고, 지역 사회의 활성화에 기여할 수 있습니다.

📋 시스템 아키텍처

📚 배포 시나리오

1. 소스 코드 변경 및 Git Push

- 소스 코드 업데이트 및 변경 사항 git에 push

2. GItHub Webhook 트리거

- github는 최신 버전의 프로젝트가 push 되면 Jenkins와 연동된 Webhook을 통해 변경된 프로젝트에 대한 HTTP 요청 전송

3. Jenkins 파이프라인 실행

1. Git 프로젝트 clone
    - Jenkins 서버는 HTTP 요청이 감지되면, github에 있는 프로젝트를 클론한다. ( git clone )
2. 빌드 실행
    - 프론트엔드 프로젝트는 `npm run build` 명령어를 사용하여 빌드한다.
    - 백엔드 프로젝트는 `./gradlew build`  명령어를 사용하여 빌드한다.
3. Docker image 생성
    - 생성된 빌드 파일로 Docker image를 생성한다.
4. Docker Hub에 Docker image push
    - 생성된 Docker image를 Docker Hub에 push 한다.
5. Kubernetes 배포 적용
    - 배포 컨테이너의 이미지를 생성된 Docker image로 업데이트한다.

4. 무중단 배포 완료

- 롤링 업데이트가 적용되어 유저는 중단없이 서비스에 접근 가능

🔧 배포 파일

FRONTEND CODE

🔗 PIPELINE
🔗 k8s

BACKEND CODE

🔗 PIPELINE
🔗 k8s

COMPOSE.YAML

networks:
  pocket:
    external: true

services:
  mysql:
    image: 'mysql:latest'
    container_name: '2vent'
    environment:
      - 'MYSQL_DATABASE=2vent'
      - 'MYSQL_PASSWORD=1234'
      - 'MYSQL_ROOT_HOST='
      - 'MYSQL_ROOT_PASSWORD=1234'
      - 'MYSQL_USER=username'
    ports:
      - '3306:3306'
    restart: 'on-failure'

  redis:
    image: 'redis:latest'
    container_name: '2vent_redis'
    ports:
      - '6379:6379'

✨ 배포 테스트

Jenkins Pipeline

1️⃣ git에 push할 시 webhook 발생

2️⃣ CI/CD

3️⃣ backend/frontend 중 변경된 사항이 없는 경우, build skip하고 변경된 것만 build

4️⃣ 배포가 완료되면 이미지 변경 확인

• Backend

• Frontend

5️⃣ 작업 완료 후 discord webhook 발생

무중단 배포(Rolling Update)

1️⃣ Backend

• Dashboard

  
  
  

• 실행 화면(Swagger 타이틀 변경)

  

2️⃣ Frontend

• Dashboard

  
  
  

• 실행 화면(메인 텍스트 변경)

  

실행 화면

• 메인 페이지

  

• 리스트 페이지 조회

  

• 게시글 작성 기능 테스트

  

• 회원 즐겨찾기 기능 테스트

  

🍙 한줄 회고록

팀 원	회고
박성준	Docker, Kubernetes, Jenkins를 활용한 CI/CD 구축을 경험해볼 수 있는 프로젝트였습니다. 다만 제약사항으로 인해 로컬에서 테스트한 것이 아쉽습니다. 팀원들 고생하셨습니다~
김도하	생각보다 시간이 많이 걸리고 배포에 대해 많은 부족함을 느껴 더욱 더 학습에 대한 필요성을 느낄 수 있었습니다. 최종 프로젝트에서는 배포 부분의 완성도를 높여 마무리 하고 싶습니다.
서현지	고생하셨습니다. 파이널 하러 갑쉬다~
전현규	devops에 대해 배울 수 있는 좋은 기회였던 것 같습니다. 2주라는 기간 동안 다들 고생하셨습니다!
조혜인	2주도 안되는 짧은 기간동안 배포를 제대로 이해하기에는 부족했던 시간이었던것 같아 최종때 종합적으로 더 열심히 해보겠습니다 너무 고생하셨습니다