Halaman ini diterjemahkan oleh Cloud Translation API.

Menyiapkan gRPC Cloud Endpoints untuk Cloud Run dengan ESPv2

OpenAPI | gRPC

Halaman ini menunjukkan cara menyiapkan Cloud Endpoints untuk Cloud Run dengan backend gRPC. Endpoint menggunakan Extensible Service Proxy V2 (ESPv2) sebagai API gateway. Untuk menyediakan pengelolaan API untuk Cloud Run, Anda men-deploy penampung ESPv2 bawaan ke Cloud Run. Kemudian, Anda membantu mengamankan layanan dengan menggunakan IAM Cloud Run sehingga ESPv2 dapat memanggilnya.

Dengan penyiapan ini, ESPv2 mencegat semua permintaan ke layanan Anda dan melakukan pemeriksaan yang diperlukan (seperti autentikasi) sebelum memanggil layanan. Saat layanan merespons, ESPv2 akan mengumpulkan dan melaporkan telemetri, seperti yang ditunjukkan pada gambar di bawah. Anda dapat melihat metrik untuk layanan di halaman Endpoints > Services di Konsol Google Cloud.

Arsitektur endpoint

Untuk ringkasan Cloud Endpoints, lihat Tentang Endpoints dan Arsitektur Endpoints.

Bermigrasi ke ESPv2

Rilis Cloud Endpoints sebelumnya tidak mendukung gRPC di Cloud Run dengan ESP. Untuk menggunakan fitur ini, migrasikan ke Extensible Service Proxy V2.

Daftar Tugas

Gunakan daftar tugas berikut saat Anda mengerjakan tutorial ini. Semua tugas diperlukan untuk menyelesaikan tutorial ini.

Buat project Google Cloud, dan jika Anda belum men-deploy Cloud Run Anda sendiri, deploy contoh layanan gRPC backend. Lihat Sebelum memulai.
Menyiapkan nama host Cloud Run untuk layanan ESPv2. Lihat Menyimpan nama host Cloud Run.
Buat dokumen konfigurasi gRPC API yang menjelaskan API Anda, dan konfigurasikan rute ke Cloud Run. Lihat Mengonfigurasi Endpoint.
Deploy dokumen konfigurasi gRPC API untuk membuat layanan terkelola. Lihat Men-deploy konfigurasi Endpoint.
Build image Docker ESPv2 baru dengan konfigurasi layanan Endpoints Anda. Lihat Mem-build image ESPv2 baru.
Deploy container ESPv2 ke Cloud Run. Kemudian, berikan izin Identity and Access Management (IAM) kepada ESPv2 untuk memanggil layanan Anda. Lihat Men-deploy penampung ESPv2.
Memanggil layanan. Lihat Mengirim permintaan ke API.
Melacak aktivitas ke layanan Anda. Lihat Melacak aktivitas API.
Hindari tagihan pada akun Google Cloud Anda. Lihat Pembersihan.

Biaya

Dalam dokumen ini, Anda akan menggunakan komponen Google Cloud yang dapat ditagih berikut:

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga. Pengguna baru Google Cloud mungkin memenuhi syarat untuk mendapatkan uji coba gratis.

Setelah menyelesaikan tugas yang dijelaskan dalam dokumen ini, Anda dapat menghindari penagihan berkelanjutan dengan menghapus resource yang Anda buat. Untuk mengetahui informasi selengkapnya, lihat Pembersihan.

Sebelum memulai

Untuk menyiapkannya:

Di konsol Google Cloud, buka halaman Manage resources dan buat project.
Buka halaman Kelola resource
Pastikan penagihan diaktifkan untuk project Anda.
Pelajari cara mengaktifkan penagihan
Catat project ID karena diperlukan nanti. Di bagian lain halaman ini, project ID ini disebut sebagai ESP_PROJECT_ID.
Catat nomor project karena diperlukan nanti. Di bagian lain halaman ini, nomor project ini disebut sebagai ESP_PROJECT_NUMBER.
Download dan instal Google Cloud CLI.
Mendownload gcloud CLI
Ikuti langkah-langkah di panduan memulai gRPC Python untuk menginstal gRPC dan alat gRPC.
Deploy contoh layanan backend gRPC Cloud Run python-grpc-bookstore-server untuk digunakan dengan tutorial ini. Layanan gRPC menggunakan image container berikut:

gcr.io/endpointsv2/python-grpc-bookstore-server:2

