ESPv2를 사용하여 Cloud Run 함수용 Cloud Endpoints OpenAPI 설정
이 페이지에서는 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 Console의 Endpoints > 서비스 페이지에서 확인할 수 있습니다.
Cloud Endpoints 개요는 Endpoints 정보와 Endpoints 아키텍처를 참조하세요.
ESPv2로 마이그레이션
Cloud Endpoints의 이전 릴리스는 Cloud Functions에서 ESP (Extensible Service Proxy) 사용을 지원했습니다. 기존 API를 ESPv2로 마이그레이션하려는 경우 자세한 내용은 Extensible Service Proxy V2로 마이그레이션을 참조하세요.
작업 목록
다음 작업 목록을 사용하여 가이드를 진행하세요. 이 가이드를 완료하려면 모든 작업을 수행해야 합니다.
- Google Cloud 프로젝트를 만들고 자체 Cloud Run 함수를 배포하지 않았으면 샘플 백엔드 함수를 배포합니다. 시작하기 전에를 참조하세요.
- ESPv2 서비스의 Cloud Run 호스트 이름을 예약합니다. Cloud Run 호스트 이름 예약을 참조하세요.
- API를 설명하는 OpenAPI 문서를 만들고 Cloud Run 함수 경로를 구성합니다. Endpoints 구성을 참조하세요.
- OpenAPI 문서를 배포하여 관리형 서비스를 만듭니다. Endpoints 구성 배포를 참조하세요.
- Endpoints 서비스 구성으로 새 ESPv2 Docker 이미지를 빌드합니다. 새 ESPv2 이미지 빌드를 참조하세요.
- Cloud Run에 ESPv2 컨테이너를 배포합니다. 그런 다음 ESPv2에 ID 및 액세스 관리(IAM) 권한을 부여하여 서비스를 호출합니다. ESPv2 컨테이너 배포를 참조하세요.
- 함수를 호출합니다. API에 요청 보내기를 참조하세요.
- 함수 활동을 추적합니다. API 활동 추적을 참조하세요.
- Google Cloud 계정에 요금이 청구되지 않도록 합니다. 삭제를 참조하세요.
비용
이 문서에서는 비용이 청구될 수 있는 다음과 같은 Google Cloud 구성요소를 사용합니다.
프로젝트 사용량을 기준으로 예상 비용을 산출하려면 가격 계산기를 사용하세요.
이 문서에 설명된 태스크를 완료했으면 만든 리소스를 삭제하여 청구가 계속되는 것을 방지할 수 있습니다. 자세한 내용은 삭제를 참조하세요.
시작하기 전에
Cloud Run 함수용 Endpoints를 사용하기 전에 다음 작업을 수행하는 것이 좋습니다.
ESPv2 컨테이너를 Cloud Run에 배포할 때 사용할 새 Google Cloud 프로젝트를 만듭니다.
Cloud Run 함수의 새 프로젝트를 만들거나 기존 프로젝트를 선택합니다.
설정하려면 다음 안내를 따르세요.
Google Cloud Console에서 리소스 관리 페이지로 이동하여 프로젝트를 만듭니다.
프로젝트에 결제가 사용 설정되어 있는지 확인하세요.
나중에 필요하므로 프로젝트 ID를 기록합니다. 이 페이지의 나머지 부분에서는 프로젝트 ID를 ESP_PROJECT_ID라고 합니다.
나중에 필요하므로 프로젝트 번호를 기록합니다. 이 페이지의 나머지 부분에서는 프로젝트 번호를 ESP_PROJECT_NUMBER라고 합니다.
Google Cloud CLI를 다운로드하고 설치합니다.
자체 백엔드 Cloud Run 함수를 배포한 적이 없으면 빠른 시작: Google Cloud CLI 사용의 단계를 수행하여 Google Cloud 프로젝트를 선택하거나 만들고 샘플 함수를 배포합니다. 함수가 배포된 리전과 프로젝트 ID를 기록해 둡니다. 이 페이지의 나머지 부분에서는 프로젝트 ID를 FUNCTIONS_PROJECT_ID라고 합니다.
Cloud Run 호스트 이름 예약
OpenAPI 문서 또는 gRPC 서비스 구성을 구성하려면 ESPv2 서비스의 Cloud Run 호스트 이름을 예약해야 합니다. 호스트 이름을 예약하려면 Cloud Run에 샘플 컨테이너를 배포합니다. 나중에 ESPv2 컨테이너를 동일한 Cloud Run 서비스에 배포합니다.
-
gcloud CLI가 데이터와 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.
- 로그인:
gcloud auth login
- 새 브라우저 탭이 열리면 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 구성
함수의 노출 영역과 인증 요구사항을 설명하는 OpenAPI Specification v2.0 기반의 OpenAPI 문서가 있어야 합니다. 또한 ESPv2가 함수를 호출하는 데 필요한 정보를 갖도록 각 함수의 URL이 포함된 Google 필드를 추가해야 합니다. OpenAPI를 처음 사용하는 경우 OpenAPI 개요에서 자세한 내용을 참조하세요.
-
openapi-functions.yaml
이라는 텍스트 파일을 만듭니다. 편의상 이 페이지에서는 OpenAPI 문서를 이 파일 이름으로 지칭하지만 원하면 다른 이름을 지정할 수 있습니다. -
각 함수는
openapi-functions.yaml
파일의paths
섹션에 나열되어야 합니다. 예를 들면 다음과 같습니다.swagger: '2.0' info: title: Cloud Endpoints + GCF description: Sample API on Cloud Endpoints with a Google Cloud Functions backend version: 1.0.0 host: HOST schemes: - https produces: - application/json paths: /hello: get: summary: Greet a user operationId: hello x-google-backend: address: https://REGION-FUNCTIONS_PROJECT_ID.cloudfunctions.net/FUNCTIONS_NAME protocol: h2 responses: '200': description: A successful response schema: type: string
들여쓰기 간격은 yaml 형식에서 중요합니다. 예를 들어host
필드는info
과 동일한 수준이어야 합니다. -
x-google-backend
섹션의address
필드에서 REGION을 함수가 있는 Google Cloud 리전으로, FUNCTIONS_PROJECT_ID를 Google Cloud 프로젝트 ID로, FUNCTIONS_NAME을 함수 이름으로 바꿉니다. 예를 들면 다음과 같습니다.x-google-backend: address: https://us-central1-myproject.cloudfunctions.net/helloGET
ESPv2에서 호출만 허용하여 Cloud Run 함수를 보호하려는 경우jwt_audience
가 지정되지 않으면address
필드에 함수 이름이 포함되어 있는지 확인합니다. 예를 들면 다음과 같습니다.x-google-backend: address: https://REGION-FUNCTIONS_PROJECT_ID.cloudfunctions.net/FUNCTIONS_NAME path_translation: CONSTANT_ADDRESS
jwt_audience
가 지정되면 해당 값에 함수 이름도 포함되어야 합니다. 예를 들면 다음과 같습니다.x-google-backend: address: https://REGION-FUNCTIONS_PROJECT_ID.cloudfunctions.net jwt_audience: https://REGION-FUNCTIONS_PROJECT_ID.cloudfunctions.net/FUNCTIONS_NAME path_translation: APPEND_PATH_TO_ADDRESS
ESPv2는 인증을 위해 Cloud Run 함수를 호출할 때 ID 토큰을 생성합니다. ID 토큰에는 함수 호스트와 함수 이름을 지정하는 적절한audience
가 있어야 합니다. ESPv2는 지정된 경우jwt_audience
필드의 값을 사용해서 ID 토큰에 대해audience
를 설정합니다. 그렇지 않으면address
필드를 사용합니다. host
필드에 Cloud Run 호스트 이름 예약에서 예약된 URL의 호스트 이름 부분인 CLOUD_RUN_HOSTNAME을 지정합니다.https://
프로토콜 식별자는 포함하지 않습니다. 예를 들면 다음과 같습니다.swagger: '2.0' info: title: Cloud Endpoints + GCF description: Sample API on Cloud Endpoints with a Google Cloud Functions backend version: 1.0.0 host: gateway-12345-uc.a.run.app
openapi-functions.yaml
파일에서title
속성 값은 다음과 같습니다.title: Cloud Endpoints + GCF
구성을 배포하면
title
속성 값이 Endpoints 서비스 이름이 됩니다.- OpenAPI 문서를 저장합니다.
Endpoints에 필요한 OpenAPI 문서의 필드에 대한 자세한 내용은 Endpoints 구성을 참조하세요.
Endpoints 구성 배포
Endpoints 구성을 배포하려면 gcloud endpoints services deploy
명령어를 사용합니다. 이 명령어는 Service Management를 사용하여 관리형 서비스를 만듭니다.
Endpoints 구성을 배포하려면 다음 안내를 따르세요.
- OpenAPI 문서가 포함된 디렉토리에 있는지 확인합니다.
구성을 업로드하고 관리형 서비스를 만듭니다.
gcloud endpoints services deploy openapi-functions.yaml \ --project ESP_PROJECT_ID
그러면
openapi-functions.yaml
파일의host
필드에 지정한 이름으로 새 Endpoints 서비스가 생성됩니다. 이 서비스는 OpenAPI 문서에 따라 구성됩니다.Service Management에서 서비스를 만들고 구성하면서 터미널에 정보를 출력합니다. 배포가 완료되면 다음과 유사한 메시지가 표시됩니다.
Service Configuration [CONFIG_ID] uploaded for service [CLOUD_RUN_HOSTNAME]
CONFIG_ID는 배포 시 만들어진 고유한 Endpoints 서비스 구성 ID입니다. 예를 들면 다음과 같습니다.
Service Configuration [2019-02-01r0] uploaded for service [gateway-12345-uc.a.run.app]
서비스 구성 ID는 날짜 스탬프 뒤에 버전 번호가 있는 형태입니다. 당일에
openapi-functions.yaml
을 다시 배포하면 서비스 구성 ID에서 버전 번호가 증가합니다. Google Cloud Console의 Endpoints > 서비스 페이지에서 서비스 구성 및 배포 기록을 볼 수 있습니다.오류 메시지가 나타나면 Endpoints 구성 배포 문제해결을 참조하세요.
필수 서비스 확인
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.comgcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com
Endpoints 서비스도 사용 설정해야 합니다.
gcloud services enable ENDPOINTS_SERVICE_NAME
ENDPOINTS_SERVICE_NAME을 확인하려면 다음 중 하나를 수행합니다.
Endpoints 구성을 배포한 후 Cloud Console의 Endpoints 페이지로 이동합니다. 가능한 ENDPOINTS_SERVICE_NAME 목록이 서비스 이름 열 아래에 표시됩니다.
OpenAPI의 경우 ENDPOINTS_SERVICE_NAME은 OpenAPI 사양의
host
필드에 지정한 항목입니다. gRPC의 경우 ENDPOINTS_SERVICE_NAME은 gRPC 엔드포인트 구성의name
필드에 지정한 항목입니다.
gcloud
명령어에 대한 자세한 내용은 gcloud
서비스를 참조하세요.
새 ESPv2 이미지 빌드
Endpoints 서비스 구성을 새 ESPv2 Docker 이미지에 빌드합니다. 나중에 이 이미지를 예약된 Cloud Run 서비스에 배포합니다.
새 ESPv2 Docker 이미지에 서비스 구성을 빌드하려면 다음 단계를 따르세요.
이 스크립트를 gcloud CLI가 설치된 로컬 머신에 다운로드합니다.
다음 명령어를 사용하여 스크립트를 실행합니다.
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"
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
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에 Service Management 및 Service Control을 호출하는 권한을 부여합니다.
- Google Cloud Console에서 Cloud Run 페이지로 이동합니다.
- 배포한 Cloud Run 인스턴스와 연결된 서비스 계정을 확인할 수 있습니다.
- 서비스 계정에 필요한 권한을 부여합니다.
ESPv2에 함수를 호출할 수 있는 권한을 부여합니다. 각 함수에 다음 명령어를 실행합니다. 실행 시 다음 안내를 따르세요.
- FUNCTION_NAME을 함수의 이름으로 바꾸고 FUNCTION_REGION을 함수가 배포된 리전으로 바꿉니다. 빠른 시작: Google Cloud CLI 사용에서 만든 함수를 사용하는 경우 이름으로
helloGET
를 사용합니다. - ESP_PROJECT_NUMBER를 ESPv2용으로 만든 프로젝트의 프로젝트 번호로 바꿉니다. 이 번호를 찾는 한 가지 방법은 Google Cloud Console의 IAM 페이지로 이동하여
member
플래그에 사용된 서비스 계정인 기본 컴퓨팅 서비스 계정을 찾는 것입니다.
gcloud functions add-iam-policy-binding FUNCTION_NAME \ --region FUNCTION_REGION \ --member "serviceAccount:ESP_PROJECT_NUMBER-compute@developer.gserviceaccount.com" \ --role "roles/cloudfunctions.invoker" \ --project FUNCTIONS_PROJECT_ID
- FUNCTION_NAME을 함수의 이름으로 바꾸고 FUNCTION_REGION을 함수가 배포된 리전으로 바꿉니다. 빠른 시작: Google Cloud CLI 사용에서 만든 함수를 사용하는 경우 이름으로
gcloud projects add-iam-policy-binding PROJECT_NAME \ --member "serviceAccount:SERVICE_ACCOUNT" \ --role roles/servicemanagement.serviceController자세한 내용은 역할 및 권한이란 무엇인가요?를 참조하세요.
자세한 내용은 IAM을 통한 액세스 관리를 참조하세요.
API에 요청 보내기
이 섹션에서는 API에 요청을 보내는 방법을 설명합니다.
- Endpoints 서비스 이름의 환경 변수를 만듭니다. OpenAPI 문서의
host
필드에 지정한 이름입니다. 예를 들면 다음과 같습니다.Linux 또는 macOS:
export ENDPOINTS_HOST=gateway-12345-uc.a.run.app
Windows PowerShell:
$Env: ENDPOINTS_HOST="gateway-12345-uc.a.run.app"
Linux 또는 Mac OS
curl
을 사용하여 이전 단계에서 설정한 ENDPOINTS_HOST
환경 변수를 통해 HTTP 요청을 전송합니다.
curl --request GET \ --header "content-type:application/json" \ "https://${ENDPOINTS_HOST}/hello"
PowerShell
Invoke-WebRequest
을 사용하여 이전 단계에서 설정한 ENDPOINTS_HOST
환경 변수를 통해 HTTP 요청을 전송합니다.
(Invoke-WebRequest -Method GET ` -Headers @{"content-type"="application/json"} ` -URI "https://$Env:ENDPOINTS_HOST/hello").Content
위의 예시에서 처음 두 행은 백틱으로 끝납니다. PowerShell에 예를 붙여넣을 때 백틱 다음에 공백이 없어야 합니다. 요청 예시에 사용된 옵션에 대한 자세한 내용은 Microsoft 문서의 Invoke-WebRequest를 참조하세요.
타사 앱
Chrome 브라우저 확장 프로그램 Postman 요청과 같은 서드 파티 애플리케이션을 사용할 수 있습니다.
- HTTP 동사로
GET
를 선택합니다. - 헤더에 키
content-type
및 값application/json
을 선택합니다. 환경 변수 대신 실제 URL을 사용합니다. 예를 들면 다음과 같습니다.
https://gateway-12345-uc.a.run.app/hello
성공적인 응답을 받지 못하면 응답 오류 문제해결을 참조하세요.
Endpoints에 API를 배포하고 테스트했습니다.
API 활동 추적
Google Cloud 콘솔의 Endpoints > 서비스 페이지에서 API의 활동 그래프를 봅니다.
요청이 그래프에 반영되는 데 잠시 시간이 걸릴 수 있습니다.
로그 탐색기 페이지에서 API의 요청 로그를 봅니다. Endpoints 요청 로그 보기
API의 개발자 포털 만들기
Cloud Endpoints 포털을 사용하여 샘플 API와 상호작용하는 데 사용할 수 있는 웹사이트인 개발자 포털을 만들 수 있습니다. 자세한 내용은 Cloud Endpoints 포털 개요를 참조하세요.
삭제
이 페이지에서 사용한 리소스 비용이 Google Cloud 계정에 청구되지 않도록 하려면 다음 단계를 수행합니다.
이 가이드에서 사용되는 서비스를 중지하는 방법에 대한 자세한 내용은 API 및 API 인스턴스 삭제를 참조하세요.