[CI/CD] Github Action과 친해지기 - AWS ECR push 하기

TL;DR

github action은 github repository의 소스를 기반으로 손쉽게 CI/CD를 구성할 수 있는 도구 입니다. github action을 구성하기위해 yaml형식으로 정의를 해야하며 github action에서 다양한 샘픔을 제공해주고 있습니다.
그 중에 ECS샘플을 활용하여 git repository에 있는 소스를 도커로 만들고(Dockerizing) ECR push를 해보도록 하겠습니다.

샘플소스

https://github.com/kimdragon50/frontend.git

AWS ECS workflow 샘플 예제 가져오기

• github.com - Actions - New workflow
• Deploy to Amazon ECS 선택
• 이렇게 하면 자동으로 git repository에 .github/workflows/aws.yaml 이 생성됩니다

AWS credentials을 secrets에 저장하기

• github.com - Settins - Secrets
• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
  

  

aws.yaml 커스터마이징

• ECR배포까지는 하지 않을 것이므로 주석으로 생략합니다
• 소스코드에 작성해놓은 dockerfile이 있어야합니다. (dockerfile은 샘플소스에 포함되어있습니다.)

# This workflow will build and push a new container image to Amazon ECR,
# and then will deploy a new task definition to Amazon ECS, when there is a push to the main branch.
#
# To use this workflow, you will need to complete the following set-up steps:
#
# 1. Create an ECR repository to store your images.
#    For example: `aws ecr create-repository --repository-name my-ecr-repo --region us-east-2`.
#    Replace the value of the `ECR_REPOSITORY` environment variable in the workflow below with your repository's name.
#    Replace the value of the `AWS_REGION` environment variable in the workflow below with your repository's region.
#
# 2. Create an ECS task definition, an ECS cluster, and an ECS service.
#    For example, follow the Getting Started guide on the ECS console:
#      https://us-east-2.console.aws.amazon.com/ecs/home?region=us-east-2#/firstRun
#    Replace the value of the `ECS_SERVICE` environment variable in the workflow below with the name you set for the Amazon ECS service.
#    Replace the value of the `ECS_CLUSTER` environment variable in the workflow below with the name you set for the cluster.
#
# 3. Store your ECS task definition as a JSON file in your repository.
#    The format should follow the output of `aws ecs register-task-definition --generate-cli-skeleton`.
#    Replace the value of the `ECS_TASK_DEFINITION` environment variable in the workflow below with the path to the JSON file.
#    Replace the value of the `CONTAINER_NAME` environment variable in the workflow below with the name of the container
#    in the `containerDefinitions` section of the task definition.
#
# 4. Store an IAM user access key in GitHub Actions secrets named `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
#    See the documentation for each action used below for the recommended IAM policies for this IAM user,
#    and best practices on handling the access key credentials.

name: Dockerizing to Amazon ECR

on:
  push:
    branches:
      - main

env:
  AWS_REGION: ap-northeast-2                   # set this to your preferred AWS region, e.g. us-west-1
  ECR_REPOSITORY: frontend-web # set this to your Amazon ECR repository name

#  ECS_SERVICE: MY_ECS_SERVICE                 # set this to your Amazon ECS service name
#  ECS_CLUSTER: MY_ECS_CLUSTER                 # set this to your Amazon ECS cluster name
#  ECS_TASK_DEFINITION: MY_ECS_TASK_DEFINITION # set this to the path to your Amazon ECS task definition
#                                               # file, e.g. .aws/task-definition.json
#  CONTAINER_NAME: MY_CONTAINER_NAME           # set this to the name of the container in the
#                                               # containerDefinitions section of your task definition

jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest
    environment: production

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

    - 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: ${{ env.AWS_REGION }}

    - name: Login to Amazon ECR
      id: login-ecr
      uses: aws-actions/amazon-ecr-login@v1

    - name: Build, tag, and push image to Amazon ECR
      id: build-image
      env:
        ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
        IMAGE_TAG: ${{ github.sha }}
      run: |
        # Build a docker container and
        # push it to ECR so that it can
        # be deployed to ECS.
        docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
        docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
        echo "::set-output name=image::$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG"

#    - name: Fill in the new image ID in the Amazon ECS task definition
#      id: task-def
#      uses: aws-actions/amazon-ecs-render-task-definition@v1
#      with:
#        task-definition: ${{ env.ECS_TASK_DEFINITION }}
#        container-name: ${{ env.CONTAINER_NAME }}
#        image: ${{ steps.build-image.outputs.image }}
#
#    - name: Deploy Amazon ECS task definition
#      uses: aws-actions/amazon-ecs-deploy-task-definition@v1
#      with:
#        task-definition: ${{ steps.task-def.outputs.task-definition }}
#        service: ${{ env.ECS_SERVICE }}
#        cluster: ${{ env.ECS_CLUSTER }}
#        wait-for-service-stability: true

git push

git add .
git commit
# git push git-origin HEAD
git push origin HEAD

참고로 git token의 권한에 workflows가 포함되어있어야합니다.

결과

git push를 하게되면 git hub action의 workflows가 동작합니다.

이슈

git push를 하고나서 git action이 바로 동작하는 것이 아니라 별도 트리거를 걸 수 있는지?

workflow_dispatch를 사용하여 구현가능합니다.

### 기존
#on:
#  push:
#    branches:
#      - main

### 변경
on:
  workflow_dispatch:
    inputs:
      logLevel:
        description: 'Log level'
        required: true
        default: 'warning'
      tags:
        description: 'Test scenario tags'

위와 같이 yaml파일의 on 필드에 workflow_dispatch 를 사용하면 git action의 UI에 아래와 같이 트리거 버튼을 이용할 수 있습니다.

workflows에 있는 모든 yml 파일이 동작하게되는데 여러 yml을 순서대로 동작할 수 있게 할 수 있는지?

• yaml을 별도로 구성하는 것이 아니고 steps에서 여러가지 name으로 구성

오늘은 여기 까지 입니다. 이슈 1,2 에 대해서 더 좋은 아이디어 있으면 공유부탁드려요.