ESPv2를 사용하여 관리형 인스턴스 그룹을 위한 Cloud Endpoints gRPC 시작하기

OpenAPI | gRPC

이 튜토리얼에서는 관리형 인스턴스 그룹에서 Extensible Service Proxy V2(ESPv2)를 사용하여 간단한 예시 gRPC 서비스를 배포하는 방법을 보여줍니다.

이 튜토리얼에서는 Python 버전의 bookstore-grpc 샘플을 사용합니다. 다른 언어의 gRPC 샘플은 다음 단계 섹션을 참조하세요.

Cloud Endpoints 개요는 Endpoints 정보와 Endpoints 아키텍처를 참조하세요.

목표

아래의 개략적인 작업 목록을 사용하여 튜토리얼을 진행합니다. API에 요청을 보내려면 모든 작업을 수행해야 합니다.

Google Cloud 프로젝트를 설정하고 필요한 소프트웨어를 다운로드합니다. 시작하기 전에를 참조하세요.
bookstore-grpc 샘플에서 파일을 복사하고 구성합니다. Endpoints 구성을 참조하세요.
Endpoints 구성을 배포하여 Endpoints 서비스를 만듭니다. Endpoints 구성 배포를 참조하세요.
관리형 인스턴스 그룹 백엔드에 API 및 ESPv2를 배포합니다. API 백엔드 배포를 참조하세요.
API에 요청을 보냅니다. API에 요청 보내기를 참조하세요.
Google Cloud 계정에 요금이 청구되지 않도록 합니다. 삭제를 참조하세요.

비용

이 문서에서는 비용이 청구될 수 있는 다음과 같은 Google Cloud 구성요소를 사용합니다.

프로젝트 사용량을 기준으로 예상 비용을 산출하려면 가격 계산기를 사용하세요. Google Cloud를 처음 사용하는 사용자는 무료 체험판을 사용할 수 있습니다.

이 문서에 설명된 태스크를 완료했으면 만든 리소스를 삭제하여 청구가 계속되는 것을 방지할 수 있습니다. 자세한 내용은 삭제를 참조하세요.

시작하기 전에

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

나중에 필요하므로 프로젝트 ID를 기록해 둡니다.
Google Cloud CLI를 설치하고 초기화합니다.
gcloud CLI를 업데이트하고 Endpoints 구성요소를 설치합니다.
```
gcloud components update
```
Google Cloud CLI(gcloud)에 Google Cloud의 데이터 및 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.
```
gcloud auth login
```
새 브라우저 탭이 열리면 계정을 선택합니다.
기본 프로젝트를 프로젝트 ID로 설정합니다.
```
gcloud config set project YOUR_PROJECT_ID
```
YOUR_PROJECT_ID를 프로젝트 ID로 바꿉니다. 다른 Google Cloud 프로젝트가 있고, gcloud를 사용하여 이를 관리하려면 gcloud CLI 구성 관리를 참조하세요.
gRPC Python 빠른 시작의 단계를 따라 gRPC와 gRPC 도구를 설치합니다.

이 문서에 설명된 태스크를 완료했으면 만든 리소스를 삭제하여 청구가 계속되는 것을 방지할 수 있습니다. 자세한 내용은 삭제를 참조하세요.

Endpoints 구성

GitHub에서 bookstore-grpc 샘플 저장소를 클론합니다.

Endpoints를 구성하려면 다음 안내를 따르세요.

