Mulai menggunakan gRPC Cloud Endpoints untuk Grup Instance Terkelola dengan ESPv2

---

OpenAPI   |  gRPC

Tutorial ini menunjukkan cara men-deploy contoh layanan gRPC sederhana dengan Extensible Service Proxy V2 (ESPv2) di Grup Instance Terkelola.

Tutorial ini menggunakan versi Python dari contoh bookstore-grpc. Lihat bagian Langkah berikutnya untuk contoh gRPC dalam bahasa lain.

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

Tujuan

Gunakan daftar tugas tingkat tinggi berikut saat Anda mengerjakan tutorial. Semua tugas diperlukan agar berhasil mengirim permintaan ke API.

1. Siapkan project Google Cloud, dan download software yang diperlukan. Lihat Sebelum memulai.
2. Salin dan konfigurasi file dari contoh bookstore-grpc. Lihat Mengonfigurasi Endpoint.
3. Deploy konfigurasi Endpoint untuk membuat layanan Endpoint. Lihat Men-deploy konfigurasi Endpoint.
4. Deploy API dan ESPv2 di backend Grup Instance Terkelola. Lihat Men-deploy backend API.
5. Mengirim permintaan ke API. Lihat Mengirim permintaan ke API.
6. Hindari menimbulkan tagihan ke akun Google Cloud Anda. Lihat Membersihkan.

Biaya

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

• Compute Engine
• Endpoint

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

1. Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

3. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

4. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

5. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

6. Catat ID project karena akan diperlukan nanti.
7. Instal dan lakukan inisialisasi Google Cloud CLI.
8. Update gcloud CLI dan instal komponen Endpoint:

   gcloud components update

9. Pastikan Google Cloud CLI (gcloud) diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud:

   gcloud auth login

   Di tab browser baru yang terbuka, pilih akun.
10. 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 CLI gcloud.

11. Ikuti langkah-langkah dalam panduan memulai Python gRPC untuk menginstal gRPC dan alat gRPC.

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.

Mengonfigurasi Endpoint

Clone repositori contoh bookstore-grpc dari GitHub.

Untuk mengonfigurasi Endpoint:

1. Buat file deskriptor protobuf mandiri dari file .proto layanan Anda:
   1. Simpan salinan bookstore.proto dari repositori contoh. File ini menentukan API layanan Bookstore.
   2. Buat direktori berikut: 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:

      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 berbeda untuk file input .proto, ubah --proto_path agar compiler menelusuri direktori tempat Anda menyimpan bookstore.proto.

2. Buat file YAML konfigurasi gRPC API:
   1. Simpan salinan file api_config.yaml. File ini menentukan konfigurasi gRPC API untuk layanan Bookstore.
   2. Ganti MY_PROJECT_ID di file api_config.yaml dengan project ID Google Cloud Anda. Contoh:

      #
      # Name of the service configuration.
      #
      name: bookstore.endpoints.example-project-12345.cloud.goog
      

      Perlu diketahui 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 Bookstore ditentukan di bookstore.proto di dalam paket endpoints.examples.bookstore. Nama API yang sepenuhnya memenuhi syarat adalah endpoints.examples.bookstore.Bookstore, sama seperti yang muncul dalam file api_config.yaml.

      apis:
        - name: endpoints.examples.bookstore.Bookstore
      

Lihat Mengonfigurasi Endpoint untuk informasi selengkapnya.

Men-deploy konfigurasi Endpoint

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

1. Pastikan Anda berada di direktori tempat file api_descriptor.pb dan api_config.yaml berada.
2. Pastikan project default yang digunakan alat command line gcloud saat ini adalah project Google Cloud tempat Anda ingin men-deploy konfigurasi Endpoint. Validasi project ID yang ditampilkan dari perintah berikut untuk memastikan bahwa layanan tidak dibuat dalam project yang salah.

   gcloud config list project
   

   Jika Anda perlu mengubah project default, jalankan perintah berikut:

   gcloud config set project YOUR_PROJECT_ID
   

3. 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, Pengelolaan Layanan menghasilkan informasi ke terminal. Setelah deployment selesai, pesan yang mirip dengan yang berikut ini akan ditampilkan:

   Service Configuration [CONFIG_ID] uploaded for service [bookstore.endpoints.example-project.cloud.goog]

   CONFIG_ID adalah ID konfigurasi layanan Endpoint 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 revisinya akan bertambah di ID konfigurasi layanan.

Memeriksa layanan yang diperlukan

Setidaknya, Endpoint dan ESP mengharuskan layanan Google berikut diaktifkan:

Nama	Judul
servicemanagement.googleapis.com	Service Management API
servicecontrol.googleapis.com	Service Control API
endpoints.googleapis.com	Google Cloud Endpoints

