EC2, ECR, Docker Compose, Github Actions 사용하여 SpringBoot, MongoDB 배포하기

• 캡스톤에서 SpringBoot, MongoDB를 사용해서 백앤드 서버 개발을 해야한다.
• 내가 인프라를 맡기로 해서 CI/CD및 인프라를 완료하였다.
• 기록할겸 블로그에 정리해보았다.

EC2는 MongoDB,  SpringBoot 사용할 것이기에, 추가로 8080포트와 27017 포트를 열어주었다.

그리고 t2.micro말고 t3a.small을 사용하였다. t2.micro는 너무 작다...

https://start.spring.io/

• 실행 잘 된다.
• 이제 깃허브에 연결해주자

레포지토리 생성하고

git init
git add README.md
git commit -m "first commit"
git branch -M main
git remote add origin git@github.com:seongjju/seongjju-web-server.git
git push -u origin main

ec2에 접속해서

$ sudo apt update && /
sudo apt install openjdk-17-jdk -y
$ java -version # 잘 설치됐는 지 확인
$ git clone {git repository clone 주소}

토근 발급 참고

https://velog.io/@nara7875/github-%ED%86%A0%ED%81%B0-%EB%B0%9C%EA%B8%89%ED%95%98%EA%B8%B0

github 토큰 발급하기

 

• 매번 Github 계정과 비밀번호를 치는 과정 없애기

$ git config --global credential.helper store
$ git pull origin main
# Github 계정 및 비밀번호 입력
$ git pull origin main # 더 이상 비밀번호를 안 묻는 걸 확인할 수 있다.

• 깃허브에 시크릿 값 넣어주기

• Settings -> Secrets and variables -> Actions
• EC2_USERNAME: ubuntu
• EC2_HOST:원격 ip 나는 52.79.159.70
• EC2_PRIVATE_KEY: 이거는 아까 ec2만들때 pem값이다. 다운받은 pem키가 있는 폴더로 이동해서 cat으로 확인하자

• 여기서부터-----END RSA PRIVATE KEY----- 까지 넣으면 된다. 마지막 “%”는 넣으면 안된다.

 

• APPLICATION_PROPERTIES 이거는 yml파일값을 넣을것이다.
• 왜냐하면 보안을 위해서 깃허브에는 yml파일 값이 올라가면 안된다.
• application.yml을 .gitignore에 추가하고 올려야한다.

 

• 혹시 이미 깃허브에 yml파일을 올렸다면
• git rm --cached src/main/resources/application.yml로 캐시를 지우고 올리자

spring:
  data:
    mongodb:
      uri: mongodb://mongo:27017/seongjju-web-server-database

 

• 이제 도커 부분해보자

ec2에서

sudo apt-get update && \ sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common && \ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - && \ sudo apt-key fingerprint 0EBFCD88 && \ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" && \ sudo apt-get update && \ sudo apt-get install -y docker-ce && \ sudo usermod -aG docker ubuntu && \ sudo curl -L "https://github.com/docker/compose/releases/download/1.23.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && \ sudo chmod +x /usr/local/bin/docker-compose && \ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

도커 설치하고 엔터한번누르고

# 잘 설치됐는 지 확인 
$ docker -v # Docker 버전 확인 
$ docker compose version # Docker Compose 버전 확인

잘 설치 되었다.

• ECR생성

다른건 건들게 없다.

• EC2가 Private ECR에 접근할 수 있게 셋팅하기

# Ubuntu일 경우
$ sudo apt update
$ sudo apt install amazon-ecr-credential-helper

~ 경로에서 .docker라는 폴더 만들고, config.json 파일 만들어서 위와 같이 작성해라.
~/.docker/config.json

{
	"credsStore": "ecr-login"
}

 

• Github Actions의 IAM에 권한 추가
• iam 사용자와 역할 모두에 아래의 정책을 연결해야한다.
• AmazonEC2ContainerRegistryFullAccess

• 이 키를 아까 시크릿 값 넣은것처럼 깃허브 시크릿 값에 넣으면 된다.
• AWS_ACCESS_KEY_ID: 액세스 키
• AWS_SECRET_ACCESS_KEY: 비밀 액세스 키

 

• IAM 역할

• 생성완료
• 이제 ec2와 iam 연결 -> 이거 까먹어서 몇번이나 credentials 오류났다
• EC2 -> 작업 -> 보안 ->  Iam 역할 수정 
• 방금 만든 역할 선택하면 된다.

 

경로 참고 

 

.github/workflows/deploy.yml

