ESP를 사용하여 Compute Engine용 Cloud Endpoints 시작하기

Compute Engine 인스턴스 만들기

Compute Engine 인스턴스를 만들려면 다음을 따르세요.

1. In the Google Cloud console, go to the Create an instance page.

   Go to Create an instance

2. 방화벽 섹션에서 HTTP 트래픽 허용 및 HTTPS 트래픽 허용.
3. 만들기를 클릭하여 VM을 만듭니다.



인스턴스가 시작될 때까지 잠시 기다립니다. 준비가 끝나면 VM 인스턴스 페이지에 녹색 상태 아이콘과 함께 인스턴스가 나열됩니다.

4. VM 인스턴스에 연결할 수 있는지 확인합니다.
   1. In the list of virtual machine instances, click SSH in the row of the instance that you want to connect to.
   2. 이제 터미널을 사용하여 Debian 인스턴스에서 Linux 명령어를 실행할 수 있습니다.
   3. exit를 입력하여 인스턴스 연결을 해제합니다.
5. 나중에 필요하므로 인스턴스 이름, 영역, 외부 IP 주소를 기록합니다.

샘플 코드 다운로드

로컬 머신에 샘플 코드를 다운로드합니다.

Endpoints 구성

샘플 코드에는 OpenAPI 사양 v2.0을 기반으로 하는 OpenAPI 구성 파일인 openapi.yaml이 포함되어 있습니다. openapi.yaml을 로컬 머신에 구성 및 배포합니다.

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

1. 샘플 코드 디렉터리에서 openapi.yaml 구성 파일을 엽니다.
   자바

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Python

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Go

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   PHP

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Ruby

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   NodeJS

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   다음에 유의하세요.

   • 구성 샘플은 수정이 필요한 host 필드 근처의 행을 표시합니다. Endpoints에 openapi.yaml 파일을 배포하려면 전체 OpenAPI 문서가 필요합니다.
   • openapi.yaml 파일 예시에 포함된 인증 구성 섹션은 이 튜토리얼에서 필요하지 않습니다. YOUR-SERVICE-ACCOUNT-EMAIL 및 YOUR-CLIENT-ID가 있는 행은 구성할 필요가 없습니다.
   • OpenAPI는 언어 제약이 없는 사양입니다. 편의를 위해 동일한 openapi.yaml 파일이 각 언어의 GitHub 저장소에 있는 getting-started 샘플에 포함되어 있습니다.

2. host 필드의 텍스트를 Endpoints 서비스 이름으로 바꿉니다. 이 이름은 다음 형식이어야 합니다.

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

   YOUR_PROJECT_ID를 Google Cloud 프로젝트 ID로 바꿉니다. 예를 들면 다음과 같습니다.

   host: "echo-api.endpoints.example-project-12345.cloud.goog"

echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog는 Endpoints 서비스 이름입니다. 이 이름은 API에 요청을 전송하는 데 사용되는 정규화된 도메인 이름(FQDN)이 아닙니다.

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

아래의 모든 구성 단계를 완료하여 IP 주소를 사용해 샘플 API에 성공적으로 요청을 전송할 수 있게 되었으면 Endpoints DNS 구성에서 echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog를 FQDN으로 구성하는 방법을 알아보세요.

Endpoints 구성 배포

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

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

1. 현재 위치가 endpoints/getting-started 디렉터리인지 확인합니다.
2. 구성을 업로드하고 관리형 서비스를 만듭니다.

   gcloud endpoints services deploy openapi.yaml
   

그러면 gcloud 명령어는 Service Management API를 호출하여 openapi.yaml 파일의 host 필드에서 지정된 이름으로 관리형 서비스를 만듭니다. Service Management는 openapi.yaml 파일의 설정에 따라 서비스를 구성합니다. openapi.yaml을 변경하는 경우 파일을 재배포하여 Endpoints 서비스를 업데이트해야 합니다.

