AWS Code Pipeline CI/CD

배포 시나리오
1. IAM 준비
EC2 IAM
Code Deploy IAM
2. EC2 설정
3. ECR 설정
4. Dockerfile 준비
5. buildspec.yml
6. appspec.yml
7. deploy.sh
8. CodeBuild
9. CodeDeploy
10. CodePipeline

AWS Code Pipeline, Code Build, Code Deploy, ECR을 이용한 SpringBoot CI/CD를 구현해보려고 한다.

EC2와 Spring Boot 프로젝트는 미리 준비해준다.

아래 사진은 전체 아키텍처 플로우다.

배포 시나리오

Github에 코드를 Push하면 Code Pipeline 동작
Code Build를 통해 빌드해 Docker Image를 ECR에 저장
S3에 Build Artifacts 업로드
CodeDeploy를 통해 EC2에 배포

1. IAM 준비

IAM은 AWS에서 사용자를 인증하고 권한을 관리하는 서비스다.

CI/CD를 위해 EC2에 필요한 IAM과 Code Deploy에 필요한 IAM을 생성한다.

EC2 IAM

EC2에는 S3, Code Deploy, ECR에 접근할 수 있는 권한이 필요하다.

IAM > 역할 > 역할 생성을 클릭한다.

AWS 서비스, EC2를 선택한다.

아래 4개의 권한을 선택한다.

AmazonEC2RoleforAWSCodeDeploy
AmazonS3FullAccess
AWSCodeDeployFullAccess
AWSCodeDeployRole

역할 이름을 입력한 후 역할을 생성한다.

방금 생성한 역할 클릭한다.

권한 추가 > 인라인 정책 생성을 클릭한다.

ECR 관련 추가 정책을 추가해준다.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ecr:GetAuthorizationToken",
                "ecr:BatchGetImage",
                "ecr:GetDownloadUrlForLayer",
                "ecr:ListImages"
            ],
            "Resource": "*"
        }
    ]
}

Code Deploy IAM

AWS 서비스, CodeDeploy를 선택한다.

2. EC2 설정

EC2 인스턴스 > 작업 > 보안 > IAM 역할 수정을 클릭한다.

위에서 생성한 EC2 IAM을 선택한다.

EC2에 접속 후 아래와 같은 명령어를 입력해준다.

Code Deploy를 사용하기 위해서는 Agent가 필요하다. 이 Agent는 Ruby가 필요하기 때문에 Ruby 설치가 필요하다.

# 도커 설치
sudo yum install docker -y
sudo sysmtectl enable docker
sudo systemctl start docker

# Ruby 설치
sudo yum install ruby

# wget 설치
sudo yum install wget

# Code Deploy Agent 설치
wget https://aws-codedeploy-ap-northeast-2.s3.ap-northeast-2.amazonaws.com/latest/install

chmod +x ./install
sudo ./install auto
sudo systemctl enable codedeploy-agent
sudo systemctl start codedeploy-agent

3. ECR 설정

ECR(Elastic Container Registry)는 AWS에서 제공하는 Docker 컨테이너 이미지 저장소이다.

ECR > 프라이빗 리포지토리 > 리포지토리 생성을 클릭한다.

리포지토리 이름을 입력해주고 이미지 태그 변경 가능성을 선택한다.

4. Dockerfile 준비

Spring Boot는 CodeBuild에서 빌드하는 것이 속도 면에서 유리하며, 여러 EC2에 배포할 때마다 빌드할 필요가 없다. 따라서 Dockerfile은 이미 빌드된 JAR 파일을 실행하는 역할만 수행한다.

FROM openjdk:17
COPY build/libs/<jar명>.jar /app.jar
CMD ["java", "-jar", "/app.jar"]

5. buildspec.yml

buildspec.yml은 CodeBuild가 할 행동을 정의하는 파일이다. 이 파일은 SpringBoot 프로젝트 최상위에 만들어준다.

version: 0.2

phases:
  pre_build:
    commands:
      - aws ecr get-login-password --region ap-northeast-2 | docker login --username AWS --password-stdin 904233098323.dkr.ecr.ap-northeast-2.amazonaws.com
      - REPOSITORY_URI=904233098323.dkr.ecr.ap-northeast-2.amazonaws.com/ci_cd
      - IMAGE_TAG=dev
  build:
    commands:
      - ./gradlew build
      - docker build -t $REPOSITORY_URI:$IMAGE_TAG .
  post_build:
    commands:
      - docker push $REPOSITORY_URI:$IMAGE_TAG
cache:
  paths:
    - '/root/.gradle/**/*'
    - '/tmp/gradle/**/*'
artifacts:
  files:
    - appspec.yml
    - scripts/*

코드를 살펴보면 AWS ECR에 로그인하는 부분이 있다. 저 명령어는 ECR Repository 생성 후 푸시 명령 보기를 누르면 아래와 같이 나온다.

6. appspec.yml

appspec.yml은 CodeDeploy의 행동을 정의하는 파일이다.

buildspec.yml과 마찬가지로 SpringBoot 프로젝트의 최상위에 만들어준다.

version: 0.0
os: linux
files:
  - source: /
    destination: /home
hooks:
  ApplicationStart:
    - location: scripts/deploy.sh
      timeout: 300
      runas: root

7. deploy.sh

SpringBoot 프로젝트 최상위 기준으로 /scripts/deploy.sh 경로로 만들어준다.

# 실패 시 즉시 종료
set -e

# AWS ECR 로그인
aws ecr get-login-password --region ap-northeast-2 | docker login --username AWS --password-stdin 904233098323.dkr.ecr.ap-northeast-2.amazonaws.com

# 기존 컨테이너 중지 및 삭제
docker stop aws_ci_cd || true
docker rm aws_ci_cd || true

# 최신 이미지 가져오기
docker pull 904233098323.dkr.ecr.ap-northeast-2.amazonaws.com/ci_cd:dev

# 컨테이너 실행
docker run -d --name ci_cd -p 8080:8080 904233098323.dkr.ecr.ap-northeast-2.amazonaws.com/ci_cd:dev