서비스 .proto.파일에서 독립적인 protobuf 설명자 파일을 만듭니다.
1. 예시 저장소의 bookstore.proto 사본을 저장합니다. 이 파일은 Bookstore 서비스의 API를 정의합니다.
2. mkdir generated_pb2 디렉터리를 만듭니다.
3. protoc 프로토콜 버퍼 컴파일러를 사용하여 설명자 파일 api_descriptor.pb를 만듭니다. bookstore.proto를 저장한 디렉터리에서 다음 명령어를 실행합니다.
```
python -m grpc_tools.protoc \
    --include_imports \
    --include_source_info \
    --proto_path=. \
    --descriptor_set_out=api_descriptor.pb \
    --python_out=generated_pb2 \
    --grpc_python_out=generated_pb2 \
    bookstore.proto
```
  앞의 명령어에서 --proto_path는 현재 작업 디렉터리로 설정됩니다. gRPC 빌드 환경에서 .proto 입력 파일에 다른 디렉터리를 사용할 경우 컴파일러가 bookstore.proto 파일이 저장된 디렉터리를 검색하도록 --proto_path를 변경합니다.
다음 단계에 따라 gRPC API 구성 YAML 파일을 만듭니다.
1. api_config.yaml 파일의 사본을 저장합니다. 이 파일은 Bookstore 서비스에 대한 gRPC API 구성을 정의합니다.
2. api_config.yaml 파일의 MY_PROJECT_ID를 Google Cloud 프로젝트 ID로 바꿉니다. 예를 들면 다음과 같습니다.
```
#
# Name of the service configuration.
#
name: bookstore.endpoints.example-project-12345.cloud.goog
```
  참고로 이 파일의 apis.name 필드 값은 .proto 파일의 정규화된 API 이름과 정확히 일치하며, 그렇지 않은 경우 배포가 작동하지 않습니다. Bookstore 서비스는 endpoints.examples.bookstore 패키지 내의 bookstore.proto에 정의되어 있습니다. 정규화된 API 이름은 api_config.yaml 파일에 나타난 것과 같이 endpoints.examples.bookstore.Bookstore입니다.
```
apis:
  - name: endpoints.examples.bookstore.Bookstore
```

자세한 내용은 Endpoints 구성을 참조하세요.

Endpoints 구성 배포

Endpoints 구성을 배포하려면 gcloud endpoints services deploy 명령어를 사용합니다. 이 명령어는 Service Management를 사용하여 관리형 서비스를 만듭니다.

현재 위치가 api_descriptor.pb 및 api_config.yaml 파일이 있는 디렉터리인지 확인합니다.
gcloud 명령줄 도구에 현재 사용 중인 기본 프로젝트가 Endpoints 구성을 배포하려는 Google Cloud 프로젝트인지 확인합니다. 잘못된 프로젝트에 서비스가 만들어지지 않도록 다음 명령어로 반환되는 프로젝트 ID를 확인합니다.
```
gcloud config list project
```
기본 프로젝트를 변경해야 하는 경우 다음 명령어를 실행합니다.
```
gcloud config set project YOUR_PROJECT_ID
```
Google Cloud CLI를 사용하여 proto descriptor 파일 및 구성 파일을 배포합니다.
```
gcloud endpoints services deploy api_descriptor.pb api_config.yaml
```
Service Management에서 서비스를 만들고 구성하면서 터미널에 정보를 출력합니다. 배포가 완료되면 다음과 유사한 메시지가 표시됩니다.
```
Service Configuration [CONFIG_ID] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
```
CONFIG_ID는 배포 시 만들어진 고유한 Endpoints 서비스 구성 ID입니다. 예를 들면 다음과 같습니다.
```
Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
```
이전 예시에서 2017-02-13r0은 서비스 구성 ID이고 bookstore.endpoints.example-project.cloud.goog는 서비스 이름입니다. 서비스 구성 ID는 날짜 스탬프와 버전 번호로 구성됩니다. 같은 날짜에 Endpoints 구성을 다시 배포하면 서비스 구성 ID에서 버전 번호가 증가합니다.

필수 서비스 확인

Endpoints와 ESP를 사용하려면 최소한 다음 Google 서비스를 사용 설정해야 합니다.

이름	제목
`servicemanagement.googleapis.com`	Service Management API
`servicecontrol.googleapis.com`	Service Control API
`endpoints.googleapis.com`	Google Cloud Endpoints

