Tutorial ini menunjukkan cara men-deploy contoh layanan gRPC sederhana
dengan
Extensible Service Proxy
(ESP) di Google Kubernetes Engine
(GKE). Tutorial ini menggunakan contoh bookstore-grpc
versi Python. Lihat bagian
Langkah berikutnya untuk mengetahui contoh gRPC dalam bahasa
lain.
Tutorial ini menggunakan image container bawaan dari kode contoh dan ESP, yang disimpan di Artifact Registry. Jika Anda tidak familiar dengan penampung, lihat informasi selengkapnya di sini:
Untuk ringkasan Cloud Endpoints, lihat Tentang Endpoints dan Arsitektur Endpoints.
Tujuan
Gunakan daftar tugas tingkat tinggi berikut saat Anda mengerjakan tutorial ini. Semua tugas diperlukan agar berhasil mengirim permintaan ke API.
- Siapkan project Google Cloud, dan download software yang diperlukan. Lihat Sebelum memulai.
- Salin dan konfigurasikan file dari
contoh
bookstore-grpc
. Lihat Mengonfigurasi Endpoint. - Deploy konfigurasi Endpoint untuk membuat layanan Endpoint. Lihat Men-deploy konfigurasi Endpoint.
- Buat backend untuk menayangkan API dan men-deploy API. Lihat Men-deploy backend API.
- Dapatkan alamat IP eksternal layanan. Lihat Mendapatkan alamat IP eksternal layanan.
- Kirim permintaan ke API. Lihat Mengirim permintaan ke 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.
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
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
- Catat project ID Google Cloud karena Anda akan memerlukannya nanti.
- Instal dan lakukan inisialisasi Google Cloud CLI.
- Update gcloud CLI dan instal komponen Endpoints.
gcloud components update
- Pastikan Google Cloud CLI (
gcloud
) diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud: Tab browser baru akan terbuka dan Anda akan diminta untuk memilih akun.gcloud auth login
- Tetapkan project default ke project ID Anda.
gcloud config set project YOUR_PROJECT_ID
Ganti YOUR_PROJECT_ID dengan project ID Anda.
Jika Anda memiliki project Google Cloud lain, dan ingin menggunakan
gcloud
untuk mengelolanya, lihat Mengelola konfigurasi gcloud CLI. - Instal
kubectl
:gcloud components install kubectl
- Dapatkan kredensial pengguna baru untuk digunakan sebagai kredensial default
aplikasi. Kredensial pengguna diperlukan untuk memberikan otorisasi
kubectl
. Di tab browser baru yang terbuka, pilih akun.gcloud auth application-default login
- Ikuti langkah-langkah di panduan memulai gRPC Python untuk menginstal gRPC dan alat gRPC.
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:- Simpan salinan
bookstore.proto
dari repositori contoh. File ini menentukan API layanan Toko Buku. - Buat direktori berikut:
mkdir generated_pb2
- Buat file deskripsi,
api_descriptor.pb
, menggunakan compiler buffering protokolprotoc
. Jalankan perintah berikut di direktori tempat Anda menyimpanbookstore.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
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 menyimpanbookstore.proto
.
- Simpan salinan
- Buat file YAML konfigurasi gRPC API:
- Simpan salinan
file
api_config.yaml
. File ini menentukan konfigurasi gRPC API untuk layanan Toko Buku. - Ganti MY_PROJECT_ID dalam file
api_config.yaml
dengan project ID Google Cloud Anda. Contoh:# # Name of the service configuration. # name: bookstore.endpoints.example-project-12345.cloud.goog
Perhatikan bahwa nilai kolom
apis.name
dalam file ini sama persis dengan nama API yang sepenuhnya memenuhi syarat dari file.proto
; jika tidak, deployment tidak akan berfungsi. Layanan Toko Buku ditentukan dalambookstore.proto
di dalam paketendpoints.examples.bookstore
. Nama API-nya yang sepenuhnya memenuhi syarat adalahendpoints.examples.bookstore.Bookstore
, seperti yang muncul dalam fileapi_config.yaml
.apis: - name: endpoints.examples.bookstore.Bookstore
- Simpan salinan
file
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
danapi_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 danbookstore.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 kolomname
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.
Men-deploy backend API
Sejauh ini, Anda telah men-deploy konfigurasi layanan ke Pengelolaan Layanan, tetapi belum men-deploy kode yang menayangkan backend API. Bagian ini akan memandu Anda membuat cluster GKE untuk menghosting backend API dan men-deploy API.
Membuat cluster container
Untuk membuat cluster container untuk contoh kita:
- Di konsol Google Cloud, buka halaman cluster Kubernetes.
- Klik Buat kluster.
- Setujui setelan default dan klik Create. Catat nama dan zona cluster, karena diperlukan nanti dalam tutorial ini.
Mengautentikasi kubectl
ke cluster penampung
Untuk menggunakan kubectl
guna membuat dan mengelola resource cluster, Anda harus mendapatkan
kredensial cluster dan menyediakannya untuk kubectl
. Untuk melakukannya, jalankan perintah berikut, dengan mengganti NAME dengan nama cluster baru dan ZONE dengan zona clusternya.
gcloud container clusters get-credentials NAME --zone ZONE
Memeriksa izin yang diperlukan
ESP dan ESPv2 memanggil layanan Google yang menggunakan IAM untuk memverifikasi apakah identitas panggilan memiliki izin yang cukup untuk mengakses resource IAM yang digunakan. Identitas panggilan adalah akun layanan terlampir yang men-deploy ESP dan ESPv2.
Saat di-deploy di pod GKE, akun layanan terlampir adalah akun layanan node. Biasanya, akun layanan default Compute Engine. Ikuti rekomendasi izin ini untuk memilih akun layanan node yang sesuai.
Jika Workload Identity digunakan, akun layanan terpisah selain akun layanan node dapat digunakan untuk berkomunikasi dengan layanan Google. Anda dapat membuat akun layanan Kubernetes untuk pod agar dapat menjalankan ESP dan ESPv2, membuat akun layanan Google, dan mengaitkan akun layanan Kubernetes ke akun layanan Google.
Ikuti langkah-langkah berikut untuk mengaitkan akun layanan Kubernetes dengan akun layanan Google. Akun layanan Google ini adalah akun layanan terlampir.
Jika akun layanan yang dilampirkan adalah akun layanan default Compute Engine dari project dan konfigurasi layanan endpoint di-deploy di project yang sama, akun layanan harus memiliki izin yang cukup untuk mengakses resource IAM, sehingga langkah penyiapan peran IAM dapat dilewati. Jika tidak, peran IAM berikut harus ditambahkan ke akun layanan yang dilampirkan.
Tambahkan peran IAM yang diperlukan:
Bagian ini menjelaskan resource IAM yang digunakan oleh ESP dan ESPv2 serta peran IAM yang diperlukan agar akun layanan yang terpasang dapat mengakses resource ini.
Konfigurasi Layanan Endpoint
ESP dan ESPv2 memanggil Kontrol Layanan yang menggunakan konfigurasi layanan endpoint. Konfigurasi layanan endpoint adalah resource IAM dan ESP serta ESPv2 memerlukan peran Service Controller untuk mengaksesnya.
Peran IAM ada di konfigurasi layanan endpoint, bukan di project. Project dapat memiliki beberapa konfigurasi layanan endpoint.
Gunakan perintah gcloud berikut untuk menambahkan peran ke akun layanan yang terlampir untuk konfigurasi layanan endpoint.
gcloud endpoints services add-iam-policy-binding SERVICE_NAME \ --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \ --role roles/servicemanagement.serviceController
Dengan
* SERVICE_NAME
adalah nama layanan endpoint
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com
adalah akun layanan terlampir.
Cloud Trace
ESP dan ESPv2 memanggil layanan
Cloud Trace untuk mengekspor Trace ke project. Project ini disebut project
pelacakan. Di ESP, project pelacakan dan project yang memiliki konfigurasi layanan endpoint adalah sama. Di ESPv2, project pelacakan dapat ditentukan oleh flag --tracing_project_id
, dan ditetapkan secara default ke project deployment.
ESP dan ESPv2 memerlukan peran Cloud Trace Agent untuk mengaktifkan Cloud Trace.
Gunakan perintah gcloud berikut untuk menambahkan peran ke akun layanan yang terlampir:
gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \ --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \ --role roles/cloudtrace.agent
Dengan
* TRACING_PROJECT_ID adalah project ID pelacakan
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com
adalah akun layanan yang terpasang.
Untuk mengetahui informasi selengkapnya, lihat
Apa yang dimaksud dengan peran dan izin?
Men-deploy API dan ESP contoh ke cluster
Untuk men-deploy contoh layanan gRPC ke cluster agar klien dapat menggunakannya:
- Simpan dan buka untuk mengedit salinan file manifes deployment grpc-bookstore.yaml.
- Ganti SERVICE_NAME dengan nama layanan Endpoints Anda.
Ini adalah nama yang sama dengan yang Anda konfigurasikan di kolom
name
dalam fileapi_config.yaml
.Opsi
--rollout_strategy=managed
mengonfigurasi ESP untuk menggunakan konfigurasi layanan terbaru yang di-deploy. Saat Anda menentukan opsi ini, hingga 5 menit setelah Anda men-deploy konfigurasi layanan baru, ESP akan mendeteksi perubahan dan otomatis mulai menggunakannya. Sebaiknya tentukan opsi ini, bukan ID konfigurasi tertentu yang akan digunakan ESP. Untuk mengetahui detail selengkapnya tentang argumen ESP, lihat Opsi startup ESP.Contoh:
spec: containers: - name: esp image: gcr.io/endpoints-release/endpoints-runtime:1 args: [ "--http2_port=9000", "--service=bookstore.endpoints.example-project-12345.cloud.goog", "--rollout_strategy=managed", "--backend=grpc://127.0.0.1:8000" ]
- Mulai layanan:
kubectl create -f grpc-bookstore.yaml
Jika Anda menerima pesan error, lihat Memecahkan Masalah Endpoint di GKE.
Mendapatkan alamat IP eksternal layanan
Anda memerlukan alamat IP eksternal layanan untuk mengirim permintaan ke API contoh. Mungkin perlu waktu beberapa menit setelah Anda memulai layanan di penampung sebelum alamat IP eksternal siap.
Lihat alamat IP eksternal:
kubectl get service
Catat nilai untuk
EXTERNAL-IP
dan simpan dalam variabel lingkungan SERVER_IP. Alamat IP eksternal digunakan untuk mengirim permintaan ke API contoh.export SERVER_IP=YOUR_EXTERNAL_IP
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:
pip install virtualenv
virtualenv env
source env/bin/activate
python -m pip install -r requirements.txt
Kirim permintaan ke API contoh:
python bookstore_client.py --host SERVER_IP --port 80
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.
Jika Anda tidak mendapatkan respons yang berhasil, lihat Memecahkan masalah error respons.
Anda baru saja men-deploy dan menguji API di Endpoint.
Pembersihan
Agar tidak perlu membayar biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, hapus project yang berisi resource tersebut, atau simpan project dan hapus setiap resource.
Hapus API:
gcloud endpoints services delete SERVICE_NAME
Ganti SERVICE_NAME dengan nama API Anda.
Hapus cluster GKE:
gcloud container clusters delete NAME --zone ZONE