🐳 SpringBoot + Docker + DockerCompose를 이용한 AWS EC2 배포하기

0. 환경

• 스프링부트 버전 : 2.7.17
• 툴 : IntelliJ IDEA CE
• JDK : 17
• 사용하고 있는 컴퓨터 정보 : Macbook Pro(Apple M2 Pro)

---

1. 사전 준비

🧩 SpringBoot

☃️ SpringBoot jar 파일 생성하기

• Docker에 스프링부트로 작성한 프로젝트를 올리려면 먼저 jar file을 생성해주어야 합니다.

🧐 jar file이 뭐죠?

• Java ARchive Files를 의미하며, 일종의 자바 프로젝트 압축 파일을 뜻하기 때문에, zip과 유사하다고 이해하시면 좋습니다.
• .jar의 확장자를 가진 파일은 프로젝트에서 가장 중요한 컴파일된 .class 파일을 가지고 있게 됩니다.
• 우리가 스프링부트로 개발을 하게 되면, build.gradle 등의 파일에 여러가지 의존성을 설정하게 됩니다.
• 이때 jar 파일 내부에 이 의존성을 모두 포함시키기 때문에 쉽게 배포에 사용할 수 있는 것입니다.
  • 출처 : [java] jar 파일이란?

• 그럼, 스프링부트 프로젝트를 작성한 IntelliJ에서 jar 파일을 만드는 방법을 소개해보도록 할게요!

1. IntelliJ의 오른쪽 끝 > gradle > bulid 폴더 접근

2. BootJar 더블 클릭으로 jar 파일 생성

• ⚙️BootJar 더블 클릭
  
  
  

3. Project > {프로젝트 최상위 폴더} > bulid > libs 폴더 내부에 jar 파일에 생성되었는지 확인

😅 만약 jar 파일이 ....jar와 함께 ...plain.jar가 저장되었을 경우에는 빌드 시에 에러가 발생할 수 있어요!

• 해결 방법 : 우선 생성한 jar 파일 2개를 삭제하고, build.gradle에 다음을 포함해준다음 다시 jar 파일을 만들어주기
• 출처 : Plain jar vs Executable jar(feat. plain jar 생성 방지)

...
jar {
	enabled = false
}
...

• 위의 방법을 따라하시면 편하게 {패키지명}-0.0.1-SNAPSHOT.jar 형태의 jar 파일을 생성할 수 있습니다.

---

🐳 Docker

☃️ Mac에 Docker 설치하기

• 이제 Docker를 사용할 차례입니다. 먼저 설치해야겠죠?
• 출처 : [Docker] 맥 OS에 도커 설치하기(Install Docker on MacOS)

1. Docker 홈페이지에서 dmg 다운로드

• 제 경우 M2 칩이기 때문에 Docker Desktop Mac With Apple sillicon 클릭해 다운로드 했습니다.
  (Windows 유저의 경우 왼쪽 아래의 "Install on Windows"에서 진행)
  
  
  

2. 다운받은 dmg 열어서 Applications에 추가하기

3. Terminal에서 Docker 버전 확인

• 명령어 : docker -v
• 버전 정보가 나오면 성공입니다!
  

---

2. Dockerfile Build & Run

🗂️ Dockerfile

• Dockerfile을 통해서 jar 파일을 올리고 실행할 예정

1. IntelliJ > {프로젝트 최상위 폴더}에 Dockerfile 만들기
   
   
   

2. 다음 내용 작성하고 저장하기
   
   
   

다음 내용은 개인 설정이므로 4번으로 넘어가주세요!
(3. 환경변수 편집하기)

• jar 파일이 환경변수를 읽어들이지 못하는 문제
  error: unable to access jarfile /build/libs/parking-0.0.1-snapshot.jar
  -> 해결 방법 : 모든 환경변수를 하드코딩함.
  Docker용 ParkingServer 환경변수 편집(비공개)

3. ⚙️ BootJar 한번 더 더블클릭해서 빌드해주기
   
   

4. IntellJ의 터미널에서 다음 실행

• 도커를 빌드(이미지 생성)
  docker build -t hayannn/parking_server:1 ./

• 도커 컨테이너 실행
  docker run -it -p8080:8080 hayannn/parking_server:1
  
  

5. Docker Desktop에서 확인

• 이미지 확인
  

• 컨테이너 확인
  

6. 빌드 성공!
   

