ESPv2를 사용하여 Cloud Run용 Cloud Endpoints gRPC 설정

OpenAPI | gRPC

이 페이지에서는 gRPC 백엔드를 사용하여 Cloud Run용 Cloud Endpoints를 설정하는 방법을 설명합니다. Endpoints는 Extensible Service Proxy V2(ESPv2)를 API 게이트웨이로 사용합니다. Cloud Run을 위한 API 관리를 제공하려면 사전 빌드된 ESPv2 컨테이너를 Cloud Run에 배포합니다. 그런 다음 ESPv2가 서비스를 호출할 수 있도록 Cloud Run IAM을 사용하여 서비스를 보안 설정합니다.

이렇게 설정하면 서비스를 호출하기 전에 ESPv2가 모든 서비스 요청을 가로채서 필요한 검사(예: 인증)를 수행합니다. 서비스가 응답하면 아래 그림에 표시된 대로 ESPv2가 텔레메트리를 수집하고 보고합니다. 서비스의 측정항목은 Google Cloud 콘솔의 Endpoints > 서비스 페이지에서 확인할 수 있습니다.

Endpoints 아키텍처

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

ESPv2로 마이그레이션

Cloud Endpoints의 이전 출시 버전은 ESP를 사용한 Cloud Run에서 gRPC를 지원하지 않았습니다. 이 기능을 사용하려면 Extensible Service Proxy V2로 마이그레이션하세요.

작업 목록

다음 작업 목록을 사용하여 튜토리얼을 진행하세요. 이 튜토리얼을 완료하려면 모든 작업을 수행해야 합니다.

Google Cloud 프로젝트를 만들고 자체 Cloud Run을 배포하지 않은 경우 샘플 백엔드 gRPC 서비스를 배포합니다. 시작하기 전에를 참조하세요.
ESPv2 서비스의 Cloud Run 호스트 이름을 예약합니다. Cloud Run 호스트 이름 예약을 참조하세요.
API를 설명하는 gRPC API 구성 문서를 만들고 Cloud Run 경로를 구성합니다. Endpoints 구성을 참조하세요.
gRPC API 구성 문서를 배포하여 관리형 서비스를 만듭니다. Endpoints 구성 배포를 참조하세요.
Endpoints 서비스 구성으로 새 ESPv2 Docker 이미지를 빌드합니다. 새 ESPv2 이미지 빌드를 참조하세요.
Cloud Run에 ESPv2 컨테이너를 배포합니다. 그런 다음 ESPv2에 ID 및 액세스 관리(IAM) 권한을 부여하여 서비스를 호출합니다. ESPv2 컨테이너 배포를 참조하세요.
서비스를 호출합니다. API에 요청 보내기를 참조하세요.
서비스에 대한 활동을 추적합니다. API 활동 추적을 참조하세요.
Google Cloud 계정에 요금이 청구되지 않도록 합니다. 삭제를 참조하세요.

비용

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

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

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

시작하기 전에

설정하려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 리소스 관리 페이지로 이동하여 프로젝트를 만듭니다.
리소스 관리 페이지로 이동
프로젝트에 결제가 사용 설정되어 있는지 확인하세요.
결제 사용 설정 방법 알아보기
나중에 필요하므로 프로젝트 ID를 기록합니다. 이 페이지의 나머지 부분에서는 프로젝트 ID를 ESP_PROJECT_ID라고 합니다.
나중에 필요하므로 프로젝트 번호를 기록합니다. 이 페이지의 나머지 부분에서는 프로젝트 번호를 ESP_PROJECT_NUMBER라고 합니다.
Google Cloud CLI를 다운로드하고 설치합니다.
gcloud CLI 다운로드
gRPC Python 빠른 시작의 단계를 따라 gRPC와 gRPC 도구를 설치합니다.
이 튜토리얼에서 사용할 python-grpc-bookstore-server 예시 백엔드 gRPC Cloud Run 서비스를 배포합니다. gRPC 서비스는 다음 컨테이너 이미지를 사용합니다.

gcr.io/endpointsv2/python-grpc-bookstore-server:2

빠른 시작: 사전 빌드된 샘플 컨테이너 배포의 단계에 따라 서비스를 배포합니다. 해당 빠른 시작에 지정된 컨테이너 이미지를 gcr.io/endpointsv2/python-grpc-bookstore-server:2로 바꿔야 합니다.

서비스가 배포된 리전과 프로젝트 ID에 대한 참고 사항입니다. 이 페이지의 나머지 부분에서는 프로젝트 ID를 BACKEND_PROJECT_ID라고 합니다. 배포된 Cloud Run 서비스의 이름은 BACKEND_SERVICE_NAME이라고 합니다. Cloud Run 호스트 이름은 BACKEND_HOST_NAME이라고 합니다.