대부분의 경우 gcloud endpoints services deploy 명령어를 사용하여 이러한 필수 서비스를 사용 설정할 수 있습니다. 하지만 다음과 같은 경우에는 gcloud 명령어가 성공적으로 완료되더라도 필수 서비스가 사용 설정되지 않습니다.

Terraform과 같은 타사 애플리케이션을 사용하고 이러한 서비스를 포함하지 않은 경우
이러한 서비스가 명시적으로 중지된 기존 Google Cloud 프로젝트에 Endpoints 구성을 배포한 경우

다음 명령어를 사용하여 필수 서비스가 사용 설정되어 있는지 확인합니다.

gcloud services list

필수 서비스가 나열되지 않으면 서비스를 사용 설정하세요.

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Endpoints 서비스도 사용 설정해야 합니다.

gcloud services enable ENDPOINTS_SERVICE_NAME

ENDPOINTS_SERVICE_NAME을 확인하려면 다음 중 하나를 수행합니다.

Endpoints 구성을 배포한 후 Cloud 콘솔의 Endpoints 페이지로 이동합니다. 가능한 ENDPOINTS_SERVICE_NAME 목록이 서비스 이름 열 아래에 표시됩니다.
OpenAPI의 경우 ENDPOINTS_SERVICE_NAME은 OpenAPI 사양의 host 필드에 지정한 항목입니다. gRPC의 경우 ENDPOINTS_SERVICE_NAME은 gRPC 엔드포인트 구성의 name 필드에 지정한 항목입니다.

gcloud 명령어에 대한 자세한 내용은 gcloud 서비스를 참조하세요.

오류 메시지가 나타나면 Endpoints 구성 배포 문제해결을 참조하세요. 자세한 내용은 Endpoints 구성 배포를 참조하세요.

API 백엔드 배포

지금까지 API 구성을 Service Management에 배포했지만 아직 API 백엔드를 제공할 코드를 배포하지 않았습니다. 이 섹션에서는 관리형 인스턴스 그룹에 Docker를 설정하고 API 백엔드 코드와 ESPv2를 Docker 컨테이너에서 실행하는 방법을 단계별로 안내합니다.

인스턴스 템플릿 만들기

VM 인스턴스 그룹을 만드는 데 사용할 템플릿을 만듭니다. 템플릿에서 생성된 각 인스턴스가 ESPv2 및 백엔드 애플리케이션 서버를 시작합니다.

Google Cloud 콘솔에서 인스턴스 템플릿 페이지로 이동합니다.

인스턴스 템플릿으로 이동
인스턴스 템플릿 만들기를 클릭합니다.
이름에 load-balancing-espv2-template을 입력합니다.
머신 구성에서 머신 유형을 e2-micro로 설정합니다.
부팅 디스크에서 이미지를 Container Optimized OS stable version로 설정합니다.
방화벽에서 HTTP 트래픽 허용을 선택합니다.
관리, 보안, 디스크, 네트워킹, 단독 테넌시를 클릭하여 고급 설정을 표시합니다.

관리 탭을 클릭합니다. 자동화에서 다음 시작 스크립트를 입력합니다. ENDPOINTS_SERVICE_NAME을 업데이트해야 합니다.

sudo docker network create --driver bridge esp_net
sudo docker run \
  --detach \
  --name=bookstore \
  --net=esp_net \
  gcr.io/endpointsv2/python-grpc-bookstore-server:1
sudo docker run \
  --detach \
  --name=esp \
  --publish=80:9000 \
  --net=esp_net \
  gcr.io/endpoints-release/endpoints-runtime:2 \
  --service=ENDPOINTS_SERVICE_NAME \
  --rollout_strategy=managed \
  --listener_port=9000 \
  --healthz=/healthz \
  --backend=grpc://bookstore:8000

