[TECH] GitHub Actions로 CI/CD 구축하기(1)

[티끌] 티끌 GitHub Actions로 CICD 구축하기(1)

안녕하세요 티플의 백엔드 개발자 김유정입니다 :)

저는 오늘 티끌이 어떻게 반복되는 수정과 배포에 수반되는 작업들을 자동화해보았는지 설명해 보려 합니다. 

---

👩‍💻 CI/CD란?

애플리케이션 개발 단계부터 배포 때가지의 모든 단계를 자동화하여 더 효율적이로 빠르게 사용자에게 배포할 수 있는 것을 말합니다.

CI(Continuous Integration)는 지속적 통합, 요약 하자면 빌드/테스트 자동화 과정입니다. 애플리케이션의 새로운 코드나 버그 수정으로 코드 변경이 주기적으로 빌드 및 테스트되면서 공유되는 레포지토리에 통합(merge)되어 서로 충돌할 수 있는 문제를 해결할 수 있습니다.

CD(Continuous Delivery/Deployment)는 배포 자동화 과정을 말합니다. CI에서 Build 및 Test 된 후에, 배포를 수동적으로 진행하는 것입니다. 지속적 배포를 사용하면 품질 저하 없이 최대한 빨리 사용자에게 새로운 기능을 제공할 수 있습니다.

---

👩‍💻 GitHub Actions란?

Github Action이란 Github 저장소를 기반으로 소프트웨어 개발 Workflow를 자동화 할 수 있는 도구입니다.

Github 내부에서 프로젝트를 빌드, 테스트, 릴리즈 또는 배포를 지원하는 기능으로서, Github에서 제공하는 CI/CD 도구라고 생각하면 됩니다.

---

👩‍💻 GitHub Actions 구성요소

Workflow

• Workflow는 프로젝트를 빌드, 테스트, 패키지, 릴리스 또는 배포하기 위한 전체적인 프로세스
• Workflow는 여러개의 Job으로 구성되어 event기반으로 동작
• 여러 Job으로 구성되며 최상위 개념
• Workflow 파일은 YAML으로 작성되고, Github Repository의 .github/workflows 폴더 아래에 저장

Event

• Workflow를 실행하는 특정 활동이나 규칙이다
• 예) 특정 브랜치로 Push / 특정 브랜치로 Pull Request

Jobs

• Job은 여러 Step으로 구성되고, 가상 환경의 인스턴스에서 실행된다.
• 한가지 러너안에서 실행되는 여러가지 step들의 모음

Actions

• 복잡하고 자주 반복되는 작업을 정의한 커스텀 어플리케이션
• workflow 파일 안에서 자주 반복되는 코드를 미리 정의해 코드의 양을 줄일 수 있습니다.

---

👩‍💻 GitHub Actions + CodeDeploy를 이용한 CI/CD 흐름

1. Github에 push 시, Github Actions에서 push를 감지하고 정해진 Action을 수행
2. 업데이트된 코드를 바탕으로 Build와 Test를 수행
3. 코드를 압축하여 zip파일을 생성
4. S3에 zip파일을 업로드
5. Code Deploy에 배포 요청을 내림
6. S3로부터 zip파일을 받음
7. 지정한 EC2 인스턴스에 애플리케이션 파일을 전달
8. EC2 인스턴스에서 쉘 스크립트를 실행하여 배포 완료

---

👩‍💻 설치과정

📍CI

1. github 프로젝트 Repository의 Actions → set up a workflow your self 클릭하여 yml 파일을 생성합니다.

2. 자동 빌드 및 테스트를 위해 다음과 같이 yml 작성합니다.

deploy.yml

name: Build and Deploy Spring Boot to AWS EC2

on:
  push:
    branches: [ main ]

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

      - name: Setup Java JDK 11
        uses: actions/setup-java@v1
        with:
          java-version: 11

      - name: Setup MySQL
        uses: samin/mysql-action@v1
        with:
          character set server: 'utf8'
          mysql database: 'rds'
          mysql user: ${{user}}
          mysql password: ${{password}}

      - name: Grant execute permission for gradlew
        run: chmod +x ./gradlew
        shell: bash

      - name: Make application-prod.properties
        if: contains(github.ref, 'main') # branch가 main 일 때
        run: |
          cd ./src/main/resources
          touch ./application-prod.properties
          echo "${{ secrets.APPLICATION }}" > ./application-prod.properties
        shell: bash

      - name: Build with Gradle
        run: ./gradlew build -x test
        shell: bash