Cloud Run 호스트 이름 예약

OpenAPI 문서 또는 gRPC 서비스 구성을 구성하려면 ESPv2 서비스의 Cloud Run 호스트 이름을 예약해야 합니다. 호스트 이름을 예약하려면 Cloud Run에 샘플 컨테이너를 배포합니다. 나중에 ESPv2 컨테이너를 동일한 Cloud Run 서비스에 배포합니다.

gcloud CLI가 데이터와 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.
1. 로그인합니다.
```
gcloud auth login
```
2. 새 브라우저 탭이 열리면 ESPv2를 Cloud Run에 배포하기 위해 만든 Google Cloud 프로젝트에서 편집자 또는 소유자 역할이 있는 계정을 선택합니다.

리전을 설정합니다.

gcloud config set run/region us-central1

샘플 이미지 gcr.io/cloudrun/hello를 Cloud Run에 배포합니다. CLOUD_RUN_SERVICE_NAME을 서비스에 사용할 이름으로 바꿉니다.
```
gcloud run deploy CLOUD_RUN_SERVICE_NAME \
    --image="gcr.io/cloudrun/hello" \
    --allow-unauthenticated \
    --platform managed \
    --project=ESP_PROJECT_ID
```
명령어가 성공적으로 실행 완료되면 다음과 유사한 메시지가 표시됩니다.
```
Service [CLOUD_RUN_SERVICE_NAME] revision [CLOUD_RUN_SERVICE_NAME-REVISION_NUM] has been deployed and is serving traffic at CLOUD_RUN_SERVICE_URL
```
예를 들어 CLOUD_RUN_SERVICE_NAME을 gateway로 설정하면 다음과 같이 표시됩니다.
```
Service [gateway] revision [gateway-00001] has been deployed and is serving traffic at https://gateway-12345-uc.a.run.app
```
이 예시에서 https://gateway-12345-uc.a.run.app은 CLOUD_RUN_SERVICE_URL이고 gateway-12345-uc.a.run.app은 CLOUD_RUN_HOSTNAME입니다.
CLOUD_RUN_SERVICE_NAME 및 CLOUD_RUN_HOSTNAME을 기록해 둡니다. 나중에 ESPv2를 CLOUD_RUN_SERVICE_NAME Cloud Run 서비스에 배포합니다. OpenAPI 문서의 host 필드에 CLOUD_RUN_HOSTNAME을 지정합니다.

Endpoints 구성

bookstore-grpc 샘플에는 로컬로 복사하고 구성해야 하는 파일이 포함되어 있습니다.

Create a self-contained protobuf descriptor file from your service .proto file:
1. Save a copy of bookstore.proto from the example repository to your current working directory. This file defines the Bookstore service's API.
2. Create the following directory under your working directory: mkdir generated_pb2
3. Create the descriptor file, api_descriptor.pb, by using the protoc protocol buffers compiler. Run the following command in the directory where you saved bookstore.proto:
```
python3 -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
```
  In the preceding command, --proto_path is set to the current working directory. In your gRPC build environment, if you use a different directory for .proto input files, change --proto_path so the compiler searches the directory where you saved bookstore.proto.

Create a text file called api_config.yaml in your current working directory (the same directory that contains bookstore.proto). For convenience, this page refers to the gRPC API configuration document by that file name, but you can name it something else if you prefer. Add the following contents to the file:

# The configuration schema is defined by the service.proto file.
# https://github.com/googleapis/googleapis/blob/master/google/api/service.proto

type: google.api.Service
config_version: 3
name: CLOUD_RUN_HOSTNAME
title: Cloud Endpoints + Cloud Run gRPC
apis:
  - name: endpoints.examples.bookstore.Bookstore
usage:
  rules:
  # ListShelves methods can be called without an API Key.
  - selector: endpoints.examples.bookstore.Bookstore.ListShelves
    allow_unregistered_calls: true
backend:
  rules:
    - selector: "*"
      address: grpcs://BACKEND_HOST_NAME

Indentation is important for yaml format. For example the name field must be at the same level as type.

In the name field, specify CLOUD_RUN_HOSTNAME, the hostname portion of the URL that was reserved above in Reserving a Cloud Run hostname. Don't include the protocol identifier, such as https:// or grpcs://.
In the address field in the backend.rules section, replace BACKEND_HOST_NAME with the actual gRPC Bookstore Cloud Run service created in Before you begin.

Note: To use gRPC with TLS on Cloud Run, the address field must have the scheme grpcs:// instead of https://.
Note the value of the title property in the api_config.yaml file:
```
title: Cloud Endpoints + Cloud Run gRPC
```
The value of the title property becomes the name of the Endpoints service after you deploy the configuration.
Save your gRPC API configuration document.

