ESP를 사용하여 Kubernetes용 Cloud Endpoints 시작하기

---

OpenAPI | gRPC

이 가이드에서는 샘플 API와 Extensible Service Proxy(ESP)를 구성하고 이를 Google Cloud에 없는 Kubernetes 클러스터에 배포하는 방법을 설명합니다. Google Kubernetes Engine(GKE)을 사용하려면 GKE에서 Endpoints 시작하기를 참조하세요.

샘플 코드의 REST API는 OpenAPI 사양을 사용하여 기술됩니다. 또한 이 가이드에서는 API에 요청을 보내기 위한 API 키를 만드는 방법도 설명합니다.

이 튜토리얼은 Container Registry에 저장된 샘플 코드와 ESP의 사전 빌드된 컨테이너 이미지를 사용합니다. 컨테이너에 익숙하지 않은 경우 자세한 내용은 다음을 참조하세요.

• 컨테이너화된 웹 애플리케이션 배포
• Kubernetes 컨테이너 이미지

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

목표

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

1부

1. Google Cloud 프로젝트를 설정합니다. 시작하기 전에를 참조하세요.
2. 가이드에 사용된 소프트웨어를 설치하고 구성합니다. 필수 소프트웨어 설치 및 구성을 참조하세요.
3. 필요한 경우 샘플 코드를 다운로드합니다. 샘플 코드 가져오기를 참조하세요.
4. Kubernetes 구성 파일을 다운로드합니다. Kubernetes 구성 파일 가져오기를 참조하세요.
5. Endpoints를 구성하는 데 사용되는 openapi.yaml 파일을 구성합니다. Endpoints 구성을 참조하세요.
6. Endpoints 구성을 배포하여 Cloud Endpoints 서비스를 만듭니다. Endpoints 구성 배포를 참조하세요.
7. Endpoints 서비스에 대한 사용자 인증 정보를 만듭니다. 서비스에 대한 사용자 인증 정보 만들기를 참조하세요.
8. API 및 ESP를 클러스터에 배포합니다. API 백엔드 배포를 참조하세요.
9. 서비스의 외부 IP 주소를 가져옵니다. 외부 IP 주소 가져오기를 참조하세요.
10. IP 주소를 사용하여 API에 요청을 보냅니다. IP 주소를 사용하여 요청 보내기를 참조하세요.
11. API 활동을 추적합니다. API 활동 추적을 참조하세요.

2부

1. 샘플 API용 DNS 레코드를 구성합니다. Endpoints용 DNS 구성을 참조하세요.
2. 도메인 이름을 사용하여 API에 요청을 보냅니다. FQDN을 사용하여 요청 보내기를 참조하세요.

삭제

완료되었으면 삭제를 참조하여 Google Cloud 계정에 대한 요금 청구를 방지하세요.

비용

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

• 엔드포인트

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

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

시작하기 전에

이 가이드에서는 이미 Minikube 또는 Kubernetes 클러스터를 설정했다고 가정합니다. 자세한 내용은 Kubernetes 문서를 참조하세요.

1. Google Cloud 계정에 로그인합니다. Google Cloud를 처음 사용하는 경우 계정을 만들고 Google 제품의 실제 성능을 평가해 보세요. 신규 고객에게는 워크로드를 실행, 테스트, 배포하는 데 사용할 수 있는 $300의 무료 크레딧이 제공됩니다.

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

   참고: 이 절차에서 생성한 리소스를 유지하지 않으려면 기존 프로젝트를 선택하지 말고 프로젝트를 새로 만드세요. 작업이 끝나면 프로젝트를 삭제하여 프로젝트와 관련된 모든 리소스를 삭제할 수 있습니다.

   프로젝트 선택기로 이동

3. Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

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

   참고: 이 절차에서 생성한 리소스를 유지하지 않으려면 기존 프로젝트를 선택하지 말고 프로젝트를 새로 만드세요. 작업이 끝나면 프로젝트를 삭제하여 프로젝트와 관련된 모든 리소스를 삭제할 수 있습니다.

   프로젝트 선택기로 이동

5. Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

6. Google Cloud 프로젝트 ID는 나중에 필요하므로 적어 둡니다.

필수 소프트웨어 설치 및 구성

