Github Action 으로 GKE 에 Spring Boot 애플리케이션 배포하기

들어가며

요즘 하고있는 사이드 프로젝트에 배포환경을 구성하면서 Github Action 을 처음 사용해보았다. 이제 간단한 프로젝트에 따로 jenkins 를 만들어 올릴 필요가 없겠구나 하는 감탄이 나올만큼 편리하고, 많은 integration 들을 준비해두어 놀라웠다.

그렇지만 내가 찾지 못한건지.. 단순히 따라하면 뚝딱 되는 Getting Start 가 없어, 약 세시간 가량 삽질을 했고 다음에 똑같은 삽질을 하지 않기위해 Github Action을 통해 GKE에 Spring Boot 애플리케이션을 배포하는 방법은 간단히 남겨두려 한다.

준비

우선 당연하게도 배포할 스프링 부트 애플리케이션이 필요하다. 간단히 spring initializer 를 통해 스프링 부트 애플리케이션을 만들었다.

예제의 코드는 다음 레파지토리 를 참고한다.

또한 GCP 에도 프로젝트가 생성되어 있어야 한다.

그리고 로컬에 Docker 가 설치되어 있다고 가정한다.

Containerize

컨테이너에 올릴 애플리케이션 이미지를 Containerize 해보자.

1. Dockerfile 생성

프로젝트 루트에 Dockerfile 파일을 만들고 다음과 같이 수정한다.

FROM openjdk:8-jdk-alpine

# root 권한으로 실행되지 않도록 사용자 그룹 추가.
RUN addgroup -S spring && adduser -S spring -G spring
USER spring:spring

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