자세한 내용은 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 구성 배포를 참조하세요.

새 ESPv2 이미지 빌드

Endpoints 서비스 구성을 새 ESPv2 Docker 이미지에 빌드합니다. 나중에 이 이미지를 예약된 Cloud Run 서비스에 배포합니다.

참고:

이 단계는 필수 항목입니다.

Cloud Run은 scale-to-zero 서비스이므로 서비스 구성을 새 Docker 이미지에 빌드해야 합니다. 즉, 트래픽이 없을 때에는 모든 인스턴스가 삭제됩니다. 트래픽이 증가하면 필요에 따라 새 인스턴스가 생성됩니다. 이러한 유형의 서비스 인스턴스 생성을 콜드 스타트라고 부르기도 합니다. 자세한 내용은 Cloud Run 동시 실행 문서를 참조하세요.

Docker 이미지에 서비스 구성을 빌드하지 않은 경우 Cloud Run은 콜드 스타트 시 Google ServiceManagement에 두 개의 API 호출을 보내야 합니다. 이러한 호출은 Google ServiceManagement API 할당량에 포함됩니다.

서비스 구성을 ESPv2 Docker 이미지에 빌드하면 두 개의 API 호출이 필요 없어 Google ServiceManagement 서비스 할당량에 영향을 주지 않습니다. 또한 이 단계를 통해 새 서비스 인스턴스를 빠르게 만들고 새 인스턴스를 기다리는 요청 지연 시간을 줄일 수 있습니다.

이 전체 단계를 다시 실행하고 새 컨테이너를 다시 배포해야 합니다.

Endpoints 서비스 구성을 수정하고 다시 배포할 때마다. 그렇지 않으면 서비스 구성의 변경사항이 ESPv2에 적용되지 않습니다.
ESPv2의 새 버전이 출시될 때 그렇지 않으면 이전 버전의 ESPv2가 계속 배포됩니다.

새 ESPv2 Docker 이미지에 서비스 구성을 빌드하려면 다음 단계를 따르세요.

이 스크립트를 gcloud CLI가 설치된 로컬 머신에 다운로드합니다.

참고:
이 스크립트에는 bash가 필요합니다. macOS/Linux를 사용하지 않는 경우 Cloud Shell, Compute Engine, Linux용 Windows 하위 시스템에서 실행할 수 있습니다.
다음 명령어를 사용하여 스크립트를 실행합니다.
```
chmod +x gcloud_build_image

./gcloud_build_image -s CLOUD_RUN_HOSTNAME \
    -c CONFIG_ID -p ESP_PROJECT_ID
```
CLOUD_RUN_HOSTNAME의 경우 Cloud Run 호스트 이름 예약에서 위에서 예약한 URL의 호스트 이름을 지정합니다. https:// 프로토콜 식별자는 포함하지 않습니다.

예를 들면 다음과 같습니다.
```
chmod +x gcloud_build_image

./gcloud_build_image -s gateway-12345-uc.a.run.app \
    -c 2019-02-01r0 -p your-project-id
```
이 스크립트는 gcloud 명령어를 사용하여 서비스 구성을 다운로드하고 서비스 구성을 새 ESPv2 이미지에 빌드하며 새 이미지를 프로젝트 Container Registry에 업로드합니다. 스크립트는 출력 이미지 이름에 ESP_VERSION으로 표시된 ESPv2의 최신 출시 버전을 자동으로 사용합니다. 출력 이미지가 다음으로 업로드됩니다.
```
gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID
```
예를 들면 다음과 같습니다.
```
gcr.io/your-project-id/endpoints-runtime-serverless:2.14.0-gateway-12345-uc.a.run.app-2019-02-01r0"
```
참고:
-z 플래그를 스크립트에 전달하여 다른 레지스트리 위치에 이미지를 생성합니다.

예를 들어 생성된 ESPv2 이미지를 유럽 연합 데이터 센터에 푸시하려면 -z eu를 스크립트에 전달합니다.

ESPv2 컨테이너 배포