Dalam sebagian besar kasus, perintah gcloud endpoints services deploy akan mengaktifkan layanan wajib 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 telah men-deploy konfigurasi Endpoint ke project Google Cloud yang ada, yang menonaktifkan layanan ini 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
gcloud services enable endpoints.googleapis.com

Aktifkan juga layanan Endpoint Anda:

gcloud services enable ENDPOINTS_SERVICE_NAME

Untuk menentukan ENDPOINTS_SERVICE_NAME, Anda dapat:

• Setelah men-deploy konfigurasi Endpoint, buka halaman Endpoint di Cloud Console. Daftar kemungkinan ENDPOINTS_SERVICE_NAME ditampilkan di bawah kolom Service name.

• Untuk OpenAPI, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan dalam kolom host pada spesifikasi OpenAPI. Untuk gRPC, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan di kolom name pada konfigurasi Endpoint gRPC Anda.

Untuk mengetahui informasi selengkapnya tentang perintah gcloud, lihat layanan gcloud.

Jika Anda mendapatkan pesan error, lihat Memecahkan masalah deployment konfigurasi Endpoint. Lihat Men-deploy konfigurasi Endpoint untuk mengetahui informasi tambahan.

Men-deploy backend API

Sejauh ini Anda telah men-deploy konfigurasi API ke Pengelolaan Layanan, tetapi belum men-deploy kode yang menyalurkan backend API. Bagian ini akan memandu Anda menyiapkan Docker di Grup Instance Terkelola serta menjalankan kode backend API dan ESPv2 di container Docker.

Membuat template instance

Buat template yang akan Anda gunakan untuk membuat grup instance VM. Setiap instance yang dibuat dari template akan meluncurkan ESPv2 dan server aplikasi backend.

1. Di konsol Google Cloud, buka halaman Instance templates.

   Buka Instance templates

2. Klik Create instance template.

3. Di bagian Name, masukkan load-balancing-espv2-template.

4. Di bagian Machine configuration, setel Machine type ke e2-micro.

5. Di bagian Boot disk, setel Image ke Container Optimized OS stable version.

6. Di bagian Firewall, pilih Allow HTTP traffic.

7. Klik Management, security, disks, networking, sole tenancy untuk menampilkan setelan lanjutan.

8. Klik tab Management. Di bagian Automation, masukkan Startup script berikut. Jangan lupa mengupdate ENDPOINTS_SERVICE_NAME.

   sudo docker network create --driver bridge esp_net
   sudo docker run \
     --detach \
     --name=bookstore \
     --net=esp_net \
     gcr.io/endpointsv2/python-grpc-bookstore-server:1
   sudo docker run \
     --detach \
     --name=esp \
     --publish=80:9000 \
     --net=esp_net \
     gcr.io/endpoints-release/endpoints-runtime:2 \
     --service=ENDPOINTS_SERVICE_NAME \
     --rollout_strategy=managed \
     --listener_port=9000 \
     --healthz=/healthz \
     --backend=grpc://bookstore:8000
   

   Skrip akan mendapatkan, menginstal, dan meluncurkan server aplikasi echo dan server proxy ESPv2 saat instance dimulai.

9. Klik Create.

Tunggu hingga template dibuat sebelum melanjutkan.

Membuat grup instance terkelola regional

Untuk menjalankan aplikasi, gunakan template instance untuk membuat grup instance terkelola regional:

1. Di Konsol Google Cloud, buka halaman Instance groups.

   Buka Instance groups

2. Klik Create grup instance.

3. Di bagian Name, masukkan load-balancing-espv2-group.

4. Di bagian Lokasi, pilih Beberapa zona.

   Tips Pro: Untuk memastikan aplikasi Anda tersedia selama peristiwa ekstrem, seperti pemadaman layanan di zona tertentu, Compute Engine merekomendasikan agar Anda mendistribusikan aplikasi di beberapa zona ini.

5. Pada Region, pilih us-central1.

6. Klik menu drop-down Configure zone untuk menampilkan Zones. Pilih zona berikut:

   • us-central1-b
   • us-central1-c
   • us-central1-f

7. Di bagian Instance template, pilih load-balancing-espv2-template.

8. Di bagian Autoscaling, pilih Don't autoscale.

9. Setel Number of instances ke 3.

   Tips Pro: Saat membuat grup instance terkelola regional, Compute Engine merekomendasikan agar Anda menyediakan instance yang cukup sehingga, jika semua instance di satu zona tidak tersedia, instance yang tersisa masih memenuhi jumlah minimum instance yang Anda perlukan. Namun, menyediakan lebih banyak instance dari yang Anda butuhkan dapat menimbulkan biaya tambahan. Untuk mengetahui informasi selengkapnya, lihat Memilih ukuran grup instance untuk memastikan ketersediaan.

10. Di bagian Instance redistribution, pilih On.

11. Di bagian Autohealing dan Health check, pilih No health check.