7. 크롬에서 확인(필요한 경우)
   
   -> 잘 리다이렉팅됨 확인!
   

7. 종료하고 싶다면?

• 명령어 실행해도 되지만, 기왕 Docker Desktop이 있는 김에 여기서 정지!
  

8. 종료 확인
   

---

3. Docker-compose 사용하기

docker-compose.yml

version: '3'

services:
  web:
    container_name: web
    image: {docker username}/{docker 이미지 이름}
    expose:
      - "8080"
    ports:
      - "3000:8080"

현재 저희는 3000번 포트를 통해 외부에서 서버 API에 접근하기 때문에 expose 설정을 해주었습니다.

---

4. Github Actions로 CI/CD 배포 자동화 진행

참고 레퍼런스 : 코드 Push로 배포까지! Spring Boot + Github Actions + Docker
그 다음 Github Actions를 사용하기 위해 새로운 패키지를 만들어주어야 합니다.

1. 인텔리제이에서 루트 폴더에 .github 폴더를 만들고, 그 안에 workflows 폴더를 만들어 줍니다.
   

2. 그 다음 ~~~.yml 파일을 만들어준 다음, 다음 내용을 작성합니다.
   아직 commit 하지 마세요!
   예시) deploy.yml

name: CD with Gradle

on:
  push:
    branches: [ "사용하고자 하는 브랜치 이름" ]


permissions:
  contents: read


jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v3


      - name: Set up JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: "adopt"


      - name: Make application.yml
        run: |
          cd ./src/main/resources
          touch ./application.yml
          echo "${{ secrets.PROPERTIES }}" > ./application.yml
        shell: bash

      - name: Build with Gradle
        run: |
          chmod +x ./gradlew
          ./gradlew clean build -x test

      - name: Docker build & push to docker repo
        run: |
          docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
          docker build -f Dockerfile -t ${{ secrets.DOCKER_REPO }} .
          docker push ${{ secrets.DOCKER_REPO }}

      - name: Deploy to server
        uses: appleboy/ssh-action@master
        id: deploy
        with:
          host: ${{ secrets.HOST }}
          username: ec2-user
          key: ${{ secrets.KEY }}
          envs: GITHUB_SHA
          script: |
            sudo docker rm -f $(docker ps -qa)
            sudo docker pull ${{ secrets.DOCKER_REPO }}
            docker-compose up -d
            docker image prune -f

3. 환경변수로 지정한 값들을 다이렉팅해주기 위해 깃허브 레포지터리 > settings > Security > Actions에서 각 값을 넣어줍니다.
   

   DOCKER_PASSWORD : 도커 로그인 시 비밀번호
   DOCKER_REPO : 도커의 레포지터리 이름
   DOCKER_USERNAME : 도커 로그인 시 이름 또는 이메일
   HOST : AWS EC2 IP
   KEY : AWS EC2 생성 시 사용한 pem 키
   (pem 키를 메모장 등으로 열어 내용을 모두 복사-붙여넣기 해주어야 함)

4. 이제 앞서 작성한 ~~~.yml를 commit&push 해줍니다.

on:
  push:
    branches: [ "사용하고자 하는 브랜치 이름" ]

다음과 같이 설정해주었기 때문에, push 시에 Github Actions에서 감지하고 배포를 진행하게 됩니다!

5. 배포 확인
   깃허브 레포지터리 > Actions > All workflows에서 원하는 커밋 기록을 클릭해 확인합니다.
   

사진에서 어렴풋이 보이듯, 이 부분에서 에러가 발생해 시간을 많이 썼는데요!

자세한 내용은 아래의 2가지 트러블슈팅으로 소개하도록 하겠습니다.

🚀 첫번째 트러블 슈팅

• ERROR: invalid tag "***/이미지이름:태그": invalid reference format

-> Docker에 로그인은 성공적으로 되었지만, 실제 image:태그를 확인하지 못하는 것으로 보고 해결점을 찾아보았습니다.

이전의 deploy.yml 파일 일부

 - name: Docker build & push to docker repo
        run: |
          docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
          docker build -f Dockerfile -t ${{ secrets.DOCKER_USERNAME }}/이미지이름:태그 .
          docker push ${{ secrets.DOCKER_USERNAME }}/이미지이름:태그
      ...
          script: |
            sudo docker rm -f $(docker ps -qa)
            sudo docker pull ${{ secrets.DOCKER_USERNAME }}/이미지이름:태그
            docker-compose up -d
            docker image prune -f

