스프링 Docker, githubaction 사용하여 배포 자동화(CI/CD) 파이프라인 구축

이전에 진행했던 프로젝트때도 그렇고 이번 프로젝트에도 ci-cd 파이프라인을 구축하는데 github action, AWS S3, AWS CODEDEPLOY 를 사용했다.  

 

소프트웨어 아키텍처는 아래와 같이 구성하였다. 

 

하지만 이는 세팅 과정이 너무 길고 복잡하다는 생각이 들었다. 

 

 

더 좋은 방법이 없을까 찾아보다 Docker를 사용하기로 했고 이전과 달리 너무 편해진 파이프라인 구축 과정을 기록하기 위해 글을 쓴다. 

 

 

 

그 전에 cicd에 대해 알아보자

 

 

CICD 란 무엇인가?

CI/CD는 애플리케이션 개발 단계부터 배포 때까지의 모든 단계를 자동화를 통해서 좀 더 효율적이고 빠르게 사용자에게 빈번히 배포할 수 있는 것을 말한다.

 

 

CI (Continuous Integration)

CI (Continuous Integration)는 "지속적인 통합"이라는 의미이다. 애플리케이션의 버그 수정이나 새로운 코드 변경이 주기적으로 빌드 및 테스트되면서 공유되는 레파지토리에 통합(merge)되는 것을 의미한다.

 

주기적으로 빈번하게 공유하지 않으면 왜 안 될까??

 

예를 들어 여러 명이서 프로젝트를 진행하고 있고,  형상관리 도구로 git 을 사용하고 있다 가정하자. 이들이 자주 merge하지 않고 2일 3일 혹은 더 오랜 기간 동안 개발을 진행하다가 며칠 동안 작업한 많은 코드들을 한 번에 merge 한다면 어떻게 될까? 🤔

 

많은 충돌이 일어날 것이고 충돌 해결 과정에 쏟는 시간이 많아질 것이다. 자연스럽게 개발 효율성은 떨어지게 된다. 

 

그렇기에, 가능한 작은 단위로 나누어서 주기적으로 빈번히 개발하고 계속해서 통합하여 나가는 것이 중요하다.

 

자주 merge하자!

다 좋은데 merge할 때마다 build하고 test하는 과정들이 귀찮다. 

하지만, 여기서 자동화를 사용해 준다면 어떻게 될까? github에 코드만 올리고 나머지 작업인 테스트와 빌드는 프로그램이 자동으로 해준다면 많은 수고를 덜 것이다.  

 

 

 

CD (Continuous Delivery)

CD는 Continuous Delivery, 지속적인 제공이라는 의미와 Continuous Deployment, 지속적인 배포라는 의미가 있다.

 

정리하자면, CI가 새로운 소스코드의 빌드, 테스트, 병합까지를 의미하였는데, CD는 개발자의 변경 사항이 레포지토리를 넘어, 고객의 프로덕션(Production) 환경까지 릴리즈 되는 것을 의미한다.

 

 

 

본격적으로 구축 과정에 대해 알아보자

 

 

 

1. Dockerfile 작성 

 

FROM

FROM은 기본 이미지를 지정해준다.

 

이미지 이름이 openjdk이고 태그가 17-alpine인 이미지를 기본으로 사용하겠다는 뜻이다.

 

자신의 버전에 맞게 이미지를 선택하면 된다.

 

 

ARG

그리고 ARG를 통해서 jar 파일의 위치를 지정해줬다.

 