12. Klik Create. Tindakan ini akan mengalihkan Anda kembali ke halaman Grup instance.

    Catatan: Anda mungkin perlu menunggu beberapa menit hingga semua instance dalam grup berjalan dan siap menampilkan aplikasi web.

Membuat load balancer

Bagian ini menjelaskan langkah-langkah yang diperlukan untuk membuat load balancing regional yang mengarahkan traffic TCP ke grup instance Anda.

1. Di konsol Google Cloud, buka halaman Create a load balancer.

   Buka Create a load balancer

2. Di bagian TCP Load Balancing, klik Start configuration.

3. Di bagian Internet facing or internal only, pilih From Internet to my VMs.

4. Di bagian Multiple region atau satu region, pilih Single region only.

5. Di bawah Backend type, pilih Backend Service.

6. Klik Lanjutkan.

7. Di bagian Name, masukkan espv2-load-balancer.

8. Di bagian Backend configuration, pilih region us-central1.

9. Pilih grup instance load-balancing-espv2-group.

10. Di bagian Health check, buat health check baru.

    • Di bagian nama, masukkan espv2-load-balancer-check.
    • Konfirmasi bahwa Protokol adalah TCP, Port adalah 80.

11. Pada bagian Frontend configuration, masukkan nomor port 80.

12. Di bagian Tinjau dan selesaikan, verifikasi

    • Grup instance adalah load-balancing-espv2-group.
    • Region adalah us-central1.
    • Protokol adalah TCP.
    • IP:Port adalah EPHEMERAL:80.

13. Setelah load balancer dibuat, temukan alamat IP dari halaman Load Balancer.

    Buka Load Balancer

Mengirim permintaan ke API

Jika Anda mengirim permintaan dari instance yang sama tempat container Docker dijalankan, Anda dapat mengganti SERVER_IP dengan localhost. Jika tidak, ganti SERVER_IP dengan IP eksternal instance.

Anda dapat menemukan alamat IP eksternal dengan menjalankan:

gcloud compute instances list

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

1. Clone repo git tempat kode klien gRPC dihosting:

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

2. Ubah direktori kerja Anda:

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

3. Instal dependensi:

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

4. Kirim permintaan ke API contoh:

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

   • Lihat grafik aktivitas untuk API Anda di halaman Endpoint > Layanan.
     

     Buka halaman Layanan Endpoint

     Mungkin perlu waktu beberapa saat agar permintaan terlihat dalam grafik.

   • Lihat log permintaan untuk API Anda di halaman Logs Explorer.
     

     Buka halaman Logs Explorer

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

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

Catatan: Jika ingin memberi tahu kami apa yang Anda sukai dari tutorial ini, jangan ragu untuk memberikan masukan di bagian bawah halaman ini. Masukan Anda membantu kami meningkatkan kualitas tutorial ini.
Jika Anda mengalami error, bergabunglah dengan grup Google google-cloud-endpoints dan beri tahu kami apa yang salah. Grup ini menerima respons dari pengguna Endpoint lain dan dari engineer Google, yang memantau grup.

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.

1. Pastikan gcloud CLI (gcloud) diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud:

   gcloud auth login
   

2. Masukkan perintah berikut guna menampilkan project ID untuk project Google Cloud Anda:

   gcloud projects list
   

3. Dengan menggunakan project ID yang berlaku dari langkah sebelumnya, tetapkan project Google Cloud default ke project tempat aplikasi Anda berada:

   gcloud config set project [YOUR_PROJECT_ID]
   

4. Dapatkan nama semua layanan terkelola di project Google Cloud Anda:

   gcloud endpoints services list
   

5. Hapus layanan dari Pengelolaan Layanan. Ganti SERVICE_NAME dengan nama layanan yang ingin Anda hapus.

   gcloud endpoints services delete SERVICE_NAME
   

   Menjalankan gcloud endpoints services delete tidak akan langsung menghapus layanan terkelola. Pengelolaan Layanan menonaktifkan layanan terkelola selama 30 hari, sehingga Anda memiliki waktu untuk memulihkannya jika perlu. Setelah 30 hari, Pengelolaan Layanan akan menghapus layanan terkelola secara permanen.

6. Buka halaman Load Balancer.

   Buka Load Balancer

   Menghapus load balancer espv2-load-balancer dengan health check espv2-load-balancer-check.

7. Buka halaman Instance Groups.

   Buka Instance Groups

   Hapus load-balancing-espv2-group

8. Buka halaman Instance Template.

   Buka Template Instance

   Hapus load-balancing-espv2-template.

Langkah selanjutnya

• Pelajari cara mengonfigurasi gRPC API Anda sendiri untuk Endpoint.
• Lihat contoh Toko Buku di GitHub secara lebih detail. Klien dan server tersedia di Python dan Java.
• Contoh getting-started-grpc tersedia di GitHub dalam bahasa berikut:
  • Java
  • Python
  • Ruby
  • Go
  • Node.js