Github Actions는 .github/workflows 하위 경로에 yml파일을 작성하면, 특정 트리거가 발생 시 Actions Runner가 yml 파일에 지정된 행동을 수행합니다.

파일 구조

3. 민감 정보 파일은 github Repository→Settings→Secrets and variable→Actions에서 New repository secret 버튼을 눌러서 작성합니다.

4. APPLICATION을 Name으로 rds 정보와 같이 공개해선 안되는 민감정보를 작성합니다. 작성 후 Add secret을 누르면 깃허브 액션이 빌드하면서 자동으로 APPLICATION 내용을 가지고 application-prod.properties파일을 만듭니다.

 

📍CD

1. [S3 버킷 생성]작성한 코드를 s3 버킷에 옮기기 위해 s3 버킷을 생성합니다. 버킷을 구분하기 위한 이름과 서울 리전을 선택합니다.

2. IAM 사용자를 이용하여 s3에 접근할 것이기 때문에 모든 퍼블릭 엑세스를 차단합니다.

3. 이후 다른 설정들은 기본값으로 하여 s3 버킷 생성을 완료합니다.

4. [IAM 사용자 생성]CI/CD를 위한 IAM 사용자를 생성합니다. ACCESS TOKEN 값을 사용하면 되므로 AWS Management Console에 대한 사용자 엑세스 권한은 체크하지 않습니다.

5. AmazonS3FullAccess, AWSCodeDeployFullAccess 권한을 선택한 후 IAM 사용자를 생성합니다.

6. AWS에서는 기본적으로 ACCESS KEY를 사용한 인증 방식을 권장하고 있지 않기 때문에 따로 ACCESS KEY를 생성해야 합니다. 생성된 IAM 사용자를 클릭하고 보안 자격증명에 들어갑니다. 액세스 키 만들기를 클릭합니다.

7. AWS 외부에서 실행되는 애플리케이션을 선택한 후 다음으로 넘어갑니다.

8. 액세스 키가 생성되면 액세스 키와 비밀 액세스 키를 꼭 저장합니다. 완료 버튼을 누르면 다시 키 값을 받을 수 없으니 .csv 파일 다운로드 버튼을 눌러 키값을 저장합니다. 

9. Github Actions에서 AWS 서비스에 접근할 수 있도록 Repository의 Settings→Secret and variables→ Actions → New repository secret에 IAM 사용자의 액세스 키(AWS_ACCESS_KEY_ID와 비밀 액세스 키(AWS_SECRET_ACCESS_KEY)를 저장합니다.

10. [EC2 관련 설정]EC2 인스턴스에 대한 IAM 역할을 수정합니다.

11. 새 역할 생성 버튼을 클릭합니다.

12. AWS 서비스 → 사용사례는 EC2를 클릭하고 다음 버튼으로 넘어갑니다.

13. IAM 역할을 구분할 수 있는 이름을 작성하고 AmazonS3FullAccess와 AWSCodeDeployFullAccess에 대한 권한을 부여합니다.

14. 생성한 IAM 역할을 EC2 인스턴스에 연결합니다.

다음 글에서 계속됩니다.

---

👩‍💻 마치며

CI/CD 구축에 대한 긴 글을 읽어주셔서 감사합니다!

CI/CD를 구축하는데 짧지 않은 시간이 걸렸지만, 빌드와 배포를 자동화하면서 제품 품질을 높일 수 있었고, 사용자에게 더 빠른 서비스를 제공할 수 있어 뜻깊은 시간이었습니다.

이 글이 여러분에게 도움이 되기를 바라며 저는 다음 글 [GitHub Actions로 CI/CD 구축하기(2)] CodeDeploy 설치, 배포 스크립트 작성에서 더 나은 내용으로 찾아오겠습니다. 

감사합니다😄

 

👩‍💻 참고

https://velog.io/@sgwon1996/GitHub-Action%EC%9C%BC%EB%A1%9C-CICD-%EA%B5%AC%EC%B6%95%ED%95%98%EA%B8%B0

GitHub Action으로 CI/CD 구축하기

 

📩 Contact : uuuuujeong00000@naver.com

📲 SNS : https://www.instagram.com/may_u_j__