서비스 생성 및 구성 시 Service Management는 터미널에 정보를 출력합니다. openapi.yaml 파일의 경로에 API 키가 필요하지 않다는 경고는 무시해도 됩니다. 서비스 구성이 완료되면 Service Management가 다음과 같이 서비스 구성 ID와 서비스 이름이 나와 있는 메시지를 표시합니다.

Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]

앞의 예시에서 2017-02-13r0은 서비스 구성 ID이고 echo-api.endpoints.example-project-12345.cloud.goog는 Endpoints 서비스입니다. 서비스 구성 ID는 날짜 스탬프와 버전 번호로 구성됩니다. 같은 날짜에 openapi.yaml 파일을 다시 배포하면 서비스 구성 ID의 버전 번호가 증가합니다. Google Cloud 콘솔의 Endpoints > 서비스 페이지에서 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 서비스를 참조하세요.

API 백엔드 배포

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

필수 권한 확인

• Google Cloud Console에서 Compute Engine 인스턴스 페이지로 이동합니다.

  Compute Engine 페이지로 이동

• 목록에서 인스턴스를 선택합니다.
• 연결된 서비스 계정과 계정에 포함된 권한을 확인할 수 있습니다.

• 서비스 계정에 필요한 권한을 부여합니다.

  gcloud projects add-iam-policy-binding PROJECT_NAME 
  
  --member "serviceAccount:SERVICE_ACCOUNT" 
  
  --role roles/servicemanagement.serviceController

  자세한 내용은 역할 및 권한이란 무엇인가요?를 참조하세요.

VM 인스턴스에 Docker 설치

VM 인스턴스에 Docker를 설치하려면 다음 안내를 따르세요.

1. 다음 명령어를 실행하여 프로젝트의 영역을 설정합니다.

   gcloud config set compute/zone YOUR_INSTANCE_ZONE
   

   YOUR_INSTANCE_ZONE을 인스턴스가 실행되는 영역으로 바꿉니다.

2. 다음 명령어를 사용하여 인스턴스에 연결합니다.

   gcloud compute ssh INSTANCE_NAME
   

   INSTANCE_NAME을 VM 인스턴스 이름으로 바꿉니다.

3. Docker 저장소를 설정하려면 Docker 문서를 참조하세요. VM 인스턴스의 버전 및 아키텍처와 일치하는 단계를 따라야 합니다.
   • Jessie 또는 그 이상
   • x86_64/amd64

Docker 컨테이너에서 API 및 ESP 실행

ESP는 백엔드 코드 앞에 위치하는 nginx 기반 프록시입니다. 이 프록시는 수신 트래픽을 처리하여 인증, API 키 관리, 로깅, 기타 Endpoints API 관리 기능을 제공합니다.

Docker 컨테이너에 샘플 API 및 ESP를 설치 및 실행하려면 다음 안내를 따르세요.

1. esp_net이라는 자체 컨테이너 네트워크를 만듭니다.

   sudo docker network create --driver bridge esp_net
   

2. 샘플 API를 제공하는 샘플 Echo 서버를 실행합니다.
   자바

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-java:1.0
   

   Python

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-python:1.0
   

   Go

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-go:1.0
   

   PHP

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-php:1.0
   

   Ruby

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-ruby:1.0
   

   NodeJS

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-node:1.0
   

3. 사전 패키징된 공개 ESP Docker 컨테이너를 실행합니다. ESP 시작 옵션에서 SERVICE_NAME은 서비스 이름으로 바꿉니다. 이 이름은 OpenAPI 문서의 host 필드에 구성한 것과 같은 이름입니다.

   sudo docker run \
       --name=esp \
       --detach \
       --publish=80:8080 \
       --net=esp_net \
       gcr.io/endpoints-release/endpoints-runtime:1 \
       --service=SERVICE_NAME \
       --rollout_strategy=managed \
       --backend=echo:8080
   

   --rollout_strategy=managed 옵션은 ESP가 배포된 최신 서비스 구성을 사용하도록 구성합니다. 이 옵션을 지정하면 새 서비스 구성을 배포하고 최대 5분 후 ESP가 변경사항을 감지하고 자동으로 사용하기 시작합니다. ESP에 사용할 특정 구성 ID 대신 이 옵션을 지정하는 것이 좋습니다. 위에 사용된 다른 ESP 옵션에 대한 자세한 내용은 ESP 시작 옵션을 참조하세요.

