[AWS CI/CD] deploy.yaml 분석

Github Action Workflows

deploy.yaml

name: CI-CD

on:
  push:
    branches:
      - main

env:
  S3_BUCKET_NAME: longstone
  RESOURCE_PATH: ./src/main/resources/application.yaml
  CODE_DEPLOY_APPLICATION_NAME: GoldenHour_code_deploy
  CODE_DEPLOY_DEPLOYMENT_GROUP_NAME: goldenhour-server

jobs:
  build:
    runs-on: ubuntu-latest

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

      - name: Set up JDK 17
        uses: actions/setup-java@v1
        with:
          java-version: 17
        
        # [1]
      - name: Set yaml file 
        uses: microsoft/variable-substitution@v1
        with:
          files: ${{ env.RESOURCE_PATH }} 
        env:
          override.value: ${{ secrets.DI_FROM_SECRET }} 
          # override.value: 'from deploy.yaml' <-- 이렇게 사용해도 주입이 된다.

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

        # [2]
      - name: Build with Gradle
        run: ./gradlew build
        shell: bash

        # [3]
      - name: Make zip file
        run: zip -r ./$GITHUB_SHA.zip .
        shell: bash

        # [4]
      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: AKIASGQNGYKOFON2ORVP
          aws-secret-access-key: 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
          aws-region: ap-northeast-2

        # [5]
      - name: Upload to S3
        run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://$S3_BUCKET_NAME/$GITHUB_SHA.zip

        # [6]
      - name: Code Deploy
        run: | 
          aws deploy create-deployment \
          --deployment-config-name CodeDeployDefault.AllAtOnce \
          --application-name ${{ env.CODE_DEPLOY_APPLICATION_NAME }} \
          --deployment-group-name ${{ env.CODE_DEPLOY_DEPLOYMENT_GROUP_NAME }} \
          --s3-location bucket=$S3_BUCKET_NAME,bundleType=zip,key=$GITHUB_SHA.zip

---

[1] Set yaml file

- name: Set yaml file 
  uses: microsoft/variable-substitution@v1
  with:
    files: ${{ env.RESOURCE_PATH }} 
  env:
    override.value: ${{ secrets.DI_FROM_SECRET }} 
    # override.value: 'from deploy.yaml' <-- 이렇게 사용해도 주입이 된다.

• Github Action을 사용하여 빌드 시
• 동적으로 변수에 값을 주입하기 위한 Step이다.
• 그러면 이런 질문을 던질 수 있다.답을 하자면 CI/CD를 위해 해당 Step은 필요하지 않다.그 이유는 이 글을 참고하자.
• 그러나 아마도 필요할 것이다.
• ” 반드시 필요한 Step인가? “

---

[2] Build with Gradle

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

• Gradle로 빌드를 하기 위한 Step이다.
• 만약 멀티 모듈 구조의 프로젝트라면 run 부분을 다음과 같이 원하는 옵션을 넣어 사용하면 된다.

- name: Build with Gradle
  run: ./gradlew clean :tiltil-api:buildNeeded --stacktrace --info -x test
  # run: ./gradlew clean :{ Module-Name }:buildNeeded --stacktrace --info -x test
  shell: bash

---

[3] Make zip file

- name: Make zip file
  run: zip -r ./$GITHUB_SHA.zip .
  shell: bash

• 프로젝트를 빌드했으면 그 결과물을 어딘가에 저장을 시켜놔야 한다.근데 그냥 저장시키는 게 아니라 zip 파일로 압축해서 저장시키는 데 필요한 Step이다.
• ( 바로 EC2 인스턴스에 배포하고 싶지만 그렇게는 안 된다. )
• zip 파일 저장 시 파일명은
• Github에서 default로 제공하는 환경변수인 GITHUB_SHA를 사용한다.

GITHUB_SHA : The commit SHA that triggered the workflow. 
             For example, ffac537e6cbbf934b08745a378932722df287a53.

• 이렇게 저장된 zip 파일은AWS의 CodeDeploy를 사용하여 EC2 인스턴스에 배포한다.
• AWS의 S3라는 저장소에 저장되고

---

[4] Configure AWS credentials

