[Docker] GitHub Action을 이용한 Amazon EC2 Spring 프로젝트 자동 배포 환경 구축

Amazon EC2 Linux환경에서 진행했다.

 

 

 

 

 

 

1. EC2에 Docker 설치

 

sudo yum update -y

시작하기 전에 yum 패키지를 모두 최신 버전으로 업데이트 해주었다.

sudo yum install docker -y

yum을 이용해서 docker를 설치했다.

 

• Docker 버전 확인

docker -v

 

• Docker 시작

sudo service docker start

 

• Docker 그룹에 ec2-user 를 넣어서 관리자 권한으로 실행할 수 있게 해준다.

sudo usermod -aG docker ec2-user

 

• 최신 버전의 Docker Compose 설치

sudo curl -L https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m) -o /usr/local/bin/docker-compose

 

이후, 인스턴스 재 시작 후 Docker 명령어를 실행해보자.

docker run hello-world

 

 

 

 

 

 

 

 

 

2. AWS IAM 설정 (생략 가능)

 

AWS IAM 은 AWS의 기능들을 원격으로 사용할 권한이 있는 사용자를 관리하는 서비스이다.

원래는 IAM을 설정하여 github의 가상환경 내에서 내 AWS에 접속하여 해당 EC2에

인바운드 규칙에 github IP를 추가하고, 접속 후에 다시 제거하는 용도로 사용하려고 했다.

github의 IP는 수시로 바뀌기 때문에 설정해둔 것이었는데, 방법만 적어놓고 나는 22번 포트만 열어두었다.

AWS에서 계속 돈 내라고 하기 때문에

 

aws에서 IAM 서비스로 들어가서 사용자로 들어간다.

 

사용자 추가를 눌러주자.

원하는 이름을 입력하고 다음을 누른다.

권한 설정 중에, 직접 정책 연결에서 EC2FullAcess를 검색하고 추가해준다.

그대로 사용자 생성을 눌러준다.

사용자가 생성 되었다면, 눌러서 세부 설정을 해주자.

아래에 보안 자격 증명 탭을 누르면, 엑세스 키 만들기 버튼이 있다.

AWS 컴퓨팅 서비스에서 실행되는 어플리케이션을 선택하고 다음을 누른다.

원하는 태그를 입력하면, 엑세스 키가 발급된다.

엑세스 키를 어느 곳에다가 복사해 두거나, csv파일을 받아놔서 소중히 잘 보관해두자.
다른 곳에(특히 github)에 절대로 유출되면 안된다!!

 

 

 

 

 

 

 

3. EC2 접근 설정 (ID, PW)

원래는 ssh를 이용해서 접근하는 방법을 사용할 수 있겠지만,
EC2 내에서 ID와 Password를 이용해서 접근하는 방법을 이용해 보겠다.

whoami

보통은 ec2의 username은 ec2-user이다. 명령어를 이용해서 미리 확인해 보자.

sudo passwd {username}

sudo passwd ec2-user

위 명령어를 통해 새로운 비밀번호를 설정할 수 있다. 원하는 비밀번호로 설정해주자.

이제, 비밀번호를 통해 접근하는 것을 허용해주자.

sudo vi /etc/ssh/sshd_config

편집기를 열어서 PasswordAuthentication 을 yes로 바꿔주자.
/Password 를 이용하면 쉽게 찾을 수 있다.

sudo systemctl restart sshd 

설정하고 나면 sshd를 재시작 해준다.

이제, ec2를 나와서(ctrl+D) 비밀번호로 접근이 되는지 확인해보자.

sudo ssh [username]@[ec2 인스턴스 ip (퍼블릭 IPv4 DNS)]

sudo ssh ec2-user@ip

 

 

 

 

 

 

4. Docker Token 설정

Docker Hub에서 내 계정 설정에 들어간다.

Security부분에 New Access Token을 눌러서 토큰을 만들어 준다.