위에서 빌드한 새 이미지로 ESPv2 Cloud Run 서비스를 배포합니다. CLOUD_RUN_SERVICE_NAME을 Cloud Run 호스트 이름 예약에서 위의 호스트 이름을 처음 예약할 때 사용한 것과 동일한 Cloud Run 서비스 이름으로 바꿉니다.
```
gcloud run deploy CLOUD_RUN_SERVICE_NAME \
  --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID" \
  --allow-unauthenticated \
  --platform managed \
  --project=ESP_PROJECT_ID
```
참고:
gRPC 서비스가 스트리밍 프로토콜을 사용하는 경우 --use-http2 플래그를 gcloud run deploy 명령어에 추가합니다. 현재 이 플래그는 gcloud beta run에서만 지원됩니다. ESPv2 및 gRPC 백엔드 Cloud Run 서비스를 배포할 때 이 플래그를 추가합니다.
CORS 사용 설정과 같은 ESPv2 시작 옵션을 추가로 사용하도록 Endpoints를 구성하려는 경우 ESPv2_ARGS 환경 변수에 인수를 전달할 수 있습니다.
```
gcloud run deploy CLOUD_RUN_SERVICE_NAME \
  --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID" \
  --set-env-vars=ESPv2_ARGS=--cors_preset=basic \
  --allow-unauthenticated \
  --platform managed \
  --project ESP_PROJECT_ID
```
사용 가능한 옵션 목록과 여러 옵션을 지정하는 방법을 비롯하여 ESPv2_ARGS 환경 변수 설정에 대한 자세한 내용 및 예시는 Extensible Service Proxy V2 플래그를 참조하세요.
ESPv2에 Cloud Run 서비스를 호출하는 권한을 부여합니다. 각 서비스에 대해 다음 명령어를 실행하고 명령어에서 다음과 같이 바꿉니다.
참고:
ESPv2 Cloud Run 서비스가 플래그 --service-account를 사용하지 않고 배포되고 백엔드 서비스 BACKEND_SERVICE_NAME이 ESP_PROJECT_NUMBER 프로젝트에 배포되는 경우에는 이 단계가 필요 없습니다.
- BACKEND_SERVICE_NAME을 호출되는 Cloud Run 서비스 이름으로 바꿉니다. `gcr.io/endpointsv2/python-grpc-bookstore-server:2`를 배포하여 만든 서비스를 사용하는 경우 python-grpc-bookstore-server를 이 값으로 사용합니다.
- ESP_PROJECT_NUMBER를 ESPv2용으로 만든 프로젝트의 프로젝트 번호로 바꿉니다. 이 번호를 찾는 한 가지 방법은 Google Cloud 콘솔의 IAM 페이지로 이동하여 `member` 플래그에 사용된 서비스 계정인 기본 컴퓨팅 서비스 계정을 찾는 것입니다.
```
gcloud run services add-iam-policy-binding BACKEND_SERVICE_NAME \
  --member "serviceAccount:ESP_PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
  --role "roles/run.invoker" \
  --platform managed \
  --project BACKEND_PROJECT_ID
```

자세한 내용은 IAM을 사용하여 액세스 관리를 참조하세요.

API에 요청 보내기

To send requests to the sample API, you can use a sample gRPC client written in Python.

Clone the git repo where the gRPC client code is hosted:

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

Change your working directory:

cd python-docs-samples/endpoints/bookstore-grpc/

Install dependencies:

pip3 install virtualenv
virtualenv env
source env/bin/activate
pip3 install -r requirements.txt

Send a request to the sample API:
```
python3 bookstore_client.py --host CLOUD_RUN_HOSTNAME --port 443 --use_tls true
```
Specify the hostname of your ESPv2 Cloud Run service in CLOUD_RUN_HOSTNAME, without the protocol identifier. For example:
```
python3 bookstore_client.py --host espv2-grpc-HASH-uc.a.run.app --port 443 --use_tls true
```
- Look at the activity graphs for your API in the Endpoints > Services page.
  
  Go to the Endpoints Services page
  
  It may take a few moments for the request to be reflected in the graphs.
- Look at the request logs for your API in the Logs Explorer page.
  
  Go to the Logs Explorer page

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

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

API 활동 추적

Google Cloud 콘솔의 Endpoints > 서비스 페이지에서 API의 활동 그래프를 봅니다.

Endpoints 활동 그래프 보기

요청이 그래프에 반영되는 데 잠시 시간이 걸릴 수 있습니다.
로그 탐색기 페이지에서 API의 요청 로그를 봅니다.

Endpoints 요청 로그 보기

API의 개발자 포털 만들기

Cloud Endpoints 포털을 사용하여 샘플 API와 상호작용하는 데 사용할 수 있는 웹사이트인 개발자 포털을 만들 수 있습니다. 자세한 내용은 Cloud Endpoints 포털 개요를 참조하세요.

삭제

이 페이지에서 사용한 리소스 비용이 Google Cloud 계정에 청구되지 않도록 하려면 다음 단계를 수행합니다.

이 튜토리얼에서 사용되는 서비스를 중지하는 방법에 대한 자세한 내용은 API 및 API 인스턴스 삭제를 참조하세요.