인스턴스 시작 시 스크립트가 에코 애플리케이션 서버 및 ESPv2 프록시 서버를 가져오고, 설치, 시작합니다.

만들기를 클릭합니다.

계속하기 전 템플릿이 생성될 때까지 기다립니다.

리전 관리형 인스턴스 그룹 만들기

애플리케이션을 실행하기 위해 인스턴스 템플릿을 사용하여 리전 관리형 인스턴스 그룹을 만듭니다.

Google Cloud 콘솔에서 인스턴스 그룹 페이지로 이동합니다.

인스턴스 그룹으로 이동
인스턴스 그룹 만들기를 클릭합니다.
이름에 load-balancing-espv2-group을 입력합니다.
위치에서 다중 영역을 선택합니다.

프로 팁: 영역 장애와 같은 심각한 상황에서도 애플리케이션의 가용성을 보장하기 위해 Compute Engine에서는 여러 영역에 걸쳐 애플리케이션을 분산할 것을 권장합니다.
리전에서 us-central1을 선택합니다.
영역 구성 드롭다운 메뉴를 클릭하여 영역을 표시합니다. 다음 영역을 선택합니다.
- us-central1-b
- us-central1-c
- us-central1-f
인스턴스 템플릿에서 load-balancing-espv2-template을 선택합니다.
자동 확장에서 자동 확장 안함을 선택합니다.
인스턴스 수를 3로 설정합니다.

프로 팁: 리전 관리형 인스턴스 그룹을 만드는 경우 Compute Engine은 어느 한 영역의 인스턴스 전부를 사용할 수 없게 되더라도 나머지 인스턴스로 필요한 최소 인스턴스 수가 충족되도록 인스턴스를 충분히 프로비저닝할 것을 권장합니다. 그러나 필요 이상의 인스턴스를 프로비저닝하는 경우 부가적인 비용이 발생할 수 있습니다. 자세한 내용은 가용성을 보장하기 위한 인스턴스 그룹 크기 선택을 참조하세요.
인스턴스 재배포에서 켜기를 선택합니다.
자동 복구 및 상태 확인에서 상태 확인 없음을 선택합니다.
만들기를 클릭합니다. 인스턴스 그룹 페이지로 리디렉션됩니다.

참고: 그룹의 모든 인스턴스가 실행되고 웹 애플리케이션을 표시할 준비가 될 때까지 몇 분 정도 기다려야 할 수 있습니다.

부하 분산기 만들기

이 섹션에서는 TCP 트래픽을 인스턴스 그룹으로 전달하는 리전 부하 분산기를 만들기 위한 단계를 설명합니다.

Google Cloud Console에서 부하 분산기 만들기 페이지로 이동합니다.

부하 분산기 만들기로 이동
TCP 부하 분산에서 구성 시작을 클릭합니다.
인터넷 연결 또는 내부 전용 에서 인터넷 트래픽을 VM으로 분산을 선택합니다.
여러 리전 또는 단일 리전에서 단일 리전만을 선택합니다.
백엔드 유형에서 백엔드 서비스를 선택합니다.
계속을 클릭합니다.
이름에 espv2-load-balancer를 입력합니다.
백엔드 구성에서 us-central1 리전을 선택합니다.
인스턴스 그룹 load-balancing-espv2-group를 선택합니다.
상태 확인에서 새 상태 확인을 만듭니다.
- 이름에 espv2-load-balancer-check를 입력합니다.
- 프로토콜이 TCP이고 포트가 80인지 확인합니다.
프런트엔드 구성에서 포트 번호 80을 입력합니다.
검토 및 완료에서 다음을 확인합니다.
- 인스턴스 그룹이 load-balancing-espv2-group입니다.
- 리전은 us-central1입니다.
- 프로토콜은 TCP입니다.
- IP:포트는 EPHEMERAL:80입니다.
부하 분산기가 생성된 후 부하 분산기 페이지에서 IP 주소를 찾습니다.

