마이크로서비스 레인보우 럼퍼스

1. 소개

최종 업데이트: 2021년 5월 6일

마이크로서비스 Rainbow Rumpus

이동하면서 다른 사람에게 장난스럽게 눈덩이를 던지는 눈싸움을 해본 적이 있나요? 아직 사용해 보지 않았다면 언젠가 사용해 보세요. 하지만 이제 물리적으로 맞을 위험을 감수하는 대신 다른 마이크로서비스와 장대한 전투에 참여하여 눈덩이 대신 무지개를 던지는 작고 네트워크에 액세스할 수 있는 서비스 (마이크로서비스)를 구축할 수 있습니다.

다음과 같은 궁금증이 있을 수 있습니다. 하지만 마이크로서비스가 다른 마이크로서비스에 무지개를 '던지는' 방법은 무엇일까요? 마이크로 서비스는 네트워크 요청 (일반적으로 HTTP를 통해)을 수신하고 응답을 반환할 수 있습니다. 아레나의 현재 상태를 마이크로서비스에 전송하는 '아레나 관리자'가 있으며, 마이크로서비스는 수행할 작업을 지정하는 명령어로 응답합니다.

물론 목표는 승리하는 것이지만 그 과정에서 Google Cloud에서 마이크로서비스를 빌드하고 배포하는 방법을 배우게 됩니다.

작동 방식

원하는 기술로 마이크로서비스를 빌드하거나 Go, Java, Kotlin, Scala, NodeJS, Python 스타터 중에서 선택한 후 Google Cloud에 마이크로서비스를 배포합니다. 배포가 완료되면 마이크로서비스의 URL을 알려주세요. 그러면 Google에서 아레나에 추가해 드립니다.

아레나에는 특정 전투의 모든 플레이어가 포함됩니다. Rainbow Rumpus에는 자체 경기장이 있습니다. 각 플레이어는 이동하며 다른 플레이어에게 무지개를 던지는 마이크로서비스를 나타냅니다.

아레나 관리자는 1초에 한 번씩 마이크로서비스를 호출하여 현재 아레나 상태 (플레이어가 있는 위치)를 전송하고, 마이크로서비스는 수행할 작업에 대한 명령어로 응답합니다. 아레나에서 앞으로 이동하거나, 왼쪽이나 오른쪽으로 회전하거나, 무지개를 던질 수 있습니다. 무지개는 플레이어가 향하는 방향으로 최대 3칸 이동합니다. 무지개가 다른 플레이어에게 '맞으면' 던진 플레이어는 1점을 얻고 맞은 플레이어는 1점을 잃습니다. 아레나 크기는 현재 플레이어 수에 따라 자동으로 조정됩니다.

이전 아레나의 모습은 다음과 같습니다.

20628e6bd442bd11.png

예시 배틀 1 경기장

회전하는 충돌

아레나에서는 여러 플레이어가 충돌하는 작업을 시도할 수 있습니다. 예를 들어 두 플레이어가 동일한 공간으로 이동하려고 할 수 있습니다. 충돌이 발생하면 응답 시간이 가장 빠른 마이크로서비스가 우선합니다.

전투 시청하기

전투에서 마이크로서비스의 실적을 확인하려면 라이브 경기장을 확인하세요.

Battle API

아레나 관리자를 사용하려면 마이크로서비스가 아레나에 참여할 수 있도록 특정 API를 구현해야 합니다. 아레나 관리자는 다음 JSON 구조를 사용하여 HTTP POST로 현재 아레나 상태를 제공된 URL로 전송합니다.

{
  "_links": {
    "self": {
      "href": "https://YOUR_SERVICE_URL"
    }
  },
  "arena": {
    "dims": [4,3], // width, height
    "state": {
      "https://A_PLAYERS_URL": {
        "x": 0, // zero-based x position, where 0 = left
        "y": 0, // zero-based y position, where 0 = top
        "direction": "N", // N = North, W = West, S = South, E = East
        "wasHit": false,
        "score": 0
      }
      ... // also you and the other players
    }
  }
}

HTTP 응답은 다음 이동을 포함하는 응답 본문과 함께 상태 코드 200 (OK)이어야 하며, 다음 이동은 다음 중 하나의 단일 대문자로 인코딩됩니다.

F <- move Forward
R <- turn Right
L <- turn Left
T <- Throw

다음은 마이크로서비스 및 기타 애플리케이션을 실행하는 Google Cloud 서비스인 Cloud Run에 마이크로서비스를 배포하는 방법을 살펴보겠습니다.

2. Google Cloud에 로그인합니다.