jar 파일을 생성하고 나면 build/libs에 저장되기 때문에 build/libs/*.jar가 생성된 jar 파일의 경로가 된다.

 

참고로 gradle 빌드 시 일반적인 jar 파일과 plain이 붙은 jar 파일이 생성된다면 plain jar 파일이 생성되지 않도록 설정하는 것이 좋다.

 

build.gradle에 다음 코드를 작성해주면 jar 파일이 하나만 생길 것이다.

 

 

 

COPY

jar 파일을 컨테이너 내부로 복사한다.

COPY [생성된 로컬 jar 파일 경로] [컨테이너 내부 jar 파일 경로]

 

 

 

ENTRY POINT

entry point를 통해 컨테이너를 실행하면 자동으로 jar 파일을 실행하도록 한다.

ENTRYPOINT ["java","-Duser.timezone=Asia/Seoul","-Dspring.profiles.active=prod", "-jar","/app.jar"]

 

나같은 경우엔 timezone을 서울로 설정해줬고 profile 을 prod로 잡고 jar 파일을 실행할 수 있도록 했다. 

옵션은 각 상황에 맞게 사용하면 된다. 

 

 

 

 

2. docker-compose.yml 작성

 

DB는 AWS RDS를 사용해 따로 빼두었기 때문에 redis와 Spring만 띄어주었다. 

 

docker-compose는 실행할 때 .env파일을 읽기 때문에 .env파일에 따로 세팅해두었다. 

.env파일은 물론 docker-compose.yml파일과 같은 루트에 놔둬야 한다. (나의 경우엔 ec2 의 /home/ubuntu에 둠)

 

restart: always 는 컨테이너가 어떤 이유로든 중지되면(ex. 오류), 자동으로 다시 시작하여 응용 프로그램의 가용성을 유지할 수 있도록 하는 옵션이다.

 

redis 의 데이터들은 컨테이너를 재시작해도 유지되야 하기 때문에 volume을 잡아 두었다. 

 

logging 부분은 cloud watch에 로그를 기록해두기 위해 사용했는데, ci/cd와는 관련 없다.

version: "3.8"
services:
  redis:
    image: redis:latest
    container_name: redis
    hostname: redis
    ports:
      - "6379:6379"
    volumes:
      - ./redis/data:/data
  spring:
    container_name: spring
    image: ${DOCKERHUB_USERNAME}/jikgong
    depends_on:
      - redis
    environment:
      - DB_ENDPOINT=${DB_ENDPOINT}
      - DB_PASSWORD=${DB_PASSWORD}
      - DB_USERNAME=${DB_USERNAME}
      - SECRET_KEY=${SECRET_KEY}
      - S3_ACCESS_KEY=${S3_ACCESS_KEY}
      - S3_SECRET_ACCESS_KEY=${S3_SECRET_ACCESS_KEY}
      - FCM_PATH=${FCM_PATH}
    logging:
      driver: awslogs
      options:
        awslogs-group: ...
        awslogs-region: ...
        awslogs-stream: ...
    ports:
      - "8080:8080"
    restart: always

 

 

3. .github/workflows/deploy.yml 작성

 

github action에서 수행할 동작들을 deploy.yml 파일에 작성해주었다. 

 

name: Java CI with Gradle

on:
  push:
    branches: [ "release" ]

permissions:
  contents: read

jobs:
  build-docker-image:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set up JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'

      - name: Run chmod to make graldew executable
        run: chmod +x ./gradlew

      - name: Build with Gradle
        uses: gradle/gradle-build-action@67421db6bd0bf253fb4bd25b31ebb98943c375e1
        with:
          arguments: clean bootJar -Pspring.profiles.active=prod

      - name: docker image build
        run: docker build -t ${{ secrets.DOCKERHUB_USERNAME }}/jikgong .

      - name: docker login
        uses: docker/login-action@v1
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: docker Hub push
        run: docker push ${{ secrets.DOCKERHUB_USERNAME }}/jikgong

  cd-pipeline:
    needs: build-docker-image
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: copy file via ssh password
        uses: appleboy/scp-action@master
        with:
          host: ${{ secrets.SSH_HOST }}
          username: ubuntu
          password: ${{ secrets.SSH_PASSWORD }}
          port: 22
          source: "./docker-compose.yml"
          target: "/home/ubuntu/"

      - name: executing remote ssh commands using password
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SSH_HOST }}
          username: ubuntu
          password: ${{ secrets.SSH_PASSWORD }}
          port: 22
          script: |
            sudo docker rm -f $(docker ps -qa)
            sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/jikgong
            sudo docker-compose up -d
            sudo docker image prune -f

 

첫번째 JOB - build-docker-image 

uses: actions/checkout@v3

- 현재 워크스페이스(레포지토리)에 대한 소스 코드를 가져오고 작업 디렉토리를 지정된 브랜치 또는 커밋으로 설정

 

name: docker image build

- 도커 이미지 빌드. 위에서 작성한 Dockerfile을 여기서 읽어들인다. 

 

name: docker login

- 도커 허브에 로그인을 해준다. 이때 username과 token을 사용하여 로그인 하는데 token은 docker hub 사이트에서 발급 가능하다. 

 

name: docker Hub push

- docker hub 에 push 해준다. 따로 태그를 지정해주지 않았기 때문에 latest로 자동 지정된다.

 

 

두번째 JOB - cd-pipeline

needs: build-docker-image

- build-docker-image의 job이 완료될 때 까지 대기한다. 

 

copy file via ssh password

- SSH 를 이용하여 file 을 ec2로 이동

- host: 원격 서버의 호스트 주소(IP 주소 또는 도메인 이름)

- username: SSH 연결을 위해 사용되는 원격 서버의 계정 이름 (ec2를 만들 때 ubuntu 를 사용했다면 ubuntu 이다.)

- password: SSH 연결을 위한 비밀번호. ec2의 비밀번호를 따로 설정해야 함

- port: SSH 서버가 사용하는 포트 번호. 일반적으로 22번 포트가 사용

- source: 로컬에서 복사할 파일 또는 디렉토리의 경로.

- target: 원격 서버에 복사할 경로.

 

executing remote ssh commands using password

- 작성한 스크립트 명령어 실행

- 실행중인 스프링, 레디스 컨테이너를 종료하고 docker compose 실행