이 튜토리얼에서는 gcloud CLI를 사용하여 프로젝트를 관리할 수 있도록 Google Cloud CLI를 설치합니다. Kubernetes 클러스터를 대상으로 명령어를 실행하기 위한 명령줄 인터페이스인 kubectl을 사용합니다. 또한 API를 테스트할 방법이 필요합니다.

다음 절차에서 필요한 소프트웨어가 이미 설치되어 있으면 다음 단계로 진행합니다.

필수 소프트웨어를 설치 및 구성하는 방법은 다음과 같습니다.

1. 애플리케이션이 요청을 샘플 API로 전송하도록 해야 합니다.

   • Linux 및 macOS 사용자: 이 가이드에서 제공하는 예시에서는 일반적으로 운영체제에 사전 설치되어 제공되는 curl을 사용합니다. curl이 없으면 curl 릴리스 및 다운로드 페이지에서 다운로드할 수 있습니다.
   • Windows 사용자: 이 가이드에서 제공하는 예시에서는 PowerShell 3.0 이상에서 지원되는 Invoke-WebRequest를 사용합니다.
2. gcloud CLI를 설치하고 초기화합니다.
3. gcloud CLI를 업데이트하고 Endpoints 구성요소를 설치합니다.

   gcloud components update

4. Google Cloud CLI(gcloud)에 Google Cloud의 데이터 및 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.

   gcloud auth login

   새 탭이 열리면 계정을 선택합니다.
5. 기본 프로젝트를 프로젝트 ID로 설정합니다.

   gcloud config set project YOUR_PROJECT_ID

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

6. kubectl을 설치합니다.

   gcloud components install kubectl

7. 애플리케이션 기본 사용자 인증 정보에 사용할 새로운 사용자 인증 정보를 가져옵니다. 사용자 인증 정보는 kubectl을 승인합니다.

   gcloud auth application-default login

8. 새 탭이 열리면 계정을 선택합니다.
9. 다음 명령어를 실행하여 Kubernetes 클라이언트가 제대로 구성되었는지 확인합니다.

   kubectl version

   다음과 비슷한 출력이 표시됩니다.

   
      Client Version: version.Info{Major:"1", Minor:"8", GitVersion:"v1.8.4",
        GitCommit:"9befc2b8928a9426501d3bf62f72849d5cbcd5a3", GitTreeState:"clean",
        BuildDate:"2017-11-20T05:28:34Z", GoVersion:"go1.8.3", Compiler:"gc",
        Platform:"linux/amd64"}
      Server Version: version.Info{Major:"1", Minor:"7+",
        GitVersion:"v1.7.8-gke.0",
        GitCommit:"a7061d4b09b53ab4099e3b5ca3e80fb172e1b018", GitTreeState:"clean",
        BuildDate:"2017-10-10T18:48:45Z", GoVersion:"go1.8.3", Compiler:"gc",
        Platform:"linux/amd64"}
      

샘플 코드 다운로드

필요한 경우 샘플 코드를 다운로드합니다. 이 가이드에서는 사전 빌드된 컨테이너 이미지를 배포하므로 샘플 코드에서 컨테이너를 빌드할 필요가 없습니다. 그러나 샘플 API의 작동 방식을 이해하는 데 유용한 여러 언어로 제공되는 샘플 코드를 다운로드할 수 있습니다.

샘플 코드를 다운로드하려면 다음 안내를 따르세요.

자바

샘플 API를 클론 또는 다운로드하려면 다음 안내를 따르세요.

1. 샘플 앱 저장소를 로컬 머신에 복제합니다.

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

   또는 zip 파일로 샘플을 다운로드하고 압축을 풉니다.

2. 샘플 코드가 있는 디렉터리로 변경합니다.

   cd java-docs-samples/endpoints/getting-started

Python

샘플 API를 클론 또는 다운로드하려면 다음 안내를 따르세요.

1. 샘플 앱 저장소를 로컬 머신에 복제합니다.

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

   또는 zip 파일로 샘플을 다운로드하고 압축을 풉니다.

2. 샘플 코드가 있는 디렉터리로 변경합니다.

   cd python-docs-samples/endpoints/getting-started

Go

샘플 API를 클론 또는 다운로드하려면 다음 안내를 따르세요.

1. GOPATH 환경 변수가 설정되어 있는지 확인합니다.
2. 샘플 앱 저장소를 로컬 머신에 클론합니다.

   go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