Cloud Run에 마이크로서비스를 배포하려면 Google Cloud에 로그인해야 합니다. 계정에 크레딧이 적용되므로 신용카드를 입력하지 않아도 됩니다. G Suite 관리자가 사용자의 특정 Google Cloud 기능 사용을 차단하는 경우가 있으므로 G Suite 계정 대신 개인 계정 (예: gmail.com)을 사용하는 것이 일반적으로 문제가 적습니다. 또한 사용할 웹 콘솔은 Chrome 또는 Firefox와 잘 작동하지만 Safari에서는 문제가 발생할 수 있습니다.

3. 마이크로서비스 배포

공개적으로 연결 가능하고 Battle API를 준수하는 한 어떤 기술로든 마이크로서비스를 빌드하고 어디에나 배포할 수 있습니다. 하지만 쉽게 시작할 수 있도록 샘플 서비스에서 시작하여 Cloud Run에 배포하는 방법을 안내해 드리겠습니다.

시작할 샘플 선택

다양한 배틀 마이크로서비스 샘플을 시작할 수 있습니다.

Kotlin 및 Spring Boot

소스

Kotlin 및 Micronaut

소스

Kotlin 및 Quarkus

소스

Java 및 Spring Boot

소스

Java 및 Quarkus

소스

Go

소스

Node.js 및 Express

소스

Python 및 Flask

소스

시작할 샘플을 결정한 후 위의 'Cloud Run에 배포' 버튼을 클릭합니다. 그러면 소스가 클론되는 Cloud Shell (클라우드에 있는 가상 머신에 대한 웹 기반 콘솔)이 실행되고, 소스가 배포 가능한 패키지 (Docker 컨테이너 이미지)로 빌드된 후 Google Container Registry에 업로드되고 Cloud Run에 배포됩니다.

메시지가 표시되면 us-central1 리전을 지정합니다.

아래 스크린샷은 마이크로서비스 빌드 및 배포를 위한 Cloud Shell 출력을 보여줍니다.

d88e40430706a32b.png

마이크로서비스가 작동하는지 확인하기

Cloud Shell에서 새로 배포된 마이크로서비스에 요청할 수 있습니다. YOUR_SERVICE_URL를 서비스 URL로 바꿉니다 (서비스 URL은 'Your application is now live here' 줄 뒤에 Cloud Shell에 있음).

curl -d '{
  "_links": {
    "self": {
      "href": "https://foo.com"
    }
  },
  "arena": {
    "dims": [4,3],
    "state": {
      "https://foo.com": {
        "x": 0,
        "y": 0,
        "direction": "N",
        "wasHit": false,
        "score": 0
      }
    }
  }
}' -H "Content-Type: application/json" -X POST -w "\n" \
  https://YOUR_SERVICE_URL

F, L, R 또는 T의 응답 문자열이 표시됩니다.

4. 아레나 포함 요청

Rainbow Rumpus에 참여하려면 경기장에 참여해야 합니다. rainbowrumpus.dev를 열고 마이크로서비스 URL을 제공할 경기장에서 참여를 클릭합니다.

5. 변경사항 적용 및 배포

변경하려면 사용한 GCP 프로젝트와 샘플에 관한 정보를 Cloud Shell에 설정해야 합니다. 먼저 GCP 프로젝트를 나열합니다.

gcloud projects list

프로젝트가 하나만 있을 가능성이 높습니다. 첫 번째 열에서 PROJECT_ID를 복사하여 다음 명령어에 붙여넣습니다 (YOUR_PROJECT_ID를 실제 프로젝트 ID로 대체). 이렇게 하면 나중에 명령어에서 사용할 환경 변수가 설정됩니다.

export PROJECT_ID=YOUR_PROJECT_ID

이제 사용한 샘플의 다른 환경 변수를 설정하여 이후 명령어에서 올바른 디렉터리와 서비스 이름을 지정할 수 있습니다.

# Copy and paste ONLY ONE of these
export SAMPLE=kotlin-micronaut
export SAMPLE=kotlin-quarkus
export SAMPLE=kotlin-springboot
export SAMPLE=java-quarkus
export SAMPLE=java-springboot
export SAMPLE=go
export SAMPLE=nodejs
export SAMPLE=python

이제 Cloud Shell에서 마이크로서비스의 소스를 수정할 수 있습니다. Cloud Shell 웹 기반 편집기를 열려면 다음 명령어를 실행합니다.

cloudshell edit cloudbowl-microservice-game/samples/$SAMPLE/README.md

그러면 변경사항을 적용하기 위한 추가 안내가 표시됩니다.

f910c9ef7b51c406.png

샘플 프로젝트가 열린 편집기가 있는 Cloud Shell

변경사항을 저장한 후 README.md 파일의 명령어를 사용하여 Cloud Shell에서 애플리케이션을 시작합니다. 먼저 Cloud Shell에서 올바른 샘플 디렉터리에 있는지 확인하세요.