Ikuti langkah-langkah di Panduan memulai: Men-deploy Container Contoh yang Di-build Sebelumnya untuk men-deploy layanan. Pastikan untuk mengganti image penampung yang ditentukan dalam panduan memulai tersebut dengan gcr.io/endpointsv2/python-grpc-bookstore-server:2

Catat region dan project ID tempat layanan Anda di-deploy. Di bagian lain halaman ini, project ID ini disebut sebagai BACKEND_PROJECT_ID. Nama layanan Cloud Run yang di-deploy disebut sebagai BACKEND_SERVICE_NAME. Nama host Cloud Run-nya disebut sebagai BACKEND_HOST_NAME.

Menyimpan nama host Cloud Run

Anda harus mencadangkan nama host Cloud Run untuk layanan ESPv2 agar dapat mengonfigurasi dokumen OpenAPI atau konfigurasi layanan gRPC. Untuk memesan nama host, Anda akan men-deploy container contoh ke Cloud Run. Kemudian, Anda akan deploy penampung ESPv2 ke layanan Cloud Run yang sama.

Pastikan gcloud CLI diberi otorisasi untuk mengakses data dan layanan Anda.
1. Log in.
```
gcloud auth login
```
2. Di tab browser baru yang terbuka, pilih akun yang memiliki peran Editor atau Pemilik di project Google Cloud yang Anda buat untuk men-deploy ESPv2 ke Cloud Run.

Tetapkan region.

gcloud config set run/region us-central1

Deploy image contoh gcr.io/cloudrun/hello ke Cloud Run. Ganti CLOUD_RUN_SERVICE_NAME dengan nama yang ingin Anda gunakan untuk layanan.

gcloud run deploy CLOUD_RUN_SERVICE_NAME \
    --image="gcr.io/cloudrun/hello" \
    --allow-unauthenticated \
    --platform managed \
    --project=ESP_PROJECT_ID

Setelah berhasil diselesaikan, perintah akan menampilkan pesan yang mirip dengan berikut:

Service [CLOUD_RUN_SERVICE_NAME] revision [CLOUD_RUN_SERVICE_NAME-REVISION_NUM] has been deployed and is serving traffic at CLOUD_RUN_SERVICE_URL

Misalnya, jika Anda menetapkan CLOUD_RUN_SERVICE_NAME ke gateway:

Service [gateway] revision [gateway-00001] has been deployed and is serving traffic at https://gateway-12345-uc.a.run.app

Dalam contoh ini, https://gateway-12345-uc.a.run.app adalah CLOUD_RUN_SERVICE_URL dan gateway-12345-uc.a.run.app adalah CLOUD_RUN_HOSTNAME.

Catat CLOUD_RUN_SERVICE_NAME dan CLOUD_RUN_HOSTNAME. Kemudian, Anda akan men-deploy ESPv2 ke layanan Cloud Run CLOUD_RUN_SERVICE_NAME. Anda menentukan CLOUD_RUN_HOSTNAME di kolom host pada dokumen OpenAPI.

Mengonfigurasi Endpoint

Contoh bookstore-grpc berisi file yang perlu Anda salin secara lokal dan konfigurasikan.

Buat file deskripsi protobuf mandiri dari file .proto layanan Anda:
1. Simpan salinan bookstore.proto dari repositori contoh ke direktori kerja Anda saat ini. File ini menentukan API layanan Toko Buku.
2. Buat direktori berikut di direktori kerja Anda: mkdir generated_pb2
3. Buat file deskripsi, api_descriptor.pb, menggunakan compiler buffering protokol protoc. Jalankan perintah berikut di direktori tempat Anda menyimpan bookstore.proto:
```
python3 -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
```
  Dalam perintah sebelumnya, --proto_path ditetapkan ke direktori kerja saat ini. Di lingkungan build gRPC, jika Anda menggunakan direktori yang berbeda untuk file input .proto, ubah --proto_path sehingga compiler menelusuri direktori tempat Anda menyimpan bookstore.proto.

Buat file teks bernama api_config.yaml di direktori kerja saat ini (direktori yang sama dengan yang berisi bookstore.proto). Untuk kemudahan, halaman ini merujuk ke dokumen konfigurasi gRPC API dengan nama file tersebut, tetapi Anda dapat menamainya dengan nama lain jika mau. Tambahkan konten berikut ke file:

# The configuration schema is defined by the service.proto file.
# https://github.com/googleapis/googleapis/blob/master/google/api/service.proto

type: google.api.Service
config_version: 3
name: CLOUD_RUN_HOSTNAME
title: Cloud Endpoints + Cloud Run gRPC
apis:
  - name: endpoints.examples.bookstore.Bookstore