3. 샘플 코드가 있는 디렉터리로 변경합니다.

   cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

PHP

샘플 API를 클론 또는 다운로드하려면 다음 안내를 따르세요.

1. 샘플 앱 저장소를 로컬 머신에 복제합니다.

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

   또는 zip 파일로 샘플을 다운로드하고 압축을 풉니다.

2. 샘플 코드가 있는 디렉터리로 변경합니다.

   cd php-docs-samples/endpoints/getting-started

Ruby

샘플 API를 클론 또는 다운로드하려면 다음 안내를 따르세요.

1. 샘플 앱 저장소를 로컬 머신에 복제합니다.

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

   또는 zip 파일로 샘플을 다운로드하고 압축을 풉니다.

2. 샘플 코드가 있는 디렉터리로 변경합니다.

   cd ruby-docs-samples/endpoints/getting-started

NodeJS

샘플 API를 클론 또는 다운로드하려면 다음 안내를 따르세요.

1. 샘플 앱 저장소를 로컬 머신에 복제합니다.

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

   또는 zip 파일로 샘플을 다운로드하고 압축을 풉니다.

2. 샘플 코드가 있는 디렉터리로 변경합니다.

   cd nodejs-docs-samples/endpoints/getting-started

Kubernetes 구성 파일 가져오기

1. 이 튜토리얼에서 사용된 yaml 파일이 포함된 GitHub 저장소를 로컬 머신에 클론합니다.

    git clone https://github.com/googlecloudplatform/endpoints-samples

   또는 zip 파일로 샘플을 다운로드하고 압축을 풉니다.

2. 구성 파일이 있는 디렉터리로 변경합니다.

    cd endpoints-samples/kubernetes

Endpoints 구성

샘플 코드에는 OpenAPI 사양 v2.0을 기반으로 하는 OpenAPI 구성 파일인 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"

   다음에 유의하세요.

   • 구성 샘플은 수정이 필요한 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에 성공적으로 요청을 전송할 수 있습니다. echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog를 FQDN으로 구성하는 방법에 관한 상세 정보는 Endpoints용 DNS 구성을 참고하세요.

Endpoints 구성 배포

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

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

1. 현재 위치가 endpoints-samples/k8s 디렉터리인지 확인합니다.
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 Console의 Endpoints > 서비스 페이지에서 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.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 서비스를 참조하세요.

서비스에 대한 사용자 인증 정보 만들기

API 관리 기능을 제공하기 위해 ESP 및 ESPv2에는 서비스 인프라의 서비스가 필요합니다. 이러한 서비스를 호출하려면 ESP와 ESPv2가 액세스 토큰을 사용해야 합니다. GKE, Compute Engine 또는 App Engine 가변형 환경과 같은 Google Cloud 환경에 ESP 또는 ESPv2를 배포하면 ESP와 ESPv2가 Google Cloud 메타데이터 서비스를 통해 액세스 토큰을 얻습니다.

로컬 데스크톱, 온프레미스 Kubernetes 클러스터, 기타 클라우드 제공업체와 같은 Google Cloud 환경이 아닌 환경에 ESP 또는 ESPv2를 배포하는 경우 비공개 키가 포함되어 있는 서비스 계정 JSON 파일을 제공해야 합니다. ESP와 ESPv2는 서비스 계정을 사용해 액세스 토큰을 생성하여 API 관리에 필요한 서비스를 호출합니다.

Google Cloud Console 또는 Google Cloud CLI를 사용하여 서비스 계정과 비공개 키 파일을 만들 수 있습니다.

콘솔

1. Google Cloud Console에서 서비스 계정 페이지를 엽니다.

   서비스 계정 페이지로 이동

2. 프로젝트 선택을 클릭합니다.
3. API가 생성된 프로젝트를 선택하고 열기를 클릭합니다.
4. + 서비스 계정 만들기를 클릭합니다.
5. 서비스 계정 이름 필드에 서비스 계정 이름을 입력합니다.
6. 만들기를 클릭합니다.
7. 계속을 클릭합니다.
8. 완료를 클릭합니다.
9. 새로 만든 서비스 계정의 이메일 주소를 클릭합니다.
10. 키를 클릭합니다.
11. 키 추가를 클릭한 후 새 키 만들기를 클릭합니다.