cd cloudbowl-microservice-game/samples/$SAMPLE

애플리케이션이 실행되면 새 Cloud Shell 탭을 열고 curl을 사용하여 서비스를 테스트합니다.

curl -d '{
  "_links": {
    "self": {
      "href": "https://foo.com"
    }
  },
  "arena": {
    "dims": [4,3],
    "state": {
      "https://foo.com": {
        "x": 0,
        "y": 0,
        "direction": "N",
        "wasHit": false,
        "score": 0
      }
    }
  }
}' -H "Content-Type: application/json" -X POST -w "\n" \
  http://localhost:8080

변경사항을 배포할 준비가 되면 pack 명령어를 사용하여 Cloud Shell에서 프로젝트를 빌드합니다. 이 명령어는 빌드팩을 사용하여 프로젝트 유형을 감지하고, 컴파일하고, 배포 가능한 아티팩트 (Docker 컨테이너 이미지)를 만듭니다.

# Make sure you are in a Cloud Shell tab where you set the PROJECT_ID
# and SAMPLE env vars. Otherwise, set them again.
pack build gcr.io/$PROJECT_ID/$SAMPLE \
  --path ~/cloudbowl-microservice-game/samples/$SAMPLE \
  --builder gcr.io/buildpacks/builder

컨테이너 이미지가 생성되었으므로 Cloud Run에서 액세스할 수 있도록 Cloud Shell에서 docker 명령어를 사용하여 컨테이너 이미지를 Google Container Registry에 푸시합니다.

docker push gcr.io/$PROJECT_ID/$SAMPLE

이제 Cloud Run에 새 버전을 배포합니다.

gcloud run deploy $SAMPLE \
          --project=$PROJECT_ID \
          --platform=managed \
          --region=us-central1 \
          --image=gcr.io/$PROJECT_ID/$SAMPLE \
          --allow-unauthenticated

이제 경기장에서 새 버전을 사용합니다.

6. 로컬로 개발 (선택사항)

다음 단계에 따라 자체 IDE를 사용하여 로컬에서 프로젝트를 작업할 수 있습니다.

  1. [Cloud Shell에서] 샘플을 압축합니다.
# Make sure the SAMPLE env var is still set. If not, re-set it.
cd ~/cloudbowl-microservice-game/samples
zip -r cloudbowl-sample.zip $SAMPLE
  1. [Cloud Shell에서] zip 파일을 머신에 다운로드합니다.
cloudshell download-file cloudbowl-sample.zip
  1. [컴퓨터에서] 파일의 압축을 풀고 변경사항을 적용하고 테스트합니다.
  2. [머신에서] gcloud CLI 설치
  3. [컴퓨터에서] Google Cloud에 로그인합니다.
gcloud auth login
  1. [머신에서] 환경 변수 PROJECT_ID 및 SAMPLE을 Cloud Shell과 동일한 값으로 설정합니다.
  2. [머신에서] Cloud Build를 사용하여 컨테이너를 빌드합니다 (루트 프로젝트 디렉터리에서).
gcloud alpha builds submit . \
  --pack=image=gcr.io/$PROJECT_ID/$SAMPLE \
  --project=$PROJECT_ID
  1. [머신에서] 새 컨테이너를 배포합니다.
gcloud run deploy $SAMPLE \
  --project=$PROJECT_ID \
  --platform=managed \
  --region=us-central1 \
  --image=gcr.io/$PROJECT_ID/$SAMPLE \
  --allow-unauthenticated

7. 지속적 배포

SCM 설정

팀과 마이크로서비스에 대해 공동작업할 수 있도록 GitHub를 설정합니다.

  1. GitHub에 로그인
  2. 새 저장소 만들기
  3. 로컬 머신에서 작업하는 경우 git 명령줄 인터페이스 (CLI) 또는 GitHub Desktop GUI 애플리케이션 (Windows 또는 Mac)을 사용할 수 있습니다. Cloud Shell을 사용하는 경우 git CLI를 사용해야 합니다. GitHub에서 마이크로서비스의 코드를 가져오려면 CLI 또는 GitHub Desktop 안내를 따르세요.

git CLI로 코드 푸시

  1. 개인 액세스 토큰을 사용하여 HTTPS를 통해 Git 사용 안내를 따릅니다.
  2. '저장소' 범위를 선택합니다.
  3. git을 설정합니다.
git config --global credential.helper \
  'cache --timeout=172800'