usage:
  rules:
  # ListShelves methods can be called without an API Key.
  - selector: endpoints.examples.bookstore.Bookstore.ListShelves
    allow_unregistered_calls: true
backend:
  rules:
    - selector: "*"
      address: grpcs://BACKEND_HOST_NAME

Indentasi penting untuk format yaml. Misalnya, kolom name harus berada di tingkat yang sama dengan type.

Di kolom name, tentukan CLOUD_RUN_HOSTNAME, bagian nama host URL yang dicadangkan di atas dalam Mencadangkan nama host Cloud Run. Jangan sertakan ID protokol, seperti https:// atau grpcs://.
Di kolom address di bagian backend.rules, ganti BACKEND_HOST_NAME dengan layanan Cloud Run gRPC Bookstore yang sebenarnya yang dibuat di Sebelum memulai.

Catatan: Untuk menggunakan gRPC dengan TLS di Cloud Run, kolom address harus memiliki skema grpcs://, bukan https://.
Perhatikan nilai properti title dalam file api_config.yaml:
```
title: Cloud Endpoints + Cloud Run gRPC
```
Nilai properti title menjadi nama layanan Endpoints setelah Anda men-deploy konfigurasi.
Simpan dokumen konfigurasi gRPC API Anda.

Lihat Mengonfigurasi Endpoint untuk informasi selengkapnya.

Men-deploy konfigurasi Endpoint

Untuk men-deploy konfigurasi Endpoint, Anda menggunakan perintah gcloud endpoints services deploy. Perintah ini menggunakan Pengelolaan Layanan untuk membuat layanan terkelola.

Pastikan Anda berada di direktori tempat file api_descriptor.pb dan api_config.yaml berada.
Pastikan project default yang saat ini digunakan alat command line gcloud adalah project Google Cloud tempat Anda ingin men-deploy konfigurasi Endpoints. Validasi project ID yang ditampilkan dari perintah berikut untuk memastikan layanan tidak dibuat di project yang salah.
```
gcloud config list project
```
Jika Anda perlu mengubah project default, jalankan perintah berikut:
```
gcloud config set project YOUR_PROJECT_ID
```
Deploy file proto descriptor dan file konfigurasi menggunakan Google Cloud CLI:
```
gcloud endpoints services deploy api_descriptor.pb api_config.yaml
```
Saat membuat dan mengonfigurasi layanan, Manajemen Layanan akan menampilkan informasi ke terminal. Setelah deployment selesai, pesan yang mirip dengan berikut akan ditampilkan:
```
Service Configuration [CONFIG_ID] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
```
CONFIG_ID adalah ID konfigurasi layanan Endpoints unik yang dibuat oleh deployment. Contoh:
```
Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
```
Pada contoh sebelumnya, 2017-02-13r0 adalah ID konfigurasi layanan dan bookstore.endpoints.example-project.cloud.goog adalah nama layanan. ID konfigurasi layanan terdiri dari stempel tanggal yang diikuti dengan nomor revisi. Jika Anda men-deploy konfigurasi Endpoint lagi pada hari yang sama, nomor revisi akan bertambah di ID konfigurasi layanan.

Memeriksa layanan yang diperlukan

Setidaknya, Endpoint dan ESP mewajibkan layanan Google berikut diaktifkan:

Nama	Judul
`servicemanagement.googleapis.com`	Service Management API
`servicecontrol.googleapis.com`	Service Control API

Dalam sebagian besar kasus, perintah gcloud endpoints services deploy mengaktifkan layanan yang diperlukan ini. Namun, perintah gcloud berhasil diselesaikan, tetapi tidak mengaktifkan layanan yang diperlukan dalam situasi berikut:

Jika Anda menggunakan aplikasi pihak ketiga seperti Terraform, dan Anda tidak menyertakan layanan ini.
Anda men-deploy konfigurasi Endpoints ke project Google Cloud yang ada, tempat layanan ini dinonaktifkan secara eksplisit.

Gunakan perintah berikut untuk mengonfirmasi bahwa layanan yang diperlukan telah diaktifkan:

gcloud services list

Jika Anda tidak melihat layanan yang diperlukan tercantum, aktifkan layanan tersebut:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

Aktifkan juga layanan Endpoints Anda:

gcloud services enable ENDPOINTS_SERVICE_NAME

Untuk menentukan ENDPOINTS_SERVICE_NAME, Anda dapat:

