[Docker] AWS EC2 + Docker + RDS 구축

들어가기전에

CI / CD와 맞짱뜨는 나 (겨우이김)

이번에 시작한 프로젝트에서는 Docker를 적용해서 CI / CD를 구현하기로 하였다. 기존에는 Github Action + CodeDeploy + EC2 + RDS 조합이였지만 서버상의 문제가 꽤많기도 하고 환경변수적용이나 AWS사용 방법등 다양한 것들이 발목을 잡아서 내친김에 공부해서 Docker를 적용해 보았다. 정말 삽질의 연속이였지만 해냈을때의 뿌듯함이란...ㅎㅎ

 

자그럼 하나씩 알아보도록 하자.

https://lucas-owner.tistory.com/48

https://velog.io/@9to0/CICD-Github-Action-%EC%82%AC%EC%9A%A9%ED%95%A0-%EB%95%8C-Docker-%ED%99%98%EA%B2%BD%EB%B3%80%EC%88%98-%EC%84%A4%EC%A0%95

 

 

 

 

 

배포 전략

 

이번에 구성될 배포 전략은 그림과 같다. 순서를 나열해보면

1. Github의 back(branch) 에 Push나 PR 요청이 발생시
2. Github Action이 동작하고 빌드를 통해 Jar 파일을 생성한다.
3. 또한 build를 진행함과 동시에 Docker Hub에 로그인하고 Hub Repository에 올린다.
4. Docker Hub에 Push 하는 과정에서 DockerFile을 참고해 환경변수 등 설정값들을 넣어준다.
5. Push된 Image를 EC2에서 pull 한다. 
6. EC2 에서 해당 이미지를 컨테이너로 실행(run) 시킨다.
7. 실행되는 JAR 파일은 Docker 위에서 동작하며 설정값대로 지정된 RDS를 DB로 사용할것이다.

이과정을 CI / CD 를 통해서 자동화 시킬것이다. 

 

 

적용 과정

EC2 설정

일단 EC2 서버 설정은 생략하자.

 

RDS 설정

RDS 세팅까지는 미리 되있어야 한다. 

 

 

Github Action 세팅

깃헙액션을 동작시키기 위해서 다양한 설정방법이 있지만 내가 했던 방법을 정리해서 적어보겠다.

 

1. .github / workflows / cicd.yml 설정

##
name: Java CI with Gradle

on: # (1) on설정을 통해 언제 github Action을 실행시킬지 정한다. 해당브랜치에 yml 파일이 있어야한다.
  pull_request: 
    branches: [ back ] # PR이 적용될 브랜치 
  push:
    branches: [ back ] # Push가 적용될 브랜치

jobs:
  build:

    runs-on: ubuntu-latest

    env:
      working-directory: ./server    #cicd가 적용될 환경을 env로 적용

    steps:
      - uses: actions/checkout@v2    
      - name: Set up JDK 11
        uses: actions/setup-java@v2
        with:
          java-version: '11'
          distribution: 'zulu'
      - name: Grant execute permission for gradlew
        run: chmod +x gradlew
        working-directory: ${{env.working-directory}}

      - name: Build with Gradle
        run: ./gradlew clean build --warning-mode all --scan -x test # clean build 적용
        working-directory: ${{env.working-directory}}

      - name: Login to Docker Hub
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKER_HUB_USERNAME }} #docker Username 지정
          password: ${{ secrets.DOCKER_HUB_PASSWORD }} #docker Password / Key 지정
          

      - name: Build and push register app # docker의 repository는 소문자로 해야한다.
        run: |
          docker build -t newstudyground -f ./server/Dockerfile . #도커파일 위치 지정
          docker tag newstudyground ${{ secrets.DOCKER_HUB_USERNAME }}/newstudyground:${GITHUB_SHA::7} #도커 태그설정
          docker push ${{ secrets.DOCKER_HUB_USERNAME }}/newstudyground:${GITHUB_SHA::7} #만들어진 이미지를 업로드
        env: 
          GITHUB_SHA: ${{ github.sha }} #github에서 자동으로 만들어지는값. 따로 환경변수 지정안해줘도 된다.

      - name: Configure AWS credentials #여기부터 AWS 로그인 (잘설정해주자)
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ap-northeast-2

      - name: Start Session Manager session
        run: aws ssm start-session --target ${{ secrets.AWS_INSTANCE_ID }}

      - name: Deploy to Server # EC2 서버에 배포
        env:
         AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
         AWS_REGION: ap-northeast-2
        run: |
         aws ssm send-command \
           --instance-ids ${{ secrets.AWS_INSTANCE_ID }} \
           --document-name "AWS-RunShellScript" \
           --parameters "commands=[
             'if sudo docker ps -a --format \\'{{.Names}}\\' | grep -q \'^server$\\'; then',
             '  sudo docker stop server', # 기존 서버를 스탑시키고
             '  sudo docker rm server', # 지워준뒤에
             'fi',
             'sudo docker pull hae02y/newstudyground:${GITHUB_SHA::7}',                        #dockerhub에서 이미지를 땡겨온다.
             'sudo docker tag hae02y/newstudyground:${GITHUB_SHA::7} newstudyground',          #태그까지 지정해준뒤에
             'sudo docker run -e TZ=Asia/Seoul -d --name server -p 8080:8080 newstudyground'   #실행시킨다.
           ]" \
           --output text

 

그대로 복붙해서 사용하면 에러가 날것이다. 주석된부분을 제거후에 사용하는것이 좋을것같다. 설명대로 따라서 지정해주면 된다. 다음으로 Dokerfile을 세팅해보자.

 

2. /server/Dockerfile 설정

FROM openjdk:11-jdk

# ⭐ 'ARG' 예약어를 통해 인자로 전달 받아야 한다.
ARG ADMIN_EMAIL \
    AWS_ACCESS_KEY \
    AWS_SECRET_KEY \
    EMAIL_PASSWORD \
    JWT_SECRET_KEY \
    KAKAO_CLIENT_ID \
    KAKAO_CLIENT_SECRET \
    RDS_USERNAME \
    RDS_PASSWORD


# ⭐ 'ENV' 예약어를 통해 전달받은 값을 실제 값과 매칭시켜야 한다.
ENV ADMIN_EMAIL=${ADMIN_EMAIL} \
    AWS_ACCESS_KEY=${AWS_ACCESS_KEY} \
    AWS_SECRET_KEY=${AWS_SECRET_KEY} \
    EMAIL_PASSWORD=${EMAIL_PASSWORD} \
    JWT_SECRET_KEY=${JWT_SECRET_KEY} \
    KAKAO_CLIENT_ID=${KAKAO_CLIENT_ID} \
    KAKAO_CLIENT_SECRET=${KAKAO_CLIENT_SECRET} \
    RDS_USERNAME=${RDS_USERNAME} \
    RDS_PASSWORD=${RDS_PASSWORD}

# (2) COPY에서 사용될 경로 변수
ARG JAR_FILE=/server/build/libs/*.jar

# (3) jar 빌드 파일을 도커 컨테이너로 복사
COPY ${JAR_FILE} app.jar

# (4) jar 파일 실행
ENTRYPOINT ["java", "-Dspring.profiles.active=docker", "-jar", "app.jar"]

(2)에서 보면 copy할때의 경로가 나와야하는데 이부분에서 한참 애먹었다. target Folder를 잘 보고 설정해주자.