git config --global push.default current
git config --global user.email "YOUR@EMAIL"
git config --global user.name "YOUR NAME"
  1. GitHub 조직 및 저장소의 환경 변수 설정 (https://github.com/ORG/REPO)
export GITHUB_ORG=YOUR_GITHUB_ORG
export GITHUB_REPO=YOUR_GITHUB_REPO
  1. 새 저장소에 코드 푸시
# Make sure the SAMPLE env var is still set. If not, re-set it.
cd ~/cloudbowl-microservice-game/samples/$SAMPLE
git init
git add .
git commit -m init
git remote add origin https://github.com/$GITHUB_ORG/$GITHUB_REPO.git
git branch -M main

# This will now ask for your GitHub username & password
# for the password use the personal access token
git push -u origin main
  1. 변경사항을 적용한 후 변경사항을 커밋하고 GitHub에 푸시할 수 있습니다.
git add .
git status
git diff --staged
git commit -am "my changes"
git push

GitHub 데스크톱으로 코드 푸시

  1. 이전 '로컬에서 개발' 실습의 안내에 따라 코드를 다운로드합니다.
  2. GitHub Desktop 설치, 실행, 로그인
  3. 새로 만든 저장소 클론

cf7f38c7c86a91cd.png

  1. 파일 탐색기를 열고 프로젝트를 새 저장소에 복사합니다.
  2. 변경사항 커밋

5f3c1552e30ad7c5.png

  1. 기본 브랜치를 GitHub에 게시

Cloud Run 지속적 배포 설정

GitHub에서 SCM을 설정했으므로 이제 새 커밋이 main 브랜치에 푸시될 때마다 Cloud Build가 변경사항을 자동으로 빌드하고 배포하도록 지속적 배포를 설정할 수 있습니다. 배포 전에 테스트를 실행하는 지속적 통합을 추가할 수도 있지만 기본 샘플에는 테스트가 포함되어 있지 않으므로 이 단계는 연습으로 남겨 두었습니다.

  1. Cloud 콘솔에서 Cloud Run 서비스로 이동합니다.
  2. '지속적 배포 설정' 버튼을 클릭합니다.
  3. GitHub로 인증하고 마이크로서비스의 저장소 선택

a3b5692f178869bc.png

  1. GitHub 저장소를 선택하고 브랜치를 ^main$로 설정합니다.

338f1c00f33d2f65.png

  1. 빌드 유형을 빌드팩 사용으로 설정
  2. '저장'을 클릭하여 지속적 배포를 설정합니다.

8. 관측 가능성

문제가 발생합니다. 관측 가능성을 통해 이러한 상황이 언제 발생하는지 파악하고 그 이유를 진단할 수 있습니다. 측정항목은 서비스의 상태와 사용량에 관한 데이터를 보여줍니다. 로그에는 서비스에서 수동으로 계측된 정보가 표시됩니다. 문제가 발생하면 알림을 통해 알 수 있습니다. 각각 자세히 살펴보겠습니다.

측정항목

  1. Cloud Run 서비스 목록에서 서비스를 찾습니다.
  2. 서비스 이름을 클릭하여 측정항목 대시보드로 이동합니다.

8491b8ec6bc5b4db.png

  1. 측정항목의 ⋮ 메뉴를 클릭한 다음 '측정항목 탐색기에서 보기'를 선택합니다.
  2. 이제 리소스 측정항목, 필터, 그룹화 및 기타 옵션을 변경할 수 있습니다. 예를 들어 모든 서비스의 평균 서비스 지연 시간을 볼 수 있습니다.

f0d666d8f4221d45.png

로그

서비스의 STDOUT 출력은 Google Cloud Logging 시스템으로 전송됩니다. Cloud Run 서비스 관리 페이지에서 다음과 같은 기본 로그 보기에 액세스할 수 있습니다.

40058a82c9299cff.png

Cloud Run 로그에서 심각도별로 필터링하고 로그를 필터링할 수 있습니다. 유연성을 높이려면 다음을 클릭하세요. 186fdb0e6d39a6ca.png

알림

  1. 서비스의 상태 점검 URL을 만듭니다.
  2. Spring Boot의 경우 다음 종속 항목을 추가하면 됩니다.
org.springframework.boot:spring-boot-starter-actuator
  1. src/main/resources/application.properties를 만들거나 업데이트하고 디스크 공간 확인을 사용 중지합니다.
management.health.diskspace.enabled=false
  1. 프로토콜, 호스트 이름, 경로를 지정하여 업타임 알림을 만듭니다. Spring Boot의 경우 경로는 /actuator/health입니다.
  2. 알림 테스트

6948d13b263bf573.png

  1. 알림 만들기

9. 축하합니다

수고하셨습니다. 다른 마이크로서비스와 대결할 수 있는 마이크로서비스를 빌드하고 배포했습니다. 행운을 빕니다!

참조 문서