부하 분산기로 이동

API에 요청 보내기

Docker 컨테이너가 실행되는 동일 인스턴스에서 요청을 보낼 경우 SERVER_IP를 localhost로 바꿀 수 있습니다. 그렇지 않으면 SERVER_IP를 인스턴스의 외부 IP로 바꿉니다.

다음을 실행하면 외부 IP 주소를 찾을 수 있습니다.

gcloud compute instances list

샘플 API에 요청을 전송하려면 Python으로 작성된 샘플 gRPC 클라이언트를 사용할 수 있습니다.

gRPC 클라이언트 코드가 호스팅된 git 저장소를 복제합니다.

git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

작업 디렉토리를 다음과 같이 변경합니다.
```
cd python-docs-samples/endpoints/bookstore-grpc/
  
```

종속 항목을 설치합니다.

pip install virtualenv
virtualenv env
source env/bin/activate
python -m pip install -r requirements.txt

샘플 API로 요청을 전송합니다.
```
python bookstore_client.py --host SERVER_IP --port 80
```
- Endpoints > 서비스 페이지에서 API의 활동 그래프를 봅니다.
  
  Endpoints 서비스 페이지로 이동
  
  요청이 그래프에 반영되는 데 잠시 시간이 걸릴 수 있습니다.
- 로그 탐색기 페이지에서 API의 요청 로그를 봅니다.
  
  로그 탐색기 페이지로 이동

성공 응답을 받지 못하면 응답 오류 문제해결을 참조하세요.

Endpoints에 API를 배포하고 테스트했습니다.

삭제

이 튜토리얼에서 사용된 리소스 비용이 Google Cloud 계정에 청구되지 않도록 하려면 리소스가 포함된 프로젝트를 삭제하거나 프로젝트를 유지하고 개별 리소스를 삭제하세요.

gcloud CLI(gcloud)에 Google Cloud의 데이터 및 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.
```
gcloud auth login
```
다음을 입력하여 Google Cloud 프로젝트의 프로젝트 ID를 표시합니다.
```
gcloud projects list
```
이전 단계의 해당 프로젝트 ID를 사용하여 기본 Google Cloud 프로젝트를 애플리케이션이 있는 프로젝트로 설정합니다.
```
gcloud config set project [YOUR_PROJECT_ID]
```
Google Cloud 프로젝트에서 모든 관리형 서비스의 이름을 가져옵니다.
```
gcloud endpoints services list
```
Service Management에서 서비스를 삭제합니다. SERVICE_NAME은 삭제할 서비스 이름으로 바꿉니다.
```
gcloud endpoints services delete SERVICE_NAME
```
gcloud endpoints services delete를 실행해도 관리형 서비스가 즉시 삭제되지는 않습니다. Service Management에서 30일 동안 관리형 서비스가 사용 중지되므로 필요한 경우 복원할 수 있습니다. 30일 이후에는 Service Management에서 관리형 서비스가 영구적으로 삭제됩니다.
부하 분산기 페이지로 이동합니다.

부하 분산기로 이동

espv2-load-balancer-check 상태 확인을 사용하여 부하 분산기 espv2-load-balancer를 삭제합니다.
인스턴스 그룹 페이지로 이동합니다.

인스턴스 그룹으로 이동

load-balancing-espv2-group 삭제
인스턴스 템플릿 페이지로 이동합니다.

인스턴스 템플릿으로 이동

load-balancing-espv2-template를 삭제합니다.

다음 단계

Endpoints용 자체 gRPC API를 구성하는 방법을 알아봅니다.
GitHub에서 Bookstore 샘플을 자세히 살펴봅니다. 클라이언트와 서버 모두 Python 및 Java로 제공됩니다.
getting-started-grpc 샘플은 GitHub에서 다음 언어로 제공됩니다.
- 자바
- Python
- Ruby
- Go
- Node.js