Mulai menggunakan Endpoints untuk Compute Engine dengan ESPv2

---

OpenAPI   |  gRPC

Tutorial ini menunjukkan cara men-deploy contoh layanan gRPC sederhana dengan Extensible Service Proxy V2 (ESPv2) dalam penampung Docker di Compute Engine.

Tutorial ini menggunakan contoh bookstore-grpc versi Python. Lihat bagian Langkah berikutnya untuk mengetahui 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 project Google Cloud, dan download software yang diperlukan. Lihat Sebelum memulai.
2. Buat instance VM Compute Engine. Lihat Membuat instance Compute Engine.
3. Salin dan konfigurasikan file dari contoh bookstore-grpc. Lihat Mengonfigurasi Endpoint.
4. Deploy konfigurasi Endpoint untuk membuat layanan Endpoint. Lihat Men-deploy konfigurasi Endpoint.
5. Deploy API dan ESPv2 di VM Compute Engine. Lihat Men-deploy backend API.
6. Kirim permintaan ke API. Lihat Mengirim permintaan ke API.
7. Hindari tagihan pada akun Google Cloud Anda. Lihat Pembersihan.

Biaya

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

• Compute Engine
• Endpoints

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

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. Make sure that billing is enabled for your Google Cloud project.

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. Make sure that billing is enabled for your Google Cloud project.

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

   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 gcloud CLI.

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

Membuat instance Compute Engine

Untuk membuat instance Compute Engine:

1. Di konsol Google Cloud, buka halaman Buat instance.

   Buka Buat instance

2. Di bagian Firewall, pilih Izinkan traffic HTTP dan Izinkan traffic HTTPS.
3. Untuk membuat VM, klik Buat.



Tunggu hingga instance memulai. Setelah siap, instance akan dicantumkan di halaman VM Instances dengan ikon status hijau.

4. Pastikan Anda dapat terhubung ke instance VM.
   1. Di daftar instance virtual machine, klik SSH di baris instance yang ingin Anda hubungkan.
   2. Anda kini dapat menggunakan terminal untuk menjalankan perintah Linux di instance Debian.
   3. Masukkan exit untuk memutuskan koneksi dari instance.
5. Catat nama instance, zona, dan alamat IP eksternal karena diperlukan nanti.

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, Anda menggunakan 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 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.

Men-deploy backend API

Sejauh ini, Anda telah men-deploy konfigurasi API ke Pengelolaan Layanan, tetapi belum men-deploy kode yang menayangkan backend API. Bagian ini akan memandu Anda menyiapkan Docker di instance VM dan menjalankan kode backend API serta ESPv2 dalam penampung Docker.

Menginstal Docker di instance VM

Untuk menginstal Docker di instance VM:

1. Tetapkan zona untuk project Anda dengan menjalankan perintah:

   gcloud config set compute/zone YOUR_INSTANCE_ZONE
   

   Ganti YOUR_INSTANCE_ZONE dengan zona tempat instance Anda berjalan.

2. Hubungkan ke instance Anda menggunakan perintah berikut:

   gcloud compute ssh INSTANCE_NAME
   

   Ganti INSTANCE_NAME dengan nama instance VM Anda.

3. Lihat dokumentasi Docker untuk menyiapkan repositori Docker. Pastikan untuk mengikuti langkah-langkah yang sesuai dengan versi dan arsitektur instance VM Anda:
   • Jessie atau yang lebih baru
   • x86_64 / amd64

Menjalankan API dan ESPv2 contoh di container Docker

Untuk menjalankan contoh layanan gRPC dengan ESPv2 dalam penampung Docker agar klien dapat menggunakannya:

1. Pada instance VM, buat jaringan penampung Anda sendiri yang disebut esp_net.

   sudo docker network create --driver bridge esp_net
   

2. Jalankan server Toko Buku contoh yang menayangkan API contoh:

   sudo docker run \
       --detach \
       --name=bookstore \
       --net=esp_net \
       gcr.io/endpointsv2/python-grpc-bookstore-server:1
   

3. Jalankan container Docker ESPv2 yang telah dipaketkan sebelumnya. Di opsi startup ESPv2, ganti SERVICE_NAME dengan nama layanan Anda. Ini adalah nama yang sama dengan yang Anda konfigurasikan di kolom name dalam file api_config.yaml. Misalnya: bookstore.endpoints.example-project-12345.cloud.goog

   sudo docker run \
       --detach \
       --name=esp \
       --publish=80:9000 \
       --net=esp_net \
       gcr.io/endpoints-release/endpoints-runtime:2 \
       --service=SERVICE_NAME \
       --rollout_strategy=managed \
       --listener_port=9000 \
       --backend=grpc://bookstore:8000
   

   Opsi --rollout_strategy=managed mengonfigurasi ESPv2 untuk menggunakan konfigurasi layanan yang di-deploy terbaru. Saat Anda menentukan opsi ini, dalam satu menit setelah Anda men-deploy konfigurasi layanan baru, ESPv2 akan mendeteksi perubahan dan otomatis mulai menggunakannya. Sebaiknya tentukan opsi ini, bukan memberikan ID konfigurasi tertentu untuk digunakan ESPv2. Untuk mengetahui detail selengkapnya tentang argumen ESPv2, lihat Opsi startup ESPv2.

Jika Anda menerima pesan error, lihat Memecahkan Masalah Endpoint di Compute Engine.

Mengirim permintaan ke API

Jika Anda mengirim permintaan dari instance yang sama tempat penampung 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 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 Anda tidak mendapatkan respons yang berhasil, lihat Memecahkan masalah error respons.

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

Catatan: Jika Anda ingin memberi tahu kami apa yang Anda sukai tentang tutorial ini, jangan ragu untuk memberikan 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 masalahnya. 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. Hapus API:

   gcloud endpoints services delete SERVICE_NAME

   Ganti SERVICE_NAME dengan nama layanan Anda.

2. Di konsol Google Cloud, buka halaman Instance VM.

   Buka VM instances

3. Pilih kotak centang untuk instance yang ingin Anda hapus.
4. Untuk menghapus instance, klik Tindakan lainnya, klik Hapus, lalu ikuti petunjuknya.

Langkah selanjutnya

• Cari tahu cara mengonfigurasi gRPC API Anda sendiri untuk Endpoints.
• Lihat contoh Toko Buku 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