[Deploy] Spring & MySql & docker-compose 활용 EC2에 간단하게 배포하기

배포 전 알아야 할 사항

- 이 과정은 EC2에 Docker 및 Docker Compose를 설치하는 작업과 EC2 내부에 Docker를 띄워서 Docker Compose를 활용해 Docker-Hub로 부터 image를 받아와 서버를 배포하는 작업을 담고 있음.
- 새로운 AWS EC2 인스턴스 생성 (아무것도 없는 빈 클라우드 컴퓨터여야함 )
- Docker-Hub에 계정을 만들어서 Spring 프로젝트를 Hub로 올릴 Repository를 만들어 둬야함.
- Docker와 Docker Desktop이 로컬에 깔려 있어야 함.
- spring 프로젝트에 env설정이 되어있어야함. env설정은 필수 !
 

1. EC2) Docker 설치

# 1. 프로그램 설치 전 우분투 시스템 패키지 업데이트
$ sudo apt-get update
 
# 2. 필요한 패키지 설치
$ sudo apt-get install apt-transport-https ca-certificates curl gnupg-agent software-properties-common
 
# 3. Docker의 공식 GPG 키 추가
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
 
# 4. Docker의 공식 apt 저장소 추가
$ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"

# 5. 시스템 패키지 업데이트
$ sudo apt-get update
 
# 6. Docker 설치
$ sudo apt-get install docker-ce docker-ce-cli containerd.io

 
 

2. EC2) Docker Compose 설치

# 1. Docker Compose 설치
$ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

# 2. 다운로드 한 파일에 권한 설정
$ sudo chmod +x /usr/local/bin/docker-compose

Docker Compose는

3. Spring) Dockerfile 작성

내가 배포할 Spring 프로젝트의 루트 디렉터리에 Dockerfile을 만들어서 작성해주면 된다.

# 베이스 이미지: OpenJDK 17의 Slim 버전 사용 (경량화된 Java 환경 제공)
FROM openjdk:17-jdk-slim

# 작업 디렉토리 설정: 컨테이너 내에서 /app을 기본 작업 경로로 지정
WORKDIR /app

# JAR 파일 복사: 호스트의 빌드된 JAR 파일을 컨테이너의 /app 디렉토리로 복사
COPY build/libs/*.jar app.jar

# 포트 설정: 컨테이너 외부에서 접근할 수 있도록 8888 포트를 개방
EXPOSE 8888

# JAR 파일 실행: 컨테이너 시작 시 Java로 app.jar 실행
ENTRYPOINT ["java", "-jar", "app.jar"]

 

4. Spring) 프로젝트 빌드

build를 누르면 자동으로 build test를 해주며, build가 성공적으로 되었다면 다음으로 넘어가면 된다.

 

5. Spring) Docker-Hub에 Spring 프로젝트 Push

인텔리제이 터미널 또는 cmd를 통해 프로젝트 root로 접근 후 명령어 입력

# 이미지 빌드 : 로컬에서 Docker 이미지 빌드 명령어
# 이미지이름과 태그는 원하는걸로 태그는 보통 ( latest, v1.0 ) 이런식으로 이용 끝에 점 꼭 넣기
docker build -t 이미지이름:태그 .

# docker hub에 push하기
# 도커허브사용자명은 허브에 들어가면 내 이름이다.
docker push 도커허브사용자명/이미지이름:태그

# docker hub에서 pull받기
# 도커허브사용자명은 허브에 들어가면 내 이름이다. 태그는 보통 latest임.
docker pull 도커허브사용자명/이미지이름:태그

docker build는 스프링 프로젝트를 build한 결과물을 dockerfile을 통해 docker image로 빌드를 하는 과정이다.
docker push는 docker-hub에 빌드 된 image를 올리는 과정이다.
 

6. EC2) docker compose 작성

docker-compose.yml 파일을 ec2 root 디렉토리에 만들어 줘야함.

# 1. ec2에 접속을 한 뒤 바로 그 자리(root)에 docker-compose.yml 파일 만들기
touch docker-compose.yml
# 2. docker-compose.yml 수정하기 vi를 활용하면 수정 화면으로 전환
vi docker-compose.yml

docker-compose.yml 수정파일에 들어간 뒤 파일에 설정 작성

# docker-compose.yml
version: '3.8'

services:
  app:
    image: 
    container_name: spring-app
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - "8080:8080"
    environment:
      MYSQL_URL: ${MYSQL_URL}
      MYSQL_USERNAME: ${MYSQL_USERNAME}
      MYSQL_PASSWORD: ${MYSQL_PASSWORD}
    depends_on:
      - db
    restart: always

  db:
    image: mysql:8.0
    container_name: mysql-db
    restart: always
    ports:
      - "3306:3306"
    environment:
      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
      MYSQL_DATABASE: ${MYSQL_DATABASE}
    volumes:
      - db_data:/var/lib/mysql

volumes:
  db_data:

기존 Spring에서 보안을 위해 env를 활용해서 properties를 정의해두었는데, docker-compose.yml에서는 이러한 env에 대한 설정을 해줄 수 있다. 이렇게 된다면 root에 .env 파일을 만들어서 환경변수에 해당하는 값들을 기재를 해줘야 한다.
 

7. EC2) docker-compose에 대한 .env 작성

ec2 root에서 .env를 만들고 거기에 작성을 하면 된다.

# 1. ec2에 접속을 한 뒤 바로 그 자리(root)에 .env 생성
touch .env
# 2. .env 수정하기 vi를 활용하면 수정 화면으로 전환
vi .env

MYSQL_URL=jdbc:mysql://db:3306/Databases이름
MYSQL_USERNAME=기존 spring env에 설정한 변수값
MYSQL_PASSWORD=기존 spring env에 설정한 변수값
MYSQL_ROOT_PASSWORD=MYSQL root로 사용할 패스워드
MYSQL_DATABASE=MYSQL자동으로 생성되는 DB이름 지정
# 각각 환경 변수 세팅을 해줘야함.

환경변수에 맞게 각각 변수값 세팅을 해줘야함. 해당 설정은 docker-compose.yml environment에 값을 세팅해주는 작업임.
 

8. EC2) docker-compose 실행 ( 서버에 프로그램을 띄워서 실행하는 명령어 )

# docker compose 실행 명령어 -> up -d 는 백그라운드에 지속적으로 띄우기 위한 설정
sudo docker compose up -d

# docker compose 중단 명령어
sudo docker compose down

# 그밖의 명령어들

# docker 현재 띄워진 컨테이너를 확인 할 수 있는 명령어
sudo docker ps -a

# docker 현재 띄워진 컨테이너의 로그를 볼 수 있는 명령어
sudo docker logs -f 컨테이너명

docker compose up -d 를 통해 백그라운드에 docker compose.yml에 설정한 mysql과 backend app을 이미지로 받아와서 컨테이너로 띄워서 실행을 할 수 있게 된다. 이러면 외부 유저들이 해당 서버에 접속을 할 수 있게 된다.