[server] 배포 완료 및 배포 방법

[2020147542]

서비스 배포 과정 요약

배포는 무중단 배포 전략을 사용하며, Blue/Green 배포 방식을 채택하고 있습니다. 이 과정에서는 Nginx와 Docker를 활용하여 서비스를 배포하고, certbot을 사용하여 SSL 인증서를 관리합니다.

---

배포 과정 및 방법 등 관련 내용들을 정리해두었습니다. 코드에 수정사항이 있다면 배포방법 다들 확인 부탁드립니다.

배포 이후 db 변경사항이 있다면 mysql컨테이너 접속하기방법을 참고해서 변경해주세요.

[2020147542]

1. 환경 설정

1.1. EC2 및 Docker 환경

• EC2 인스턴스: AWS EC2 인스턴스에서 배포 작업을 수행합니다.
  • 인스턴스 자체 정보
  • public IPv4: 13.125.44.157
    • keypair: mykeypair.pem(노션 server 페이지에 올려둠)
    • region: ap-northeast-2
    • 운영 체제: Ubuntu
• 소프트웨어: Docker, Docker Compose, Nginx, AWS CLI
  • Docker: 애플리케이션과 데이터베이스를 Docker 컨테이너로 실행합니다.
  • Nginx: 리버스 프록시 서버로 사용하여 HTTPS 요청을 애플리케이션 컨테이너로 전달합니다.

1.2. 파일 및 스크립트

• 배포 스크립트: deploy.sh - Blue/Green 배포 전략을 사용하여 무중단 배포를 수행합니다.
• 청소 스크립트: clean.sh - 모든 Docker 컨테이너와 이미지를 제거합니다.
• Docker Compose 파일:
  • docker-compose.blue.yml - Blue 환경의 Docker 설정
  • docker-compose.green.yml - Green 환경의 Docker 설정
  • mysql-compose.yml - MySQL 데이터베이스 컨테이너 설정
• Nginx 설정 파일:
  • nginx.blue.conf - Blue 환경용 Nginx 설정
  • nginx.green.conf - Green 환경용 Nginx 설정

[2020147542]

2. 전반적인 배포 흐름

참고) 배포 전략

본 프로젝트는 무중단 배포를 위해 Blue/Green 배포 전략을 사용합니다. 이 전략은 다음과 같은 방식으로 동작합니다:
Blue 환경: 처음 활성화된 환경
Green 환경: 새로운 버전의 애플리케이션이 배포되는 환경

1. 코드 변경 및 CI/CD:

• 코드 변경: 애플리케이션의 코드가 main 브랜치에 푸시됩니다.
• CI/CD 파이프라인: CI/CD 시스템이 코드를 감지하고 Jib을 사용하여 Docker 이미지를 빌드합니다.
• ECR에 이미지 푸시: 빌드된 Docker 이미지를 AWS ECR (Elastic Container Registry)에 푸시합니다.

2. EC2에서 배포:

• Docker 이미지 풀: ECR에서 최신 Docker 이미지를 EC2 인스턴스로 풀 받습니다.
• 환경 확인: MySQL 및 애플리케이션 컨테이너의 상태를 확인합니다.
• Blue/Green 배포:
  • 현재 환경이 Blue(포트 8081)일 경우 Green (포트8080)환경을 시작하고, 반대의 경우 Blue 환경을 시작합니다.
  • 헬스 체크: 새로운 환경이 정상적으로 작동하는지 확인합니다.
• Nginx 업데이트: Nginx 설정을 업데이트하여 새로운 환경을 반영합니다.
• 구버전 환경 정리: 이전 환경을 종료하고 리소스를 정리합니다.

[2020147542]

3. 배포 방법

코드를 수정한 후 여러분이 해야하는 일!

1. develop > main branch에 push한다.
2. ssh로 서버에 접속한다.

   ssh -i mykeypair.pem ubuntu@13.125.44.157

3. 배포 스크립트를 실행한다.

   cd bookMoa
   ./deploy.sh
   

4. 컨테이너가 잘 실행되고 있는지 확인한다.

   docker ps
   

   • 블루/그린 버전이 있는데 블루(포트 8081)버전이 실행되고 있다면 아래와 같이 뜬다.
     
5. mysql이나 스프링 어플리케이션의 로그를 보고 싶다면

   docker logs 컨테이너 이름(mysql-container| bookmoa-blue | bookmoa-green)
   

6. nginx가 정상적으로 작동되고 있는지 확인한다.

    sudo systemctl status nginx
   

   • 아래 사진 처럼 active 여야만 함. 아니면 도메인으로 접속도 안됨
     
   • 만약 에러를 보고 싶다면 아래 명령어 입력

      sudo tail -f /var/log/nginx/error.log
     

7. 문제가 발생한거 같아서 docker 환경을 초기화 하고 다시 시작하고 싶다하는 경우

    ./clean.sh
   

   • 볼륨까지 삭제를 원한다면 sudo rm -r home/ubuntu/mysql을 터미널에서 추가 실행

[2020147542]

참고) 혹시나 접속이 안되는 상황에서 요청이 제대로 들어가고 있는지 확인해보려면

curl -I http://bookmoa.shop/health
curl -I https://bookmoa.shop/health

각각 해보고 "UP"이 return되는지 결과 살펴보기

[2020147542]

4. 혹시 모를 https 인증서 에러

현재 certbot에서 무료로 주는 https 인증서를 사용하고 있는데 3개월마다 갱신해줘야함

• 도메인: bookmoa.shop
• 만료일: 2024년 11월 7일
• 경로:
  • 인증서 경로: /etc/letsencrypt/live/bookmoa.shop/fullchain.pem
  • 개인 키 경로: /etc/letsencrypt/live/bookmoa.shop/privkey.pem

---

인증서 상태 확인

sudo certbot certificates

• 여기서 Expiry Date 항목을 확인하여 인증서 만료일 확인

인증서 갱신 방법

1. 인증서 갱신 시뮬레이션

sudo certbot renew --dry-run

• 무튼Dry run: Success과 비슷한 응답이 나오면 2번 진행
• 아니면 아래 명령어로 로그 확인

  sudo less /var/log/letsencrypt/letsencrypt.log
  

2 . 실제 갱신

sudo certbot renew

3. nginx 서버 리로드

sudo systemctl reload nginx

4. 정상작동 확인

• nginx 정상작동 확인

   sudo systemctl status nginx
  

• 도메인으로 접속해보기

   curl -I http://bookmoa.shop/health
   curl -I https://bookmoa.shop/health
   또는 직접 접속
  

[2020147542]

5. 실행되고 있는 mysql container에 접속하기

Docker에서 실행 중인 MySQL 컨테이너에 접속하는 방법은 다음과 같습니다:

1. MySQL db이름과 비밀번호 확인:

   cd bookMoa
   cat .env

   DB_URL과 MYSQL_PASSWORD에 입력된 값을 기억합니다

2. MySQL 컨테이너 내부로 접속:

   docker exec -it mysql-container/bin/bash

3. MySQL 클라이언트 실행:
   컨테이너 내부에서 MySQL 클라이언트를 실행합니다.

   mysql -u root -p

   1번에서 확인한 비밀번호를 입력합니다.

4. bookmoa db로 접속하기:
   show databases로 1번에서 확인한 db이름이 있는지 확인한다.

   show databases;
   use <1번에서 확인한 db이름>;

   해당 db로 들어간 이후 원하는 sql문을 작성하면 된다