Setelah men-deploy konfigurasi Endpoints, buka halaman Endpoints di Konsol Cloud. Daftar kemungkinan ENDPOINTS_SERVICE_NAME ditampilkan di kolom Nama layanan.
Untuk OpenAPI, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan di kolom host pada spesifikasi OpenAPI. Untuk gRPC, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan di kolom name pada konfigurasi Endpoint gRPC.

Untuk informasi selengkapnya tentang perintah gcloud, lihat layanan gcloud.

Jika Anda menerima pesan error, lihat Memecahkan masalah deployment konfigurasi Endpoints.

Lihat Men-deploy konfigurasi Endpoint untuk informasi tambahan.

Mem-build image ESPv2 baru

Build konfigurasi layanan Endpoints ke dalam image Docker ESPv2 baru. Nanti, Anda akan men-deploy image ini ke layanan Cloud Run yang direservasi.

Catatan:

Langkah ini wajib dilakukan.

Konfigurasi layanan harus dibuat ke dalam image docker baru karena Cloud Run adalah layanan skala ke nol. Artinya, jika tidak ada traffic, semua instance akan dihapus. Saat traffic meningkat, instance baru akan dibuat sesuai permintaan. Jenis pembuatan instance layanan ini juga disebut cold start. Lihat dokumentasi Konkurensi Cloud Run untuk mengetahui informasi selengkapnya.

Jika image docker tidak memiliki konfigurasi layanan yang terintegrasi, Cloud Run harus melakukan dua panggilan API ke Google ServiceManagement saat cold start. Panggilan ini akan mengurangi kuota Google ServiceManagement API Anda.

Dengan mem-build konfigurasi layanan ke dalam image docker ESPv2, Anda akan menghapus dua panggilan API dan menghindari dampak pada jumlah kuota untuk layanan Google ServiceManagement. Langkah ini juga mempercepat pembuatan instance layanan baru dan mengurangi latensi untuk permintaan yang menunggu instance baru.

Anda harus menjalankan ulang seluruh langkah ini dan men-deploy ulang penampung baru:

Setiap kali Anda mengubah dan men-deploy ulang konfigurasi layanan Endpoints. Jika tidak, perubahan pada konfigurasi layanan tidak akan diterapkan ke ESPv2.
Saat ESPv2 versi baru dirilis. Jika tidak, ESPv2 versi lama akan tetap di-deploy.

Untuk mem-build konfigurasi layanan ke dalam image docker ESPv2 baru:

Download skrip ini ke komputer lokal tempat gcloud CLI diinstal.

Catatan:
Skrip ini memerlukan bash. Jika tidak menggunakan macOS/Linux, Anda dapat menjalankannya di Cloud Shell, Compute Engine, atau Windows Subsystem for Linux.

Jalankan skrip dengan perintah berikut:

chmod +x gcloud_build_image

./gcloud_build_image -s CLOUD_RUN_HOSTNAME \
    -c CONFIG_ID -p ESP_PROJECT_ID

Untuk CLOUD_RUN_HOSTNAME, tentukan nama host URL yang Anda pesan di atas di Memesan nama host Cloud Run. Jangan sertakan ID protokol, https://.

Contoh:

chmod +x gcloud_build_image

./gcloud_build_image -s gateway-12345-uc.a.run.app \
    -c 2019-02-01r0 -p your-project-id

Skrip menggunakan perintah gcloud untuk mendownload konfigurasi layanan, mem-build konfigurasi layanan menjadi image ESPv2 baru, dan mengupload image baru ke registry penampung project Anda. Skrip secara otomatis menggunakan rilis ESPv2 terbaru, yang ditunjukkan dengan ESP_VERSION dalam nama image output. Gambar output diupload ke:
```
gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID
```
Contoh:
```
gcr.io/your-project-id/endpoints-runtime-serverless:2.14.0-gateway-12345-uc.a.run.app-2019-02-01r0"
```
Catatan:
Teruskan flag -z ke skrip untuk membuat image di lokasi registry yang berbeda.

Misalnya, untuk mendorong image ESPv2 yang dihasilkan ke pusat data Uni Eropa, teruskan -z eu ke skrip.

Men-deploy container ESPv2

