Docker와 Github Action을 사용해서 배포하기

Docker

도커를 사용하면 애플리케이션을 컨테이너화하여 개발환경과 프로덕션 환경 간의 일관성을 보장할 수 있다. 이는 배포 과정에서 발생할 수 있는 "내 컴퓨터에서는 동작하는데?" 라는 문제를 줄여줄 수 있다.

Github Action

소스 코드 저장소에 직접 연동하여 CI/CD 파이프라인을 구축할 수 있다. 코드의 변경사항이 자동으로 테스트되고 배포되기 때문에, 개발 프로세스가 보다 효율적이고 신속하게 진행될 수 있다.

자동 배포 방법

Github Action workflow 등록

Github Action이 동작하기 위해서는 Github Repository에서 workflow를 등록해주어야 한다. 작성한 workflow는 다음과 같다.

name: CI/CD using github actions & docker

on:
    pull_request:
        branches: ["develop"]
        types: ["closed"]
jobs:
    deploy:
        runs-on: ubuntu-latest
        if: ${{ github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, '🖥️ Server') }}

        steps:
            - name: Checkout repository
              uses: actions/checkout@v2

            - name: Set up Node.js
              uses: actions/setup-node@v2
              with:
                  node-version: "18"

            - name: Install dependencies
              run: |
                  cd server
                  npm install

            - name: Build Docker image
              run: docker build -t geomgichoi/heatpick:latest ./server

            - name: Login to Docker Hub
              run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}

            - name: Push Docker image to Docker Hub
              run: docker push geomgichoi/heatpick:latest

            - name: SSH into Ubuntu server and pull the latest image
              uses: appleboy/ssh-action@master
              with:
                  host: ${{ secrets.SERVER_IP }}
                  username: ${{ secrets.SERVER_USERNAME }}
                  password: ${{ secrets.PASSWORD }}
                  script: |
                      docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
                      docker pull geomgichoi/heatpick
                      docker stop heatpick-container || true
                      docker rm heatpick-container || true
                      docker run -e SSH_HOST=${{ secrets.SSH_HOST }} -e SSH_PORT=${{ secrets.SSH_PORT }} -e SSH_USER=${{ secrets.SSH_USER }} -e SSH_PASSWORD=${{ secrets.SSH_PASSWORD }} -e DB_USERNAME=${{ secrets.DB_USERNAME }} -e DB_PASSWORD=${{ secrets.DB_PASSWORD }} -e DB_NAME=${{ secrets.DB_NAME }} -e DB_HOST=${{ secrets.DB_HOST }} -e SECRET_KEY=${{ secrets.SECRET_KEY }} -e SLACK_WEBHOOK_URL=${{ secrets.SLACK_WEBHOOK_URL}} -e NCLOUD_ACCESS_KEY=${{secrets.NCLOUD_ACCESS_KEY}} -e NCLOUD_SECRET_KEY=${{secrets.NCLOUD_SECRET_KEY}} -e INVOKE_URL=${{ secrets.INVOKE_URL }} -e GREEN_EYE_SECRET_KEY=${{ secrets.GREEN_EYE_SECRET_KEY }} -v /images:/usr/src/app/images -d -p 3000:3000 --name heatpick-container geomgichoi/heatpick

여기에서 보안을 위해 환경 변수를 사용하였는데, 이는 Github에서 미리 등록된 환경변수를 활용하는 것이다. 환경 변수 등록은 github repository에서 setting -> Secretes and variables -> Actions에서 진행할 수 있다.

workflow 과정에서 도커 이미지를 생성하고 허브로 push를 진행하게 되는데, 도커 이미지 생성을 위하여 레포지토리 내부에 Dockerfile을 작성한다.

# Use an official Node runtime as a parent image
FROM node:18

# Set the working directory in the container
WORKDIR /usr/src/app

# Copy package.json and package-lock.json to the working directory
COPY package*.json ./

# Install app dependencies
RUN npm install

# Bundle app source
COPY . .

# Expose the port the app runs on
EXPOSE 3000

# Start the app
CMD ["npm", "start"]

정상적으로 액션이 수행되는 것을 확인할 수 있다.