해당하는 이 토큰을 소중히 잘 갖고있자.

5. GitHub Action Secret 설정

위 Action 스크립트에서 사용했던 여러 키들을 Secret으로 관리할 수 있다.
Settings -> Secrets and Variables -> Actions에 들어와서
New repository secret을 눌러주자.

여기서 여러 키들을 생성할 수 있는데, 다음 키들을 생성해 주자.

• DOCKERHUB_USERNAME : Docker Hub 닉네임 입력
• DOCKERHUB_TOKEN : 방금 받았던 Docker Hub 토큰 입력
• AWS_ACCESS_KEY_ID : 위 AWS IAM에서 발급받은 ACESS KEY를 입력 (IAM설정 생략 시 생략 가능)
• AWS_SECRET_ACCESS_KEY : IAM에서 발급 받은 SECRET KEY를 입력 (IAM설정 생략 시 생략 가능)
• AWS_SG_ID : EC2 보안그룹ID
• EC2_HOST : EC2의 퍼블릭 IPv4 주소.
• EC2_PASSWORD : EC2에 접근/연결 설정해두었던 패스워드.
• EC2_SSH_PORT : SSH로 접근할 port. (22)
• EC2_USERNAME : EC2의 계정명. (ec2-user)
• APPLICATION_YML : 서버의 yml파일. (base64로 인코딩해서 넣어야 한다.)

여기서 보안그룹ID는, 해당 인스턴스의 보안그룹에 들어가서 확인할 수 있다.

 

모든 KEY들을 완성했다.
이 KEY들은 GitHub Action의 스크립트 내에 알맞게 들어가서 실행 될 것이다.

6. 프로젝트 Dockerfile 설정

Spring 프로젝트 내에 Dockerfile을 만들어주자. 파일 이름이 꼭 Dockefile !!

아래 내용을 작성해준다.

• maven

# Java Version
FROM openjdk:11-jdk