gradle 을 사용할 경우를 기준으로 작성되었다. 만약 maven 을 사용중이라면 ARG JAR_FILE=build/libs/*.jar 대신 ARG JAR_FILE=target/*.jar 로 Dockerfile 을 생성하거나 빌드시 --build-arg JAR_FILE=target/*.jar 파라미터를 추가로 주도록 하자

자세한 내용은 레퍼런스 를 참고

2. 실행

이미지가 정상적으로 생성되었는지 확인하기 위해 로컬에서 실행시켜보자.

$ ./gradlew build
$ docker build -t demo .
$ docker run -p 8080:8080 demo

레지스터에 업로드

quickstart의 ‘시작하기 전에’’ 를 따라서 Container Registry 를 활성화하고 Cloud SDK 를 설치한다.

설치를 마쳤으면 cloud sdk 를 통해 인증을 하고 이미지에 태그를 지정하고 업로드한다.

$ gcloud auth configure-docker
# [PROJECT-ID] 에는 gcp 프로젝트의 id를 넣어준다. 프로젝트 id가 test 라면 gcr.io/test/demo 로 지정하면 된다.
$ docker tag demo gcr.io/[PROJECT-ID]/demo
# 레지스트리에 푸쉬
$ docker push gcr.io/[PROJECT-ID]/demo

Container Registry 에 접속해서 정상적으로 업로드 되었는지 확인한다.

gke 배포

gke (google-kubernetes-engine)에 배포하기 위해 deployment.yml 을 생성해주도록 하자.

$ kubectl create deployment demo --image=gcr.io/[PROJECT-ID]/demo --dry-run -o=yaml > deployment.yml

생성된 파일은 다음과 같다.

development.yml

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  creationTimestamp: null
  labels:
    app: demo
  name: demo
spec:
  replicas: 1
  selector:
    matchLabels:
      app: demo
  strategy: {}
  template:
    metadata:
      creationTimestamp: null
      labels:
        app: demo
    spec:
      containers:
      - image: gcr.io/[PROJECT-ID]/demo
        name: demo
        resources: {}
status: {}

배포 전략과 포트를 수정해주도록 하자

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  creationTimestamp: null
  labels:
    app: demo
  name: demo
spec:
  replicas: 1
  selector:
    matchLabels:
      app: demo
  strategy:
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
  template:
    metadata:
      creationTimestamp: null
      labels:
        app: demo
    spec:
      containers:
      - image: gcr.io/[PROJECT-ID]/demo
        name: demo
        resources: {}
        ports:
        - containerPort: 8080
status: {}

service/kustomization 설명 추가하기

Github Action

1. workflow 생성

상단에 네번째 Actions 클릭

Build and Deploy to GKE > Set up this workflow 클릭

2. workflow 정의

Set up this workflow 를 클릭하고 나면 기본적인 플로우가 정의되면 yaml 파일이 생성된다. 한 부분씩 살펴보도록 하자.

Event

on:
  release:
    types: [created]

github에 어떤 액션이 생겼을 때 workflow 를 실행시킬 것인지 정의하는 부분이다.

몇가지 유용하게 사용할 만한 액션들은 다음과 같다.

on:
  # 릴리즈 생성시
  release:
    types: [created]
  # develop 브랜치에 푸쉬 발생시
  push:
    branches:
      - develop
  # feature 이하 모든 브랜치, develop, master 브랜치에 PR이 생성됐을 경우
  pull_request:
    branches: [feature/**, develop, master]
  # 이슈 (PR을 포함하여)에 코멘트가 생성되었을 경우
  issue_comment:
    types: [created]
  # 이슈가 할당됐을 경우
  issues:
    types: [assigned]

사용가능한 전체 액션은 다음 레퍼런스를 참고한다.

Environment

다음은 Environment 이다. workflow 에서 사용할 환경 변수들을 정의할 수 있다.

또한 Settings > Secrets 에 등록해둔 private 한 정보들도 사용 가능하다.

Secrets 에서 GKE_PROJECT에는 콘솔에서 PROJECT-ID 를 확인하여 입력한뒤, IAM > 서비스 계정에서 깃헙 액션이 사용할 계정을 추가해주도록 하자.

깃헙 액션이 사용할 계정은 다음 두가지 권한을 반드시 포함하고 있어야 한다.

Kubernetes Engine Developer (Kubernetes Engine 개발자)
Storage Admin (저장소 관리자)

계정 생성 후 이 계정의 이메일을 GKE_EMAIL 로 Secrets에 등록하고, 우측 작업 에서 키 만들기 를 눌러 생성된 json 형식의 키를 GKE_KEY 로 Secrets 에 등록해주어야 한다.

Secrets 에 키를 모두 등록했다면 다음과 같이 총 세개의 키가 등록되어 있어야 한다.

자세한 내용은 다음 을 참고

env:
  GKE_PROJECT: $
  GKE_EMAIL: $
  GITHUB_SHA: $
  GKE_ZONE: us-central1-c
  GKE_CLUSTER: cluster-1
  IMAGE: demo
  REGISTRY_HOSTNAME: gcr.io
  DEPLOYMENT_NAME: demo

이후 $GKE_CLUSTER 와 같이 사용하면 된다.

# Set up kustomize
- name: Build
  run: |        
    docker build -t "$REGISTRY_HOSTNAME"/"$GKE_PROJECT"/"$IMAGE":"$GITHUB_SHA" \
      --build-arg GITHUB_SHA="$GITHUB_SHA" \
      --build-arg GITHUB_REF="$GITHUB_REF" .

Jobs

이후 실제 수행할 작업들의 목록인 Jobs 를 기술한다. 한단계씩 살펴보자

jobs:
  # 빌드 후 gke에 배포
  setup-build-publish-deploy:
    name: Setup, Build, Publish, and Deploy
    runs-on: ubuntu-latest
    # 순차적으로 실행되는 작업들의 집합인 steps
    steps:
    - name: Checkout
      # {owner}/{repo}@{ref} 로 사용할 수 있다.
      # 이 스텝의 경우 https://github.com/actions/checkout 의 v2를 사용하게 된다.
      uses: actions/checkout@v2

    # gcloud CLI 설치
    - uses: GoogleCloudPlatform/github-actions/setup-gcloud@master
      with:
        version: '270.0.0'
        service_account_email: $
        service_account_key: $

    # gcloud command-line tool 을 사용하여 사용자 인증
    - run: |
        # Set up docker to authenticate
        # via gcloud command-line tool.
        gcloud auth configure-docker

    # 그래들 빌드
    - name: Build Gradle
      run: |
        ./gradlew build

    # 도커 이미지 빌드
    - name: Build
      run: |        
        docker build -t "$REGISTRY_HOSTNAME"/"$GKE_PROJECT"/"$IMAGE":"$GITHUB_SHA" \
          --build-arg GITHUB_SHA="$GITHUB_SHA" \
          --build-arg GITHUB_REF="$GITHUB_REF" .

    # 도커 이미지 레지스트리에 배포
    - name: Publish
      run: |
        docker push $REGISTRY_HOSTNAME/$GKE_PROJECT/$IMAGE:$GITHUB_SHA

    # kustomize 설치
    - name: Set up Kustomize
      run: |
        curl -o kustomize --location https://github.com/kubernetes-sigs/kustomize/releases/download/v3.1.0/kustomize_3.1.0_linux_amd64
        chmod u+x ./kustomize

    # gke에 배포
    - name: Deploy
      run: |
        gcloud container clusters get-credentials $GKE_CLUSTER --zone $GKE_ZONE --project $GKE_PROJECT
        ./kustomize edit set image $REGISTRY_HOSTNAME/$GKE_PROJECT/$IMAGE:${GITHUB_SHA}
        ./kustomize build . | kubectl apply -f -
        kubectl rollout status deployment/$DEPLOYMENT_NAME
        kubectl get services -o wide

기존에 생성된 workflow 파일에 Build Gradle 스텝이 추가됐음에 유의한다.

전체 yaml 파일은 다음과 같다.

# This workflow will build a docker container, publish it to Google Container Registry, and deploy it to GKE when a release is created
#
# To configure this workflow:
#
# 1. Ensure that your repository contains the necessary configuration for your Google Kubernetes Engine cluster, including deployment.yml, kustomization.yml, service.yml, etc.
#
# 2. Set up secrets in your workspace: GKE_PROJECT with the name of the project, GKE_EMAIL with the service account email, GKE_KEY with the Base64 encoded JSON service account key (https://github.com/GoogleCloudPlatform/github-actions/tree/docs/service-account-key/setup-gcloud#inputs).
#
# 3. Change the values for the GKE_ZONE, GKE_CLUSTER, IMAGE, REGISTRY_HOSTNAME and DEPLOYMENT_NAME environment variables (below).

name: Build and Deploy to GKE

on:
  release:
    types: [created]

# Environment variables available to all jobs and steps in this workflow
env:
  GKE_PROJECT: $
  GKE_EMAIL: $
  GITHUB_SHA: $
  GKE_ZONE: us-central1-c
  GKE_CLUSTER: cluster-1
  IMAGE: demo
  REGISTRY_HOSTNAME: gcr.io
  DEPLOYMENT_NAME: demo

jobs:
  setup-build-publish-deploy:
    name: Setup, Build, Publish, and Deploy
    runs-on: ubuntu-latest
    steps:

    - name: Checkout
      uses: actions/checkout@v2

    # Setup gcloud CLI
    - uses: GoogleCloudPlatform/github-actions/setup-gcloud@master
      with:
        version: '270.0.0'
        service_account_email: $
        service_account_key: $

    # Configure docker to use the gcloud command-line tool as a credential helper
    - run: |
        # Set up docker to authenticate
        # via gcloud command-line tool.
        gcloud auth configure-docker

    # 그래들 빌드
    - name: Build Gradle
      run: |
        ./gradlew build

    # Build the Docker image
    - name: Build
      run: |        
        docker build -t "$REGISTRY_HOSTNAME"/"$GKE_PROJECT"/"$IMAGE":"$GITHUB_SHA" \
          --build-arg GITHUB_SHA="$GITHUB_SHA" \
          --build-arg GITHUB_REF="$GITHUB_REF" .

    # Push the Docker image to Google Container Registry
    - name: Publish
      run: |
        docker push $REGISTRY_HOSTNAME/$GKE_PROJECT/$IMAGE:$GITHUB_SHA

    # Set up kustomize
    - name: Set up Kustomize
      run: |
        curl -o kustomize --location https://github.com/kubernetes-sigs/kustomize/releases/download/v3.1.0/kustomize_3.1.0_linux_amd64
        chmod u+x ./kustomize

    # Deploy the Docker image to the GKE cluster
    - name: Deploy
      run: |
        gcloud container clusters get-credentials $GKE_CLUSTER --zone $GKE_ZONE --project $GKE_PROJECT
        ./kustomize edit set image $REGISTRY_HOSTNAME/$GKE_PROJECT/$IMAGE:${GITHUB_SHA}
        ./kustomize build . | kubectl apply -f -
        kubectl rollout status deployment/$DEPLOYMENT_NAME
        kubectl get services -o wide

마치며

릴리즈가 생성되면 github action을 통해 gke로 배포하는 워크플로우를 생성하는 과정은 간략하게 알아보았다. 간단한 프로젝트에 굳이 Jenkins 까지 붙일 필요 없이, 손쉽게 CI를 구성할 수 있다는게 큰 장점인것 같다.

현재 사이드프로젝트에서 PR이 생성되면 gradle, flutter 빌드가 깨지지 않았는지 체크하고, 머지되면 자동으로 개발서버에 배포하도록 구성하여 사용중이다. 빌드가 깨지면 머지가 불가능하도록 브랜치에 protection을 걸 수도 있다. 벤더/커뮤니티에서 프레임워크/언어에 맞는 Actions를 만들어서 제공중이니, 사용하는 기술에 적합한 Actions이 있는지 찾아보면 좋겠다. 없다면 만들어서 기여하는것도!

Written on May 18th, 2020 by genie-youn

글이 도움이 됐다면 하단 광고도 눌러주세요. 큰 힘이 됩니다