[GitHub Action & Docker] 수동: Github Action으로 CI + 개발자가 직접 CD #1

실습 #1

---

 

1. CI 사전 준비: 배포하고자 하는 Java 코드 작성 및 Github 업로드

⚠️ 필자는 이전에 공부했던 Spring 실습 코드를 Github를 이용할 예정이다.

 

1. 디폴트 브랜치 이름을 main으로 바꾸어준다.

• 필자는 main 브랜치로 배포할 것임.

git branch -m main

 

2. 원격 저장소를 생성한 후, 원격 저장소(Github Repository)에 Push. (sanghyun-e/ci-ci-tutorial)

 

원격 저장소가 없는 경우 

git remote add origin git@github.com:SangHyun-e/ci-cd-tutorial.git

 

원격 저장소를 변경하는 경우

git remote set-url origin git@github.com:SangHyun-e/ci-cd-tutorial.git

 

• Git 명령어는 해당 포스팅을 참고하자 !
  • https://1000sang-dev.tistory.com/26

Git & GitHub #2 - Git 시작과 Local/Remote Branch 관리

• Dockerfile 구성에 필요한 명령어는 해당 링크에서 참고하자 !
  • https://www.daleseo.com/dockerfile/

Dockerfile에서 자주 쓰이는 명령어

2. CI: Github 내 Java 코드를 Github Action으로 가져와 Docker 빌드.

위치 : Github Action

• Github Repository에 Java 소스 코드가 업로드되는 순간 (Push) Github Action 스크립트가 구동된다.
• Github Action 스크립트는 아래와 같으며, 개발자가 직접 작성 후 Github에 Java 코드와 함께 올린다.

1. Java 테스트: Java 코드를 테스트 → 이번 실습에서는 테스트 제외

2. Java 빌드 (프로그램 빌드) : Gradle을 통한 Java 빌드

./gradlew clean build

 

3. Docker 이미지 빌드: Docker를 통한 Docker Image 빌드

docker build -t sanghyune/github-actions-demo .

 

 

Docker Image 빌드를 위해 필요한 Dockerfile은 아래와 같이 정의

• 앞서 Java 빌드 완료 후 생성 된 JAR 파일을 구동할 엔진 버전 명시 및 JAR 파일 넣어서 포장
  • = JAR 파일을 구동할 JDK 명시 및 JAR 파일 정의하여 Docker Image 빌드
    • JAR 파일을 구동할 엔진 버전 → Amazon Corretto 17 JdK 버전 명시
    • JAR 파일 → 앞서 만든 JAR 파일
    • 포장 → Docker Image 빌드

FROM amazoncorretto:17-alpine
ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar
ENTRYPOINT ["java","-jar","/app.jar"]

`--build-arg` 값을 설정하지 않았다면, ARG로 설정한 JAR_FILE에 설정한 기본 값 사용

• 참조 : `--build-arg` 값을 활용하고 싶다면 아래와 같이 적용 → 해당 실습에서는 따로 사용하지 않는다.

docker build --build-arg JAR_FILE=MOVED.jar -t sanghyune/github-actions-demo .

 

4. 빌드된 Docker Image 업로드를 위한 저장소 Registry로 사용하기 위한 Docker Hub에 로그인

 

 

5. Docker Hub에 앞서 빌드한 Docker Image 업로드 (Push)

 

3. 최종적으로 Github Actions 스크립트는 아래와 같이 정의한다.

name: Java CI with Gradle

# master 브랜치에 push, PR 이벤트 발생시 동작.
on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      # (1) 프로그램 빌드 (Java 빌드) 1) Java 및 Docker 빌드를 위한 환경 설정
      - uses: actions/checkout@v3
      - name: Set up JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'

      # (1) 프로그램 빌드 (Java 빌드) 2) Java 빌드를 위한 ./gradlew 파일 권한 변경
      - name: Run chmod to make gradlew executable
        run: chmod +x ./gradlew

      # (1) 프로그램 빌드 (Java 빌드) 3) Java 빌드
      - name: Spring Boot Build
        run: ./gradlew clean build

      # (2) Docker 이미지 빌드 1) DockerFile 을 기반으로 Docker Image 빌드
      - name: docker image build
        run: docker build -t ${{ secrets.DOCKERHUB_USERNAME }}/github-actions-demo .

      # (2) Docker 이미지 빌드 2) Docker Hub 에 Login
      - name: docker login
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_PW }}

      # (2) Docker 이미지 빌드 3) Docker Hub 에 빌드된 이미지 push
      - name: docker Hub push
        run: docker push ${{ secrets.DOCKERHUB_USERNAME }}/github-actions-demo

실제 프로젝트에서 적용한 화면

GIthub Action 스크립트는 직접 작성하거나, 작성하지않고 Github 홈페이지에서도 바로 설정이 가능하다

• 해당 프로젝트의 Github Repository → Actions → gradle 검색 → Java With Gradle Configure

• `script.yml` 파일 생성 및 수정

하지만, 위 Github Action 스크립트는 구동되지 않을 것이다. → 아래와 같은 값들이 채워지지 않았기 때문. → 보안상의 이유로 민감한 값들이 Github Action 스크립트에 그대로 입력되어있으면 아무나 읽고 탈취가 가능하다. 따라서 값을 따로 설정해줘야한다.

• `${{ secrets.DOCKERHUB_USERNAME }}
• `${{ secrets.DOCKERHUB_PW }}

 

해결 방법

• Docker Hub 회원가입 후 My Profile에서 Security에 Access Token을 생성한다 
  • 필자는 이미 생성되어있어서 예전에 메모해둔 Access Token을 넣어줄 예정이다.(AccessToken의 PW는 생성 당시에만 확인할 수 있어서 필히 다른 곳에 적어두자 !)

• 그 다음 Dockerub 회원가입 및 발행한 Access Token을 Github 프로젝트 설정에 주입한다.
  • GitHub 프로젝트에서 Settings → Security → Secrets and Variable → Actions

• New repository secret 클릭 

• DOCKERHUB_USERNAME에 Docker Hub의 유저네임을 입력해준다.

• DOCKERHUB_PW에 아까 복사해둔 Access Token 값을 붙여넣는다.

모든 설정이 끝나면 해당 `main` 브랜치에 아무거나 Git Push를 수행하면 Github Action이 동작된다.

• Git Push 하면

• 위처럼 자동으로 Github Action이 가동되고

• 성공적으로 실행되는 것을 볼 수 있다 ! 👏

• Github Action이 정상적으로 성공됐다면, Docker Hub 내 저장소에서도 업로드가 잘 되어있는 것을 확인할 수 있다.

---

다음 포스팅은 이어서 AWS EC2 생성 후, 내부접속하여 CI로 만든 Docker 이미지를 실행하는 과정을 포스팅할 예정이다.

 

ℹ️ 참고

[ASAC 6기 강의자료]

https://www.daleseo.com/dockerfile/

Dockerfile에서 자주 쓰이는 명령어