12. 만들기를 클릭합니다. JSON 키 파일이 컴퓨터에 다운로드됩니다.

    키 파일은 서비스 계정으로 인증하는 데 사용될 수 있으므로 키 파일을 안전하게 저장해야 합니다. 원하는 경우 이 파일을 이동하고 이름을 변경할 수 있습니다.

13. 닫기를 클릭합니다.

gcloud

1. 다음을 입력하여 Google Cloud 프로젝트의 프로젝트 ID를 표시합니다.

   gcloud projects list

2. 다음 명령어에서 PROJECT_ID를 바꿔 기본 프로젝트를 API가 있는 프로젝트로 설정합니다.

   gcloud config set project PROJECT_ID

   중요: API가 있는 동일한 프로젝트에서 서비스 계정을 만들어야 합니다.

3. Google Cloud CLI(gcloud)에 Google Cloud의 데이터 및 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.

   gcloud auth login

   계정이 2개 이상이면 API가 포함된 Google Cloud 프로젝트에 있는 계정을 선택해야 합니다. gcloud auth list를 실행하면 선택한 계정이 프로젝트의 활성 계정으로 표시됩니다.

4. 서비스 계정을 만들려면 다음 명령어를 실행합니다. 여기서 SERVICE_ACCOUNT_NAME과 My Service Account는 사용하려는 이름과 표시 이름으로 바꿉니다.

   gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
      --display-name "My Service Account"

   이 명령어는 서비스 계정의 이메일 주소를 다음 형식으로 할당합니다.

   SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

   다음 명령어에 이 이메일 주소가 필요합니다.

5. 서비스 계정 키 파일을 만듭니다.

   gcloud iam service-accounts keys create ~/service-account-creds.json \
      --iam-account SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

필수 IAM 역할 추가

이 섹션에서는 ESP 및 ESPv2에 사용되는 IAM 리소스와 연결된 서비스 계정이 이러한 리소스에 액세스하는 데 필요한 IAM 역할을 설명합니다.

엔드포인트 서비스 구성

ESP 및 ESPv2는 엔드포인트 서비스 구성을 사용하는 Service Control을 호출합니다. 엔드포인트 서비스 구성은 IAM 리소스입니다. ESP 및 ESPv2가 여기에 액세스하려면 서비스 컨트롤러 역할이 필요합니다.

IAM 역할은 프로젝트가 아닌 엔드포인트 서비스 구성에 있습니다. 한 프로젝트에 여러 엔드포인트 서비스 구성이 포함될 수 있습니다.

다음 gcloud 명령어를 사용하여 엔드포인트 서비스 구성의 연결된 서비스 계정에 역할을 추가합니다.

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/servicemanagement.serviceController

여기서
* SERVICE_NAME은 엔드포인트 서비스 이름입니다.
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com은 연결된 서비스 계정입니다.

Cloud Trace

ESP 및 ESPv2는 Cloud Trace 서비스를 호출하여 Trace를 프로젝트로 내보냅니다. 이 프로젝트를 trace 프로젝트라고 부릅니다. ESP에서 trace 프로젝트와 엔드포인트 서비스 구성을 소유하는 프로젝트는 동일합니다. ESPv2에서 trace 프로젝트는 --tracing_project_id 플래그로 지정될 수 있으며, 기본적으로 배포 프로젝트로 지정됩니다.

ESP 및 ESPv2에 Cloud Trace를 사용 설정하려면 Cloud Trace 에이전트 역할이 필요합니다.

다음 gcloud 명령어를 사용하여 연결 서비스 계정에 역할을 추가합니다.

gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/cloudtrace.agent

여기서
* TRACING_PROJECT_ID는 trace 프로젝트 ID입니다.
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com은 연결 서비스 계정입니다. 자세한 내용은 역할 및 권한이란 무엇인가요?를 참조하세요.

명령어에 대한 자세한 내용은 gcloud iam service-accounts를 참조하세요.

API 백엔드 배포

지금까지 OpenAPI 문서를 Service Management에 배포했지만 아직 API 백엔드를 제공할 코드를 배포하지 않았습니다. 이 섹션은 샘플 API와 ESP를 위해 사전 빌드된 컨테이너를 Kubernetes에 배포하는 과정을 단계별로 설명합니다.

필수 권한 확인

클러스터와 연결된 서비스 계정에 필요한 권한을 부여합니다.

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member "serviceAccount:SERVICE_ACCOUNT" \
  --role roles/servicemanagement.serviceController

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