오류 메시지가 표시되면 Compute Engine에서 Endpoints 문제해결을 참조하세요.

자세한 내용은 API 백엔드 배포를 참조하세요.

IP 주소를 사용하여 요청 보내기

샘플 API 및 ESP가 Compute Engine 인스턴스에서 실행되면 로컬 머신에서 API로 요청을 전송할 수 있습니다.

API 키 만들기 및 환경 변수 설정

샘플 코드에는 API 키가 필요합니다. 요청을 간소화하려면 API 키의 환경 변수를 설정합니다.

1. API에 사용한 프로젝트와 동일한 Google Cloud 프로젝트의 API 사용자 인증 정보 페이지에서 API 키를 만듭니다. 다른 Google Cloud 프로젝트에서 API 키를 만들려면 Google Cloud 프로젝트에서 API 사용 설정을 참조하세요.

   사용자 인증 정보 페이지로 이동

2. 사용자 인증 정보 만들기를 클릭한 후 API 키를 선택합니다.
3. 클립보드에 키를 복사합니다.
4. 닫기를 클릭합니다.
5. 로컬 컴퓨터에서 API 키를 환경 변수에 붙여 넣어 할당합니다.
   • Linux 또는 mac OS: export ENDPOINTS_KEY=AIza...
   • Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

요청 전송

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content

API가 받은 메시지를 되풀이하고 다음과 같이 응답합니다.

{
  "message": "hello world"
}

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

이제 Endpoints에 API를 배포하고 테스트를 마쳤습니다.

Endpoints용 DNS 구성

API의 Endpoints 서비스 이름은 .endpoints.YOUR_PROJECT_ID.cloud.goog 도메인에 있으므로 openapi.yaml 파일에서 구성을 약간 변경하여 정규화된 도메인 이름(FQDN)으로 사용할 수 있습니다. 이렇게 하면 IP 주소 대신 echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog를 사용하여 샘플 API에 요청을 보낼 수 있습니다.

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

1. OpenAPI 구성 파일인 openapi.yaml을 열고 다음 스니펫에 표시된 것처럼 들여쓰기가 적용되거나 중첩되지 않은 파일의 최상위 수준에서 x-google-endpoints 속성을 추가합니다.

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   x-google-endpoints:
   - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
     target: "IP_ADDRESS"

2. name 속성에서 YOUR_PROJECT_ID를 프로젝트 ID로 바꿉니다.
3. target 속성에서 IP_ADDRESS를 샘플 API에 요청을 보낼 때 사용한 IP 주소로 바꿉니다.
4. 업데이트된 OpenAPI 구성 파일을 Service Management에 배포합니다.

   gcloud endpoints services deploy openapi.yaml
   

예를 들어 openapi.yaml 파일이 다음과 같이 구성되었다고 가정합니다.

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

위의 gcloud 명령어를 사용하여 openapi.yaml 파일을 배포하면 Service Management는 대상 IP 주소 192.0.2.1로 해석되는 DNS A 레코드 echo-api.endpoints.my-project-id.cloud.goog를 생성합니다. 새 DNS 구성이 전파되는 데 몇 분 정도 걸릴 수 있습니다.

SSL 구성

DNS 및 SSL을 구성하는 방법에 대한 자세한 내용은 Endpoints에 SSL 사용 설정을 참조하세요.

FQDN을 사용하여 요청 보내기

• Linux 또는 mac OS:

  curl --request POST \
      --header "content-type:application/json" \
      --data '{"message":"hello world"}' \
      "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"

• Windows PowerShell:

  (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

API 활동 추적

API 활동을 추적하는 방법은 다음과 같습니다.

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

   Endpoints 서비스 페이지로 이동

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

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

   로그 탐색기 페이지로 이동

API의 개발자 포털 만들기

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