Deploy layanan Cloud Run ESPv2 dengan image baru yang Anda build di atas. Ganti CLOUD_RUN_SERVICE_NAME dengan nama layanan Cloud Run yang sama dengan yang Anda gunakan saat awalnya memesan nama host di atas dalam Memesan nama host 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
```
Catatan:
Jika layanan gRPC Anda menggunakan protokol streaming, tambahkan flag --use-http2 ke perintah gcloud run deploy. Saat ini, tanda ini hanya didukung di gcloud beta run. Tambahkan flag ini saat men-deploy layanan Cloud Run backend ESPv2 dan gRPC.
Jika ingin mengonfigurasi Endpoints untuk menggunakan opsi startup ESPv2 tambahan, seperti mengaktifkan CORS, Anda dapat meneruskan argumen dalam variabel lingkungan 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
```
Untuk informasi selengkapnya dan contoh tentang cara menetapkan variabel lingkungan ESPv2_ARGS, termasuk daftar opsi yang tersedia dan informasi tentang cara menentukan beberapa opsi, lihat Flag Extensible Service Proxy V2.
Berikan izin ESPv2 untuk memanggil layanan Cloud Run Anda. Jalankan perintah berikut untuk setiap layanan. Dalam perintah berikut:
Catatan:
Langkah ini tidak diperlukan jika layanan Cloud Run ESPv2 di-deploy tanpa menggunakan flag --service-account dan layanan backend BACKEND_SERVICE_NAME di-deploy di project ESP_PROJECT_NUMBER.
- Ganti BACKEND_SERVICE_NAME dengan nama layanan Cloud Run yang dipanggil. Jika Anda menggunakan layanan yang dibuat dengan men-deploy `gcr.io/endpointsv2/python-grpc-bookstore-server:2`, gunakan python-grpc-bookstore-server sebagai nilai ini.
- Ganti ESP_PROJECT_NUMBER dengan nomor project yang Anda buat untuk ESPv2. Salah satu cara untuk menemukannya adalah dengan membuka halaman IAM di Konsol Google Cloud dan menemukan Default compute service account, yang merupakan akun layanan yang digunakan dalam tanda `member`.
```
gcloud run services add-iam-policy-binding BACKEND_SERVICE_NAME \
  --member "serviceAccount:ESP_PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
  --role "roles/run.invoker" \
  --platform managed \
  --project BACKEND_PROJECT_ID
```

Untuk mengetahui informasi selengkapnya, lihat Mengelola akses menggunakan IAM.

Mengirim permintaan ke API

Untuk mengirim permintaan ke API contoh, Anda dapat menggunakan contoh klien gRPC yang ditulis dalam Python.

Clone repositori git tempat kode klien gRPC dihosting:

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

Ubah direktori kerja Anda:

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

Instal dependensi:

pip3 install virtualenv
virtualenv env
source env/bin/activate
pip3 install -r requirements.txt

Kirim permintaan ke API contoh:
```
python3 bookstore_client.py --host CLOUD_RUN_HOSTNAME --port 443 --use_tls true
```
Tentukan nama host layanan Cloud Run ESPv2 Anda di CLOUD_RUN_HOSTNAME, tanpa ID protokol. Contoh:
```
python3 bookstore_client.py --host espv2-grpc-HASH-uc.a.run.app --port 443 --use_tls true
```
- Lihat grafik aktivitas untuk API Anda di halaman Endpoints > Services.
  
  Buka halaman Endpoints Services
  
  Mungkin perlu waktu beberapa saat agar permintaan ditampilkan dalam grafik.
- Lihat log permintaan untuk API Anda di halaman Logs Explorer.
  
  Buka halaman Logs Explorer

Jika Anda tidak mendapatkan respons yang berhasil, lihat Memecahkan masalah error respons.

Anda baru saja men-deploy dan menguji API di Endpoint.

Melacak aktivitas API

Lihat grafik aktivitas untuk API Anda di halaman Endpoints > Service di Konsol Google Cloud.

Melihat grafik aktivitas Endpoint

Mungkin perlu waktu beberapa saat agar permintaan ditampilkan dalam grafik.
Lihat log permintaan untuk API Anda di halaman Logs Explorer.

Melihat log permintaan Endpoints

Membuat portal developer untuk API

Anda dapat menggunakan Cloud Endpoints Portal untuk membuat portal developer, situs yang dapat Anda gunakan untuk berinteraksi dengan API contoh. Untuk mempelajari lebih lanjut, lihat Ringkasan Cloud Endpoints Portal.

Pembersihan

Agar tidak menimbulkan biaya pada akun Google Cloud Anda untuk resource yang digunakan pada halaman ini, ikuti langkah-langkah berikut.

Lihat Menghapus API dan instance API untuk mengetahui informasi tentang cara menghentikan layanan yang digunakan oleh tutorial ini.