- name: Configure AWS credentials
  uses: aws-actions/configure-aws-credentials@v1
  with:
    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} 
    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} 
    aws-region: ${{ secrets.AWS_REGION }} 

• AWS 서비스에 접근하는 데 필요한 권한을 얻어오는 Step이라고 생각하면 된다.

---

[5] Upload to S3

- name: Upload to S3
  run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://$S3_BUCKET_NAME/$GITHUB_SHA.zip

• 빌드된 결과물을 S3에 저장하기 위한 Step이다.
• 만약 위 스크립트를 가져다 사용할 경우
• 수정해야 하는 부분은 $S3_BUCKET_NAME 값이다.
• 저 변수 같은 경우에 Workflow 상단에 선언해놓았다.

env:
  S3_BUCKET_NAME: longstone

• S3 버켓 이름을 그대로 작성하면 된다.

---

[6] Code Deploy

- name: Code Deploy
  run: | 
    aws deploy create-deployment \
    --deployment-config-name CodeDeployDefault.AllAtOnce \
    --application-name ${{ env.CODE_DEPLOY_APPLICATION_NAME }} \
    --deployment-group-name ${{ env.CODE_DEPLOY_DEPLOYMENT_GROUP_NAME }} \
    --s3-location bucket=$S3_BUCKET_NAME,bundleType=zip,key=$GITHUB_SHA.zip

• 만약 위 스크립트를 가져다 사용할 경우
• 수정해야 하는 부분은 application-name 과 deployment-group-name 값이다.
• 저 값들은 AWS의 CodeDeploy 서비스에서 가져오면 된다.

[7] Github Secrets

• 코드를 보다 보면 다음과 같이 secrets로 시작하는 Key 값들이 보인다.

${{ secrets.DI_FROM_SECRET }} 
${{ secrets.AWS_ACCESS_KEY_ID }} 
${{ secrets.AWS_SECRET_ACCESS_KEY }} 
${{ secrets.AWS_REGION }} 

• 위 값들은 Github Action 동작 시
• Github Repository -> Settings -> Secrets -> Actions에 정의해놓은 값들이 주입된다.

 

<deploy.yaml 수정>

S3에 빌드한 jar 업로드 하기

S3 버킷을 생성하는 방법에 대해서는 다루지 않겠습니다. 버킷 생성하는 과정이 궁금하다면 여기 를 참고하시면 좋을 거 같습니다.

위에서 작성한 yml 파일에 좀 더 추가를 해야 하는데요. 어떤 것을 추가해야 하는지 좀 더 알아보겠습니다.

name: deploy-action

on:
  push:
    branches:
      - master
  workflow_dispatch:

env:
  S3_BUCKET_NAME: longstone

jobs:
  build:
    runs-on: ubuntu-latest

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

      - name: Set up JDK 11
        uses: actions/setup-java@v1
        with:
          java-version: 11

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

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

      # 새로 추가 된 부분 
      - name: Make zip file
        run: zip -r ./$GITHUB_SHA.zip .
        shell: bash

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ${{ secrets.AWS_REGION }}

      - name: Upload to S3
        run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://$S3_BUCKET_NAME/$GITHUB_SHA.zip

위와 같이 yml을 수정하겠습니다. 추가된 코드의 의미는 아래와 같습니다.

• env
  • 현재 스크립트에서 사용할 환경변수를 정의하여 사용할 수 있습니다.
  • 여러 곳에서 공통으로 사용되는 문자열이나, 명확하게 의미를 부여해야 하는 키워드에 사용하면 좋습니다.
• $GITHUB_SHA
  • Github Actions에서 제공하는 여러 기본 환경변수 중 하나입니다. 현재 workflow를 실행시키는 커밋의 해쉬값입니다.
• $ {{ secrets.이름 }}
  • IAM 엑세스 키, 비밀 키 같은 것들을 노출시킬 수 없으니까 따로 등록해놓고 참조해서 가져오는 식으로 사용할 수 있습니다.
• aws s3 cp
  • aws cli 명령어 중 하나입니다. copy 명령어로 현재 위치의 파일을 S3로 업로드 하거나, 반대로 S3 파일을 현재 위치로 다운로드 할 수 있습니다.