ESPv2를 사용하여 표준 환경용 Cloud Endpoints OpenAPI 설정

IAP를 구성하여 앱 보안

App Engine 앱 보안을 위해 IAP(Identity-Aware Proxy)를 사용하여 요청이 인증되었는지 확인해야 합니다.

IAP 사용 설정 단계에 따라 애플리케이션에 로그인할 수 있는지 확인합니다.

또한 OAuth 클라이언트를 구성할 때 이 가이드에서 IAP_CLIENT_ID라고 하는 OAuth client_id를 기록해 둡니다.

Cloud Run 호스트 이름 예약

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

1. gcloud CLI가 데이터와 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.
   1. 로그인합니다.

      gcloud auth login

   2. 새 브라우저 탭이 열리면 ESPv2를 Cloud Run에 배포하기 위해 만든 Google Cloud 프로젝트에서 편집자 또는 소유자 역할이 있는 계정을 선택합니다.
2. 리전을 설정합니다.

   gcloud config set run/region us-central1

3. 샘플 이미지 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입니다.

4. 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 개요에서 자세한 내용을 참조하세요.

1. openapi-appengine.yaml이라는 텍스트 파일을 만듭니다. 편의상 이 페이지에서는 OpenAPI 문서를 이 파일 이름으로 지칭하지만 원하면 다른 이름을 지정할 수 있습니다.
2. App Engine 백엔드 앱은 openapi-appengine.yaml 파일 상단에 있는 x-google-backend 정의에 설명되어 있습니다. 예를 들면 다음과 같습니다.

     swagger: '2.0'
     info:
       title: Cloud Endpoints + App Engine
       description: Sample API on Cloud Endpoints with an App Engine backend
       version: 1.0.0
     host: CLOUD_RUN_HOSTNAME
     schemes:
       - https
     produces:
       - application/json
     x-google-backend:
       address: https://APP_PROJECT_ID.REGION.r.appspot.com
       jwt_audience: IAP_CLIENT_ID
       protocol: h2
     paths:
       /:
         get:
           summary: Greet a user
           operationId: hello
           responses:
             '200':
               description: A successful response
               schema:
                 type: string

   들여쓰기 간격은 yaml 형식에서 중요합니다. 예를 들어 host 필드는 info과 동일한 수준이어야 합니다.
3. x-google-backend 섹션의 address 필드에서 APP_PROJECT_ID를 Google Cloud 프로젝트 ID로 바꾸고 REGION을 App Engine을 배포한 GCP 리전으로, IAP_CLIENT_ID를 IAP를 설정할 때 만든 OAuth 클라이언트 ID로 바꿉니다.

4. host 필드에 Cloud Run 호스트 이름 예약에서 예약된 URL의 호스트 이름 부분인 CLOUD_RUN_HOSTNAME을 지정합니다. https:// 프로토콜 식별자는 포함하지 않습니다. 예를 들면 다음과 같습니다.

   swagger: '2.0'
     info:
       title: Cloud Endpoints + App Engine
       description: Sample API on Cloud Endpoints with an App Engine backend
       version: 1.0.0
     host: gateway-12345-uc.a.run.app

5. openapi-appengine.yaml 파일에서 title 속성 값은 다음과 같습니다.

   title: Cloud Endpoints + App Engine

   구성을 배포하면 title 속성 값이 Endpoints 서비스 이름이 됩니다.

6. OpenAPI 문서를 저장합니다.

Endpoints에 필요한 OpenAPI 문서의 필드에 대한 자세한 내용은 Endpoints 구성을 참조하세요.

Endpoints 구성 배포

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

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

1. OpenAPI 문서가 포함된 디렉토리에 있는지 확인합니다.

2. 구성을 업로드하고 관리형 서비스를 만듭니다.

   gcloud endpoints services deploy openapi-appengine.yaml \
     --project ESP_PROJECT_ID

   그러면 openapi-appengine.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-appengine.yaml을 다시 배포하면 서비스 구성 ID에서 버전 번호가 증가합니다. Google Cloud 콘솔의 Endpoints > 서비스 페이지에서 서비스 구성 및 배포 기록을 볼 수 있습니다.

   오류 메시지가 나타나면 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

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 서비스를 참조하세요.

새 ESPv2 이미지 빌드

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

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

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

2. 다음 명령어를 사용하여 스크립트를 실행합니다.

   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

3. 이 스크립트는 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 컨테이너 배포

1. 위에서 빌드한 새 이미지로 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

2. 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 플래그를 참조하세요.

3. IAP 보안 앱을 호출할 수 있는 ESPv2 권한을 부여합니다. 각 서비스에 대해 다음 명령어를 실행합니다. 다음 명령어 안내를 따르세요.
   • APP_PROJECT_ID를 App Engine 프로젝트 ID의 이름으로 바꿉니다.
   • ESP_PROJECT_NUMBER를 ESPv2용으로 만든 프로젝트의 프로젝트 번호로 바꿉니다. 이 번호는 IAM 콘솔로 이동하여 'member' 플래그에 사용된 서비스 계정인 Compute Engine 기본 서비스 계정을 찾아 확인할 수 있습니다.

     gcloud projects add-iam-policy-binding APP_PROJECT_ID \
         --member "serviceAccount:ESP_PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
         --role "roles/iap.httpsResourceAccessor"
       

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

API에 요청 보내기

이 섹션에서는 API에 요청을 보내는 방법을 설명합니다.

1. 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"

curl --request GET \
   --header "content-type:application/json" \
   "https://${ENDPOINTS_HOST}/"

(Invoke-WebRequest -Method GET `
    -Headers @{"content-type"="application/json"} `
    -URI "https://$Env:ENDPOINTS_HOST/").Content

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

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

API 활동 추적

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

   Endpoints 활동 그래프 보기

   요청이 그래프에 반영되는 데 잠시 시간이 걸릴 수 있습니다.

2. 로그 탐색기 페이지에서 API의 요청 로그를 봅니다.

   Endpoints 요청 로그 보기

API의 개발자 포털 만들기

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