ESP에 서비스 사용자 인증 정보 제공

컨테이너 내에서 실행되는 ESP는 service-account-creds.json 파일에 로컬로 저장된 사용자 인증 정보에 액세스해야 합니다. ESP가 사용자 인증 정보에 액세스할 수 있도록 Kubernetes 보안 비밀을 만들고 이 Kubernetes 보안 비밀을 Kubernetes 볼륨으로 마운트합니다.

Kubernetes 보안 비밀을 만들고 볼륨을 마운트하려면 다음 안내를 따르세요.

1. JSON 파일의 이름을 service-account-creds.json으로 바꾸고 endpoints-samples/k8s에 복사합니다(다른 디렉터리에 다운로드된 경우). 이렇게 하면 이름이 esp_echo_http.yaml 배포 매니페스트 파일에 지정된 옵션과 일치합니다.

2. 현재 위치가 endpoints-samples/k8s 디렉터리인지 확인합니다.

3. 서비스 계정 사용자 인증 정보로 Kubernetes 보안 비밀을 만듭니다.

   kubectl create secret generic service-account-creds \
     --from-file=service-account-creds.json
   

   성공하면 secret "service-account-creds" created 메시지가 표시됩니다.

Kubernetes에 API와 ESP를 배포하기 위해 사용하는 배포 매니페스트 파일에는 다음 파일의 두 섹션에서 볼 수 있듯이 보안 비밀 볼륨이 이미 포함되어 있습니다.

volumes:
  - name: service-account-creds
    secret:
      secretName: service-account-creds

volumeMounts:
  - mountPath: /etc/nginx/creds
    name: service-account-creds
    readOnly: true

서비스 이름 구성 및 서비스 시작

gcloud endpoints services deploy 명령어를 사용하여 이전에 배포한 구성을 찾으려면 ESP가 서비스의 이름을 알아야 합니다.

서비스 이름을 구성하고 서비스를 시작하려면 다음 안내를 따르세요.

1. 배포 매니페스트 파일인 esp_echo_http.yaml을 열고 ESP 시작 옵션의 SERVICE_NAME을 서비스 이름으로 바꿉니다. 이 이름은 OpenAPI 문서의 host 필드에 구성한 것과 같은 이름입니다. 예를 들면 다음과 같습니다.

   "--service=echo-api.endpoints.example-project-12345.cloud.goog"

   containers:
     - name: esp
       image: gcr.io/endpoints-release/endpoints-runtime:1
       args: [
         "--http_port", "8080",
         "--backend", "127.0.0.1:8081",
         "--service", "SERVICE_NAME",
         "--rollout_strategy", "managed",
         "--service_account_key", "/etc/nginx/creds/service-account-creds.json",
       ]

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

   참고: MiniKube를 사용하는 경우 구성 파일에서 서비스의 type 필드를 LoadBalancer에서 NodePort로 변경해야 합니다.
   참고: 위의 컨테이너 사양의 imagePullPolicy를 Always로 설정하는 것이 좋습니다. 이렇게 하면 새로 만든 포드가 항상 최신 버전의 ESP를 가져올 수 있습니다. 자세한 내용은 구성 권장사항을 참조하세요. 새 버전의 ESP가 출시되면 모든 포드를 순차적으로 다시 시작하여 최신 버전이 사용되도록 할 수 있습니다.

2. 서비스를 시작하여 Kubernetes에 Endpoints 서비스를 배포합니다.

   kubectl create -f echo.yaml

   다음과 유사한 오류 메시지가 표시되는 경우:

   The connection to the server localhost:8080 was refused - did you specify the right host or port?

   kubectl이 올바르게 구성되지 않았음을 나타냅니다. 자세한 내용은 kubectl 구성을 참조하세요.

자세한 내용은 Kubernetes에 Endpoints 배포를 참조하세요.

서비스의 외부 IP 주소 가져오기

Minikube를 사용하는 경우 IP 주소를 사용하여 요청 보내기로 건너뛰세요.

외부 IP 주소가 준비되려면 컨테이너에서 서비스를 시작한 후 몇 분 정도 걸릴 수 있습니다.

서비스의 외부 IP 주소를 보려면 다음 안내를 따르세요.

1. 다음 명령어를 실행합니다.

   kubectl get service