name: Deploy To EC2

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Github Repository 파일 불러오기
        uses: actions/checkout@v4

      - name: JDK 17버전 설치
        uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: 17

      - name: application.yml 파일 만들기
        run: echo "${{ secrets.APPLICATION_PROPERTIES }}" > ./src/main/resources/application.yml

      - name: 테스트 및 빌드하기
        run: ./gradlew clean build

      - name: AWS Resource에 접근할 수 있게 AWS credentials 설정
        uses: aws-actions/configure-aws-credentials@v4
        with:
          aws-region: ap-northeast-2
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

      - name: ECR에 로그인하기
        id: login-ecr
        uses: aws-actions/amazon-ecr-login@v2

      - name: Docker 이미지 생성
        run: docker build -t seongjju-web-server .

      - name: Docker 이미지에 Tag 붙이기
        run: docker tag seongjju-web-server ${{ steps.login-ecr.outputs.registry }}/seongjju-web-server:latest

      - name: ECR에 Docker 이미지 Push하기
        run: docker push ${{ steps.login-ecr.outputs.registry }}/seongjju-web-server:latest

      - name: SCP로 EC2에 docker-compose.yml 파일 전송
        run: |
          echo "${{ secrets.EC2_PRIVATE_KEY }}" > private_key.pem
          chmod 600 private_key.pem
          scp -o StrictHostKeyChecking=no -i private_key.pem ./docker-compose.yml ${{ secrets.EC2_USERNAME }}@${{ secrets.EC2_HOST }}:/home/ubuntu/seongjju-web-server/

      - name: SSH로 EC2에 접속하기
        uses: appleboy/ssh-action@v1.0.3
        with:
          host: ${{ secrets.EC2_HOST }}
          username: ${{ secrets.EC2_USERNAME }}
          key: ${{ secrets.EC2_PRIVATE_KEY }}
          script_stop: true
          script: |
            cd /home/ubuntu/seongjju-web-server  # 실제 프로젝트 경로로 이동
            export ECR_REGISTRY=${{ steps.login-ecr.outputs.registry }}  # ECR_REGISTRY 환경 변수 
            docker-compose down  # 기존 컨테이너 중지
            # 'latest' 태그가 붙은 이미지를 최신 순으로 정렬하고, 첫 두 개를 제외한 나머지 삭제
            docker images --filter "reference=*:*latest" --format '{{.Repository}}:{{.Tag}}' | sort -r | awk 'NR > 2' | xargs -r docker rmi
            docker-compose pull  # ECR에서 최신 이미지 가져오기
            docker-compose up -d  # Docker Compose 실행

 

Dockerfile

FROM eclipse-temurin:17-jdk-alpine
COPY ./build/libs/*SNAPSHOT.jar project.jar
ENTRYPOINT ["java", "-jar", "project.jar"]

 

docker-compose.yml

version: '3.3'
services:
  spring:
    image: ${ECR_REGISTRY}/seongjju-web-server:latest  # 환경 변수를 사용
    container_name: seongjju-web-server
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - MONGO_URI=mongodb://mongo:27017/seongjju-web-server-database  # MongoDB 연결
    depends_on:
      - mongo  # mongo 서비스가 먼저 시작됨
    networks:
      - app-network

  mongo:
    image: mongo:latest
    container_name: mongodb
    ports:
      - "27017:27017"
    volumes:
      - mongo-data:/data/db
    networks:
      - app-network

networks:
  app-network:
    driver: bridge

volumes:
  mongo-data:
    driver: local

 

 

이제 깃허브에 올려보자 잘돌아가나~

git add .
git commit -m "cicd-test"
git push origin main

• 깃허브액션이 트리거 되어서 돌아가고 있다. 잘 되길 기도하자
• 오타하나, 연결하나 안하면 어딘가에 바로 빨간표시가 뜰것이다.

• 내 첫 오류는 내가 iam 사용자에 AmazonEC2ContainerRegistryFullAccess 이 권한을 누락해서 발생한 오류이다.
• 수정하고 다시 깃허브액션 실행시켜보자

 

• AWS CLI 설치

$ sudo apt install unzip
$ curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
$ unzip awscliv2.zip
$ sudo ./aws/install
$ aws --version # 잘 출력된다면 정상 설치된 상태

• AWS CLI로 액세스 키 등록하기

$ aws configure
AWS Access Key ID [None]: <위에서 발급한 액새스키>
AWS Secret Access Key [None]: <위에서 발급한 비밀액새스키>
Default region name [None]: ap-northeast-2
Default output format [None]: 엔터치면된다.

• 중간에 뭔가 안된다면 ec2를 재부팅 시켜보자

• 모든 job 성공~

 

혹시 안 되면 일시적 로그인하고 키들을 확인해보자

aws ecr get-login-password --region ap-northeast-2 | docker login --username AWS --password-stdin 811271461583.dkr.ecr.ap-northeast-2.amazonaws.com

 

그리고 ls해서 config.json만 남도록 다른거 지워주자 

• User, UserRepository, UserController를 만들고 
• 포스트맨으로 데이터 하나 넣어봤다.

처음에는 데이터베이스가 없었는데, 깃허브액션을 트리거하고 확인하니 저렇게 seongjju-web-server-database가 생겼고, json이 정상적으로 출력되는 것을 볼 수 있다.

이렇게 EC2, ECR, Docker Compose, Github Actions 사용하여 SpringBoot, MongoDB 배포를 완료하였다.