ESPv2를 사용하여 Compute Engine용 Endpoints 시작하기

이 가이드에서는 Compute EngineDocker 컨테이너에서 Extensible Service Proxy V2 베타(ESPv2 베타)를 사용하여 간단한 예시 gRPC 서비스를 배포하는 방법을 보여줍니다.

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

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

목표

아래의 개략적인 작업 목록을 사용하여 가이드를 진행합니다. API에 성공적으로 요청을 보내려면 모든 태스크를 수행해야 합니다.

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

비용

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

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

이 가이드를 마치면 만든 리소스를 삭제하여 비용이 계속 청구되지 않게 할 수 있습니다. 자세한 내용은 삭제를 참조하세요.

시작하기 전에

  1. Google 계정으로 로그인합니다.

    아직 계정이 없으면 새 계정을 등록하세요.

  2. Cloud Console의 프로젝트 선택기 페이지에서 Cloud 프로젝트를 선택하거나 만듭니다.

    프로젝트 선택기 페이지로 이동

  3. Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다. 프로젝트에 결제가 사용 설정되어 있는지 확인하는 방법을 알아보세요.

  4. 나중에 필요하므로 프로젝트 ID를 기록해 둡니다.
  5. Cloud SDK를 설치하고 초기화합니다.
  6. Cloud SDK를 업데이트하고 Endpoints 구성요소를 설치합니다.
    gcloud components update
  7. Cloud SDK(gcloud)에 Google Cloud의 데이터 및 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.
    gcloud auth login
    새 브라우저 탭이 열리면 계정을 선택합니다.
  8. 기본 프로젝트를 프로젝트 ID로 설정합니다.
    gcloud config set project YOUR_PROJECT_ID

    YOUR_PROJECT_ID는 프로젝트 ID로 바꿉니다. 다른 Google Cloud 프로젝트가 있고, gcloud를 사용하여 이를 관리하려면 Cloud SDK 구성 관리를 참조하세요.

  9. gRPC Python 빠른 시작의 단계를 따라 gRPC와 gRPC 도구를 설치합니다.

이 가이드를 마치면 만든 리소스를 삭제하여 비용이 계속 청구되지 않게 할 수 있습니다. 자세한 내용은 삭제를 참조하세요.

Compute Engine 인스턴스 만들기

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

  1. Cloud Console에서 VM 인스턴스 페이지로 이동합니다.

    VM 인스턴스 페이지로 이동

  2. 인스턴스 만들기를 클릭합니다.
  3. 방화벽 섹션에서 HTTP 트래픽 허용HTTPS 트래픽 허용을 선택합니다.
  4. 만들기를 클릭하여 인스턴스를 만듭니다.
  5. 필수 옵션 집합이 표시된 VM 인스턴스 만들기 창의 스크린샷

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

  6. VM 인스턴스에 연결할 수 있는지 확인합니다.
    1. 가상 머신 인스턴스 목록에서 연결할 인스턴스 행의 SSH를 클릭합니다.
    2. 이제 터미널을 사용하여 Debian 인스턴스에서 Linux 명령어를 실행할 수 있습니다.
    3. exit를 입력하여 인스턴스 연결을 해제합니다.
  7. 나중에 필요하므로 인스턴스 이름, 영역, 외부 IP 주소를 기록해 둡니다.

Endpoints 구성

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

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

  1. 서비스 .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를 변경합니다.

  2. 다음 단계에 따라 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를 사용하여 관리형 서비스를 만듭니다.

  1. 현재 위치가 api_descriptor.pbapi_config.yaml 파일이 있는 디렉터리인지 확인합니다.
  2. gcloud 명령줄 도구에 현재 사용 중인 기본 프로젝트가 Endpoints 구성을 배포하려는 Google Cloud 프로젝트인지 확인합니다. 잘못된 프로젝트에 서비스가 만들어지지 않도록 다음 명령어로 반환되는 프로젝트 ID를 확인합니다.
    gcloud config list project
    

    기본 프로젝트를 변경해야 하는 경우 다음 명령어를 실행합니다.

    gcloud config set project YOUR_PROJECT_ID
    
  3. gcloud 명령줄 도구를 사용하여 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 Console의 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 백엔드를 제공할 코드를 배포하지 않았습니다. 이 섹션에서는 VM 인스턴스에 Docker를 설정하고 API 백엔드 코드와 ESPv2 베타를 Docker 컨테이너에서 실행하는 방법을 단계별로 안내합니다.

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 및 ESPv2 베타 실행

클라이언트가 사용할 수 있도록 Docker 컨테이너에서 ESPv2 베타를 사용하여 샘플 gRPC 서비스를 실행하려면 다음 단계를 따르세요.

  1. VM 인스턴스에서 esp_net라는 자체 컨테이너 네트워크를 만듭니다.
    sudo docker network create --driver bridge esp_net
    
  2. 샘플 API를 제공하는 샘플 Bookstore 서버를 실행합니다.
    sudo docker run \
        --detach \
        --name=bookstore \
        --net=esp_net \
        gcr.io/endpointsv2/python-grpc-bookstore-server:1
    
  3. 사전 패키징된 ESPv2 베타 Docker 컨테이너를 실행합니다. ESPv2 베타 시작 옵션에서 SERVICE_NAME을 서비스 이름으로 바꿉니다. 이 이름은 api_config.yaml 파일의 name 필드에서 구성한 것과 같은 이름입니다. 예를 들면 bookstore.endpoints.example-project-12345.cloud.goog입니다.
    sudo docker run \
        --detach \
        --name=esp \
        --publish=80:9000 \
        --net=esp_net \
        gcr.io/endpoints-release/endpoints-runtime:2 \
        --service=SERVICE_NAME \
        --rollout_strategy=managed \
        --listener_port=9000 \
        --backend=grpc://bookstore:8000
    

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

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

API에 요청 보내기

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

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

gcloud compute instances list

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

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

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

  2. 작업 디렉토리를 다음과 같이 변경합니다.

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

  3. 종속 항목을 설치합니다.

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

  4. 샘플 API로 요청을 전송합니다.

    python bookstore_client.py --host SERVER_IP --port 80
    

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

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

삭제

이 가이드에서 사용한 리소스 비용이 Google Cloud Platform 계정에 청구되지 않도록 하는 방법은 다음과 같습니다.

  1. API를 삭제합니다.
    gcloud endpoints services delete SERVICE_NAME
    

    SERVICE_NAME을 서비스 이름으로 바꿉니다.

  2. Cloud Console에서 VM 인스턴스 페이지로 이동합니다.

    VM 인스턴스 페이지로 이동

  3. 삭제할 인스턴스의 체크박스를 클릭합니다.
  4. 삭제 를 클릭하여 인스턴스를 삭제합니다.

다음 단계