Memulai gRPC Cloud Endpoints untuk Managed Instance Group dengan ESPv2

OpenAPI   |  gRPC

Tutorial ini menunjukkan cara men-deploy layanan gRPC contoh sederhana dengan Extensible Service Proxy V2 (ESPv2) dalam Managed Instance Group.

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

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.

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

Biaya

Di dokumen ini, Anda akan menggunakan komponen Google Cloudyang dapat ditagih berikut:

• Compute Engine
• Endpoints

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga.

Pengguna Google Cloud baru 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, baca bagian 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.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify 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.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

1. Catat project ID karena akan diperlukan nanti.
2. Instal dan lakukan inisialisasi Google Cloud CLI.
3. Update gcloud CLI dan instal komponen Endpoints:

   gcloud components update

4. Pastikan Google Cloud CLI (gcloud) diizinkan untuk mengakses data dan layanan Anda di Google Cloud:

   gcloud auth login

   Di tab browser baru yang terbuka, pilih akun.
5. 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 Anda ingin menggunakan gcloud untuk mengelolanya, lihat Mengelola Konfigurasi gcloud CLI.

6. Ikuti langkah-langkah di Panduan memulai gRPC Python 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 deskriptor, api_descriptor.pb, menggunakan compiler buffer 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 yang berbeda untuk file input .proto, ubah --proto_path sehingga compiler menelusuri direktori tempat Anda menyimpan bookstore.proto.

2. Buat file YAML konfigurasi gRPC API:
   1. Simpan salinan api_config.yamlfile. 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
      

      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 Bookstore ditentukan di bookstore.proto 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 mengetahui informasi selengkapnya.

Men-deploy konfigurasi Endpoint

Untuk men-deploy konfigurasi Endpoints, Anda menggunakan perintah gcloud endpoints services deploy. Perintah ini menggunakan Service Management 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 saat ini digunakan oleh alat command line gcloud adalah project Google Cloud yang ingin Anda gunakan untuk men-deploy konfigurasi Endpoints. Validasi project ID yang ditampilkan dari perintah berikut untuk memastikan bahwa 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
   

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, Service Management 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]
   

   Dalam 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 Endpoints lagi pada hari yang sama, nomor revisi akan bertambah dalam ID konfigurasi layanan.

Memeriksa layanan yang diperlukan

Minimal, Endpoints dan ESP memerlukan 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 projectGoogle Cloud yang sudah ada dan layanan ini dinonaktifkan secara eksplisit di project tersebut.

Gunakan perintah berikut untuk mengonfirmasi bahwa layanan yang diperlukan sudah 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 ENDPOINTS_SERVICE_NAME yang mungkin ditampilkan di kolom Nama layanan.

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

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

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

Men-deploy backend API

Sejauh ini Anda telah men-deploy konfigurasi API ke Service Management, tetapi Anda belum men-deploy kode yang melayani backend API. Bagian ini memandu Anda menyiapkan Docker di Managed Instance Group dan menjalankan kode backend API dan ESPv2 dalam 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, tetapkan Image ke Container Optimized OS stable version.

6. Di bagian Firewall, pilih Allow HTTP traffic.

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

8. Klik tab Management. Di bagian Automation, masukkan Startup script berikut. Jangan lupa update 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 mengambil, menginstal, dan meluncurkan server aplikasi echo dan server proxy ESPv2 saat instance dimulai.

9. Klik Buat.

Tunggu hingga template selesai 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 instance group.

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. Di bagian Region, pilih us-central1.

6. Klik menu drop-down Konfigurasi zona untuk menampilkan Zona. 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 Penskalaan otomatis, pilih Jangan lakukan penskalaan otomatis.

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 Redistribusi instance, pilih Aktif.

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

12. Klik Buat. 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 balancer 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 Beberapa wilayah atau satu wilayah, pilih Satu wilayah saja.

5. Di bagian 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.
    • Pastikan Protocol adalah TCP, Port adalah 80.

11. Di 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 dengan tempat container Docker berjalan, 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 contoh API, Anda dapat menggunakan contoh klien gRPC yang ditulis dalam Python.

1. Clone repositori 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 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 Endpoints.

Catatan: Jika Anda ingin memberi tahu kami apa yang Anda sukai tentang tutorial ini, silakan berikan masukan di bagian bawah halaman ini. Masukan Anda membantu kami meningkatkan kualitas tutorial ini.
Jika Anda mendapatkan error, bergabunglah ke grup Google google-cloud-endpoints dan beri tahu kami apa yang salah. Grup ini menerima respons dari pengguna Endpoints lainnya 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) diizinkan untuk mengakses data dan layanan Anda di Google Cloud:

   gcloud auth login
   

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

   gcloud projects list
   

3. Dengan menggunakan project ID yang berlaku dari langkah sebelumnya, tetapkan projectGoogle 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, Service Management 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 Instance Templates

   Hapus load-balancing-espv2-template.

Langkah berikutnya

• Cari tahu cara mengonfigurasi gRPC API Anda sendiri untuk Endpoints.
• Pelajari contoh Bookstore di GitHub secara lebih mendetail. Klien dan server tersedia di Python dan Java.
• Contoh getting-started-grpc tersedia di GitHub dalam bahasa berikut:
  • Java
  • Python
  • Ruby
  • Go
  • Node.js