GitHub Actions을 이용한 Docker 이미지 빌드 및 AWS EC2 배포 자동화

사전준비

AWS

• AWS EC2 인스턴스 생성
• AWS EC2 SSH 보안 연결 허용
• AWS EC2의 키페어 생성
• AWS EC2에 도커 설치

    sudo apt update 
    sudo apt install apt-transport-https ca-certificates curl software-properties-common 
    curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" 
    sudo apt update 
    sudo apt install docker-ce 
    sudo systemctl status docker

• SSH로 접속하려는 유저 도커 명령어 권한 추가

     sudo usermod -aG docker ${USER}

Docker Hub

• 도커 이미지를 올릴 계정 생성

Github Actions

repository > settings > security > secrets and variables > repository secrets 에 다음을 등록해준다.

• SSH_PRIVATE_KEY

    pbcopy < ~/keys/olleu-back-develop-key.pem

• EC2에서 생성한 key pair를 다음 명령어로 복사해서 붙여넣어준다.

Github Actions 파이프라인

develop 브랜치에 머지되었을 때 동작하는 yaml 파일이다.

1. Spring 앱을 빌드하고
2. 도커 이미지를 생성하고 도커 허브에 푸시한 다음
3. EC2에 SSH로 연결한다. 도커 허브로부터 이미지를 pull한 다음 실행시킨다.

name: Build and Deploy to AWS EC2

on:
  push:
    branches:
      - develop

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v3

    - name: Set up JDK 11
      uses: actions/setup-java@v3.3.0
      with:
        java-version: 17
        distribution: 'temurin'

    - name: Build with Gradle
      run: |
          mkdir -p ./build/generated-snippets
          ./gradlew build

    - name: Login to DockerHub
      uses: docker/login-action@v1
      with:
        username: ${{ secrets.DOCKER_HUB_USERNAME }}
        password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}

    - name: Build and push Docker image
      uses: docker/build-push-action@v2
      with:
        context: .
        push: true
        tags: ${{ secrets.DOCKER_HUB_USERNAME }}/my-app:latest

    - name: Setup SSH
      uses: webfactory/ssh-agent@v0.5.3
      with:
        ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}

    - name: Deploy to AWS EC2
      run: |
        ssh -o StrictHostKeyChecking=no ${{ secrets.SSH_USERNAME }}@${{ secrets.SSH_HOST }} <<EOF
          docker pull ${{ secrets.DOCKER_HUB_USERNAME }}/my-app:latest
          docker stop my-app || true
          docker rm my-app || true
          docker run -d --name my-app -p 80:8080 ${{ secrets.DOCKER_HUB_USERNAME }}/my-app:latest
        EOF