2. EXTERNAL-IP의 값을 기록해 둡니다. 샘플 API에 요청을 전송할 때 이 IP 주소를 사용합니다.

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

샘플 API가 컨테이너 클러스터에서 실행되면 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..."

minikube로 요청 보내기

다음 명령어는 이전에 설정된 ENDPOINTS_KEY 환경 변수를 사용합니다.

Linux 또는 mac OS

NODE_PORT=`kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}'`
MINIKUBE_IP=`minikube ip`
curl --request POST \
    --header "content-type:application/json" \
    --data '{"message":"hello world"}' \
    ${MINIKUBE_IP}:${NODE_PORT}/echo?key=${ENDPOINTS_KEY}

PowerShell

$Env:NODE_PORT=$(kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}')
$Env:MINIKUBE_IP=$(minikube ip)
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://$Env:MINIKUBE_IP:$Env:NODE_PORT/echo?key=$Env:ENDPOINTS_KEY").Content

다른 Kubernetes 클러스터로 요청 보내기

Linux 또는 mac OS

curl을 사용하여 이전에 설정한 ENDPOINTS_KEY 환경 변수로 HTTP 요청을 보냅니다. IP_ADDRESS는 인스턴스의 외부 IP 주소로 바꿉니다.

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

앞의 curl에서 각 옵션은 다음을 지정합니다.

• --data 옵션은 API에 게시할 데이터를 지정합니다.
• --header 옵션은 데이터가 JSON 형식임을 지정합니다.

PowerShell

Invoke-WebRequest를 사용하여 이전에 설정한 ENDPOINTS_KEY 환경 변수로 HTTP 요청을 보냅니다. IP_ADDRESS는 인스턴스의 외부 IP 주소로 바꿉니다.

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

위의 예시에서 처음 두 행은 백틱으로 끝납니다. PowerShell에 예를 붙여넣을 때 백틱 다음에 공백이 없어야 합니다. 요청 예시에 사용된 옵션에 대한 자세한 내용은 Microsoft 문서의 Invoke-WebRequest를 참조하세요.

타사 앱

Chrome 브라우저 확장 프로그램 Postman과 같은 타사 애플리케이션을 사용하여 요청을 보낼 수 있습니다.

• HTTP 동사로 POST를 선택합니다.
• 헤더에 키 content-type 및 값 application/json을 선택합니다.
• 본문에 다음을 입력합니다.
  {"message":"hello world"}
• URL에 환경 변수가 아닌 실제 API 키를 사용합니다. 예를 들면 다음과 같습니다.
  http://192.0.2.0:80/echo?key=AIza...

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

{
  "message": "hello world"
}

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

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

참고: 이 가이드에서 마음에 든 부분을 알려주시려면 이 페이지의 하단에서 의견을 제출해주세요. 여러분의 의견은 이 가이드를 개선하는 데 도움이 됩니다.
오류가 발생하면 google-cloud-endpoints Google 그룹에 가입하여 어떤 문제가 있었는지 알려주세요. 다른 Endpoints 사용자와 이 그룹을 모니터링하는 Google 엔지니어가 답변해 드립니다.

API 활동 추적

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

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

   Endpoints 서비스 페이지로 이동

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

2. 로그 탐색기 페이지에서 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으로 요청 보내기

이제 샘플 API에 대한 DNS 레코드가 구성되었으므로 앞에서 설정한 FQDN(YOUR_PROJECT_ID를 프로젝트 ID로 바꿈)과 ENDPOINTS_KEY 환경 변수를 사용하여 요청을 보냅니다.

• 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의 개발자 포털 만들기

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

삭제

이 튜토리얼에서 사용된 리소스 비용이 Google Cloud 계정에 청구되지 않도록 하려면 리소스가 포함된 프로젝트를 삭제하거나 프로젝트를 유지하고 개별 리소스를 삭제하세요.

• Kubernetes 서비스 및 배포 삭제:

  kubectl delete -f esp_echo_http.yaml

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

다음 단계

• Endpoints Google Kubernetes Engine을 배포하는 방법 알아보기
• Docker 이미지 빌드 방법 알아보기
• API를 다른 개발자와 공유
• 인증에 대해 자세히 알아보기
• 커뮤니티 지원 옵션에 대해 알아보기
• GKE 배포 문제해결