😀해결

/이미지이름:태그부분을 보면, 현재 저희가 불러오고자 하는 docker image와의 매칭이 안되는 문제가 발생한 것으로 판단했습니다.
또한, 그 앞의 ${{ secrets.DOCKER_USERNAME }}을 ${{ secrets.DOCKER_REPO }}로 수정해주었습니다.

변경 후 deploy.yml

      - name: Docker build & push to docker repo
        run: |
          docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
          docker build -f Dockerfile -t ${{ secrets.DOCKER_REPO }} .
          docker push ${{ secrets.DOCKER_REPO }}

      - name: Deploy to server
        uses: appleboy/ssh-action@master
        id: deploy
        with:
          host: ${{ secrets.HOST }}
          username: ec2-user
          key: ${{ secrets.KEY }}
          envs: GITHUB_SHA
          script: |
            sudo docker rm -f $(docker ps -qa)
            sudo docker pull ${{ secrets.DOCKER_REPO }}
            docker-compose up -d
            docker image prune -f

🚀 두번째 트러블 슈팅

• ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey], no supported methods remain

이제 성공적으로 Docker를 불러오지만, 이번에는 서버 정보를 불러오는데에 문제가 발생했습니다😂
이 부분을 해결은 아주 간단했는데요!
저희는 현재 업무를 위해 부여받은 EC2 서버에서 작업을 해야 하는데, 이 EC2 서버가 Ubuntu가 아닌 Amazon Linux 2였습니다.
그렇기 때문에 다시 한번 deploy.yml 파일에서 수정이 필요했습니다..!!
변경 이전 deploy.yml 중 서버에 연결하는 "Deploy to server" 부분

      - name: Deploy to server
        uses: appleboy/ssh-action@master
        id: deploy
        with:
          host: ${{ secrets.HOST }}
          username: ubuntu
          key: ${{ secrets.KEY }}
          envs: GITHUB_SHA
          script: |
            sudo docker rm -f $(docker ps -qa)
            sudo docker pull ${{ secrets.DOCKER_REPO }}
            docker-compose up -d
            docker image prune -f

변경 이전의 yml을 보면, 다음과 같이 username이 ubuntu로 되어있는 것을 확인하실 수 있습니다.
이것이 문제가 되는 이유는 ubuntu를 기반으로 한 서버와 달리 amazon linux 2는 기본 유저 이름이 ec2-user이기 때문입니다.
따라서, yml을 통해 AWS EC2 서버가 사용자를 인식하기 위해 이 부분을 ec2-user로 바꿔주어야 합니다!
서버에 따른 유저의 디폴트 이름 찾기
변경 후

      - name: Deploy to server
        uses: appleboy/ssh-action@master
        id: deploy
        with:
          host: ${{ secrets.HOST }}
          username: ec2-user
          key: ${{ secrets.KEY }}
          envs: GITHUB_SHA
          script: |
            sudo docker rm -f $(docker ps -qa)
            sudo docker pull ${{ secrets.DOCKER_REPO }}
            docker-compose up -d
            docker image prune -f

자, 그럼 이제 다시 잘 되는지 확인해볼까요?

잘 진행되었습니다!

🐳 결과

실제로 부여받은 ip를 통해 접속해봤습니다.
성공적으로 잘 들어가지네요!

• Github Actions를 통한 배포가 되었는지 확인
  

• ip를 통한 API 접속
  현재 프로젝트는 카카오 소셔로그인을 사용하기 때문에, 카카오 소셜로그인이 잘 진행되는지 테스트해보았습니다.
  크롬 창에서 {ip주소}/kakao/login 입력

• 포트 3000번을 열어주지 않아 문제가 생겼고, AWS EC2에서 포트 접근을 허용해준 다음 다시 시도하니 잘 열렸습니다.

  • 적용 이전
    

  • 3000 포트 적용 후
    

• 로그인을 위한 화면 출력 완료!
  
  
  

• 실제 데이터가 보이는 API 접근 시, 에러없이 데이터가 보여지는 것을 확인!
  (내용 모두를 보여드릴 수 없는 점 양해 부탁드려요!)
  

참고한 레퍼런스
🔗 코드 Push로 배포까지! Spring Boot + Github Actions + Docker
🔗 [프론트 서버 배포] 사이트 연결 거부
🔗 리눅스 포트 상태 확인 및 열기