# Jar 파일의 위치
ARG JAR_FILE=target/*.jar

# 프로젝트 build 파일을 app.jar로 가져오기
COPY ${JAR_FILE} app.jar

# 8080포트로 사용할 경우. (생략 가능)
EXPOSE 8080

# 프로젝트 빌드
ENTRYPOINT ["java", "-jar", "/app.jar"]

# 옵션 추가 가능
# ENTRYPOINT ["java", "-jar", "-Dspring.profiles.active=docker", "/app.jar"]

• gradle

FROM openjdk:11-jdk
ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar
ENTRYPOINT ["java", "-Dspring.profiles.active=docker", "-jar", "app.jar"]

gradle이라면 build.gradle에 아래 내용도 추가해준다.

jar {
    enabled = false
}

→ 프로젝트를 빌드하면, ~~.jar 과 ~~-plain.jar 두 개의 파일이 생긴다.

plain 빌드 파일은 gradle.build에 추가해두었던 depdencies들이 포함되지 않는 파일이다.

docker 컨테이너에서는 app.jar로 가져와서 오브젝트들을 사용할 것이기 때문에 depdency들이 포함된 jar파일을 사용해야 한다.

enabled = false 옵션을 사용하면 plain이 생성되지 않는다.


버전이 다른 내용이 있으면 알맞게 바꿔서 사용하면 된다!

 

 

7. Docker 로그인

EC2에서 docker에 접속하기 위해 로그인 해두자.

docker login -u [username]

로그인에 성공하면 자동으로 비밀번호를 암호화하여 저장해둔다.

8. GitHub Action 설정

원하는 레포지토리 > Actions에 들어와보자.

여기서 Java with Gradle을 선택하면,

gradle.yml 스크립트를 생성할 수 있다.

 

아래 내용을 작성해주자.

name: Java CI with Gradle

on:
  push:
    branches: [ "main" ] #push할 경우 사용 할 branch 명 기입

jobs:
  deploy: 
    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v3
      
    # Java Version 기입
    - name: Set up JDK 17 
      uses: actions/setup-java@v2
      with:
        java-version: '17'
        distribution: 'temurin'

	#Secret에 설정해둔 YML파일 (BASE64로 인코딩 되어있어야 함) 설정
    - name: Set YML
      run: |
        mkdir -p src/main/resources
        echo "${{ secrets.APPLICATION_YML }}" | base64 --decode > src/main/resources/application.yml
        find src
 
    
    #gradlew 권한 설정
    - name: Grant execute permission for gradlew
      run: chmod +x ./gradlew
    
    # Spring Boot Build
    - name: Spring Boot Build
      run: ./gradlew clean build -x test
      
      
      
    #------------------- Docker --------------------

    # Docker Image Build
    - name: Docker Image Build
      run: docker build -t ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_IMAGENAME }} . 
    
    # DockerHub Login
    - name: Docker Hub Login 
      uses: docker/login-action@v2
      with: 
        username: ${{ secrets.DOCKERHUB_USERNAME }}
        password: ${{ secrets.DOCKERHUB_TOKEN }}

    # Docker Hub push
    - name: docker Hub push
      run: docker push ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_IMAGENAME }}
  
  
  
    #------------------- EC2 --------------------
    
    # AWS EC2 Server Connect & Docker 명령어 실행
    - name: AWS EC2 Connection
      uses: appleboy/ssh-action@v0.1.6
      with:
        host: ${{ secrets.EC2_HOST }}
        username: ${{ secrets.EC2_USERNAME }}
        password: ${{ secrets.EC2_PASSWORD }} 
        port: ${{ secrets.EC2_SSH_PORT }}
        timeout: 60s
        script: |
          sudo docker stop ${{ secrets.DOCKERHUB_IMAGENAME }}
          sudo docker rm ${{ secrets.DOCKERHUB_IMAGENAME }}
          sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_IMAGENAME }}
          sudo docker run -it -d -p 443:443 --name ${{ secrets.DOCKERHUB_IMAGENAME }} -e TZ=Asia/Seoul ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_IMAGENAME }}

Github AWS 연결 공식 문서 >> https://github.com/appleboy/ssh-action

중간에 프로젝트에 맞는 Java 버전, Docker Image명, 원하는 port등을 수정해서 사용하면 되겠다.

로직은 간단하게, 깃허브에서 push를 감지하면 가상환경 내에서

1. Java 환경을 세팅하고 yml파일을 설정한다.
2. 프로젝트를 빌드한다.

3. 만들어진 프로젝트를 도커 이미지로 빌드한다.

4. 도커에 로그인하고 이미지를 푸시한다.

5. EC2에 접속하여 실행하던 컨테이너를 멈추고, 이미지를 pull 받은 후 다시 실행시킨다.

 

나는 프로젝트에 https설정까지 해두어서 443포트로 열었다. 추가로, 한국 시간 설정 옵션 TZ=Asia/Seoul 까지 넣어두었다.

 

 

 

 

9. Push 테스트

이제 깃허브에 푸시를 진행해보자.

 

푸시를 진행하면, Action에서 push를 감지하고 커밋 메세지 명으로 된 Action을 시작하게 된다.

 

 

그리고 Action이 모두 완료되면, 아래와 같이 성공으로 뜬다.

 

 

여기서 오류가 난다면, 안으로 들어가서 어디가 오류 났는지 찾아보고 고쳐야한다.

대부분은 스크립트 내에 설정 오류일 확률이 높다. gradle.yml 파일에 내가 넣은 설정이 맞는지 확인해보자.

만약 모든 스크립트가 성공했다면,

Docker Desktop에 이미지가 정상적으로 push됐는지 확인해보자.

 

 

서버에선 정상적으로 실행되고 있는지 확인하기 위해

 

아래 명령어로 도커가 컨테이너가 실행 중인지 확인할 수 있다.

docker logs {docker이미지명}