Menyiapkan gRPC Cloud Endpoints untuk penayangan Knative dengan ESPv2

Membuat cluster GKE dengan layanan Knative diaktifkan

Untuk membuat cluster dan mengaktifkannya untuk penayangan Knative di Google Cloud:

1. Buat cluster baru menggunakan perintah:

   gcloud container clusters create CLUSTER_NAME \ 
     --addons=HttpLoadBalancing,CloudRun \ 
     --machine-type=n1-standard-4 \ 
     --num-nodes=3

   Ganti CLUSTER_NAME dengan nama yang Anda inginkan untuk cluster Anda.

   Meskipun petunjuk ini tidak mengaktifkan penskalaan otomatis cluster untuk mengubah ukuran cluster sesuai permintaan, layanan Knative di Google Cloud akan otomatis menskalakan instance dalam cluster.

2. Tunggu hingga pembuatan cluster selesai. Selama proses pembuatan, Anda akan melihat pesan yang mirip dengan berikut ini:

   Creating cluster CLUSTER_NAME...done. 
   Created [https://container.googleapis.com/v1/projects/ESP_PROJECT_ID/zones/ZONE/clusters/CLUSTER_NAME].

   Output juga menampilkan versi cluster di kolom NODE_VERSION output. Misalnya 1.15.11-gke.1 atau 1.14.10-gke.27. Catat versi cluster untuk digunakan nanti dalam dokumen ini.

3. Tetapkan default gcloud untuk menggunakan cluster dan lokasi cluster baru Anda, agar tidak perlu menentukannya saat Anda menggunakan gcloud CLI:

   gcloud config set run/cluster CLUSTER_NAME
   gcloud config set run/cluster_location ZONE

4. Gunakan perintah berikut untuk melihat detail tentang cluster baru:

   gcloud container clusters describe CLUSTER_NAME

5. Gunakan perintah berikut untuk mengambil kredensial untuk cluster Anda:

   gcloud container clusters get-credentials CLUSTER_NAME

Men-deploy layanan gRPC Cloud Run contoh

Untuk men-deploy container contoh Cloud Run for Anthos "grpc-bookstore" ke cluster yang baru saja Anda buat:

1. Ikuti langkah-langkah di Panduan memulai gRPC Python untuk menginstal gRPC dan alat gRPC.

2. Contoh server gRPC ini berisi image Docker yang telah di-build sebelumnya untuk "layanan grpc-bookstore" Python: gcr.io/endpointsv2/python-grpc-bookstore-server:2. Gunakan perintah berikut untuk men-deploy "grpc-bookstore" ke cluster Anda:

   gcloud run deploy GRPC_SERVICE \
     --image=gcr.io/endpointsv2/python-grpc-bookstore-server:2 \
     --platform=gke \
    --connectivity=internal \
     --use-http2

   Perhatikan bahwa Anda menentukannya sebagai layanan internal sehingga layanan tidak dapat diakses secara eksternal.

   Ganti GRPC_SERVICE dengan nama yang Anda inginkan untuk layanan Anda. Contoh:

   gcloud run deploy grpc-bookstore \
     --image=gcr.io/endpointsv2/python-grpc-bookstore-server:2 \
     --platform=gke \
     --connectivity=internal \
     --use-http2

   Setelah selesai, pesan berikut akan muncul:

   Service [grpc-bookstore] revision [grpc-bookstore-00001-nuk] has been deployed and is serving 100 percent of traffic at http://grpc-bookstore.default.svc.cluster.local

   Saat Anda membuat layanan internal, GKE akan membuat nama DNS (grpc-bookstore.default.svc.cluster.local dalam contoh ini) yang hanya dapat di-resolve untuk permintaan yang berasal dari dalam cluster itu sendiri, bukan untuk permintaan eksternal. Anda tidak dapat mengakses DNS ini secara eksternal dari cluster. Lihat layanan Cloud Run untuk mengetahui informasi selengkapnya.

3. Untuk memverifikasi bahwa layanan Anda berfungsi dengan benar, deploy pod dengan image Docker yang sama ke cluster Anda. Image ini berisi kode klien gRPC untuk "grpc-bookstore" yang dapat Anda gunakan untuk menguji layanan internal.

   1. Gunakan perintah kubectl berikut untuk men-deploy pod ke cluster yang sama dengan yang Anda deploy di atas:

      kubectl run grpc --generator=run-pod/v1 \
        --image=gcr.io/endpointsv2/python-grpc-bookstore-server:2

      Gambar ini berisi skrip bookstore_client.py yang dapat Anda gunakan untuk membuat permintaan klien dari dalam cluster.

      Catatan: Untuk versi kubectl yang lebih baru, perintah mungkin mengeluarkan peringatan berikut:

      Flag --generator has been deprecated, has no effect and will be removed in the future".

      Anda dapat mengabaikan peringatan tersebut.

   2. Dapatkan nama pod "grpc-bookstore" yang dibuat di cluster saat Anda men-deploy image Docker di langkah sebelumnya:

      kubectl get pods

      Anda akan melihat output dalam bentuk:

      NAME   READY    STATUS    RESTARTS   AGE
      grpc   1/1      Running   0          23h

      Dengan grp adalah nama pod "grpc-bookstore". Pastikan Status pod adalah Running sebelum melanjutkan.

   3. Gunakan perintah berikut untuk membuat permintaan klien ke layanan "grpc-bookstore":

      kubectl exec grpc -ti -- python3 bookstore_client.py \
        --host grpc-bookstore.default.svc.cluster.local --port=80

      Perintah ini menjalankan skrip bookstore_client.py secara internal di cluster untuk membuat permintaan gRPC ke layanan "grpc-bookstore" di nama host grpc-bookstore.default.svc.cluster.local.

      Jika semuanya berfungsi dengan benar, Anda akan melihat respons dalam bentuk:

      ListShelves: shelves {
        id: 1
        theme: "Fiction"
      }
      shelves {
        id: 2
        theme: "Fantasy"
      }

Mengonfigurasi Endpoint

Anda harus memiliki spesifikasi gRPC API yang menjelaskan permukaan layanan backend dan persyaratan autentikasi.

Tentang menyetel kolom nama spesifikasi gRPC API

Di kolom name spesifikasi gRPC API, Anda menentukan nama layanan Endpoints yang digunakan untuk mengakses layanan Cloud Run for Anthos. Nama layanan Endpoints berbentuk nama domain:

API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog

Karena nama layanan Endpoints sesuai dengan nama domain, nama tersebut harus mengikuti aturan berikut:

• Hanya boleh berisi huruf kecil, angka, titik, atau tanda pisah.
• Tidak boleh diawali dengan tanda hubung.
• Tidak boleh berisi garis bawah.

Contoh:

grpc-boostore-api.endpoints.ESP_PROJECT_ID.cloud.goog

Membuat spesifikasi API gRPC

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

1. Buat direktori baru untuk spesifikasi gRPC API, seperti my-anthos-grpc. Kemudian, cd ke direktori tersebut.

2. Clone repositori git tempat kode klien gRPC dihosting ke direktori baru Anda:

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

3. Ubah direktori kerja Anda:

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

   Perhatikan bahwa direktori ini berisi file bookstore.proto. File ini menentukan API layanan Bookstore.

4. Buat file deskriptor protobuf mandiri dari file .proto layanan Anda:

   1. Buat direktori generated_pb2 di bawah direktori kerja Anda.

   2. Buat file deskriptor, api_descriptor.pb, menggunakan compiler buffer protokol protoc. Jalankan perintah berikut di direktori yang berisi 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.

5. Ubah file api_config_anthos.yaml di direktori kerja Anda saat ini (direktori yang sama yang berisi bookstore.proto) untuk menambahkan konten berikut ke file:

   type: google.api.Service
   config_version: 3
   #
   # Name of the service configuration.
   #
   name: API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog
   #
   # API title to appear in the user interface (Google Cloud console).
   #
   title: Bookstore gRPC API In Cloud Run Anthors
   apis:
   - name: endpoints.examples.bookstore.Bookstore
   #
   # Create a DNS record to map your service name to IP address
   #
   endpoints:
     - name: API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog
       target: IP_ADDRESS
   #
   # Specify the backend address to route to
   #
   backend:
     rules:
       - selector: "*"
         address: grpc://GRPC_SERVICE.default.svc.cluster.local
         disable_auth: true
   #
   # API usage restrictions.
   #
   usage:
     rules:
     # ListShelves methods can be called without an API Key.
     - selector: endpoints.examples.bookstore.Bookstore.ListShelves
       allow_unregistered_calls: true

   Indentasi penting untuk format yaml.

6. Di kolom name, tentukan nama domain Endpoints API yang digunakan untuk mengakses layanan Cloud Run for Anthos Anda, dalam bentuk:

   API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog

   Contoh:

   grpc-bookstore-api.endpoints.ESP_PROJECT_ID.cloud.goog

7. Bagian endpoints mendaftarkan entri DNS untuk layanan Endpoints Anda di domain cloud.goog, dalam bentuk:

   endpoints:
     - name: API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog
       target: IP_ADDRESS

   IP_ADDRESS adalah IP layanan istio-ingress untuk cluster Anda. Untuk menentukan alamat IP ini:

   1. Buka halaman Google Kubernetes Engine di Konsol Cloud:

      Buka Google Kubernetes Engine

   2. Klik Services & Ingress di panel navigasi kiri untuk menampilkan daftar layanan.

   3. Jika versi cluster Anda adalah 1.15.3-gke.19 atau yang lebih baru, 1.14.3-gke.12 atau yang lebih baru, atau 1.13.10-gke.8 atau yang lebih baru, scroll ke bawah ke layanan istio-ingress. Untuk semua versi cluster lainnya, scroll ke bawah ke layanan istio-ingressgateway.

   4. Salin alamat IP eksternal yang ditampilkan di samping Load Balancer, tanpa setelan port, jika ada. Misalnya, jika IP-nya adalah XX.XXX.XX.XXX:15020, hapus :15020. Abaikan alamat IP lain yang tercantum.

8. Kolom address di bagian backend menentukan nama DNS internal layanan "grpc-bookstore" Cloud Run dengan skema proto grpc://, dan menonaktifkan autentikasi ke layanan ini:

   address: grpc://GRPC_SERVICE.default.svc.cluster.local
   disable_auth: true

   Contoh:

   address: grpc://grpc-bookstore.default.svc.cluster.local
   disable_auth: true

   Hal ini diperlukan karena panggilan dari ESPv2 ke layanan Cloud Run for Anthos dilakukan sebagai panggilan internal dari dalam cluster, sehingga autentikasi tidak diperlukan.

9. Perhatikan nilai properti title dalam file api_config_authos.yaml:

   title: Bookstore gRPC API In Cloud Run Anthos

   Nilai properti title menjadi nama layanan Endpoints setelah Anda men-deploy konfigurasi.

10. Simpan dokumen gRPC API Anda.

Untuk mengetahui informasi tentang kolom dalam dokumen OpenAPI yang diperlukan Endpoints, lihat Mengonfigurasi Endpoints.

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.

Untuk men-deploy konfigurasi Endpoints:

1. Pastikan Anda berada di direktori yang berisi dokumen gRPC.

2. Upload konfigurasi dan buat layanan terkelola.

   gcloud endpoints services deploy api_descriptor.pb api_config_anthos.yaml \ 
     --project ESP_PROJECT_ID

   Tindakan ini akan membuat layanan Endpoints baru dengan nama yang Anda tentukan di kolom name pada file api_config_anthos.yaml. Layanan Endpoints dikonfigurasi sesuai dengan dokumen OpenAPI Anda.

   Saat membuat dan mengonfigurasi layanan Endpoints, Service Management akan menampilkan informasi ke terminal. Setelah deployment selesai, pesan yang mirip dengan berikut ini akan ditampilkan:

   Service Configuration [CONFIG_ID] uploaded for service [API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog]

   CONFIG_ID adalah ID konfigurasi layanan Endpoints unik yang dibuat oleh deployment. Contoh:

   Service Configuration [2019-02-01r0] uploaded for service [grpc-bookstore-api.endpoints.ESP_PROJECT_ID.cloud.goog] 

   ID konfigurasi layanan terdiri dari stempel tanggal yang diikuti dengan nomor revisi. Jika Anda men-deploy api_config_anthos.yaml lagi pada hari yang sama, nomor revisi akan bertambah di ID konfigurasi layanan. Anda dapat melihat konfigurasi layanan dan histori deployment di halaman Endpoints > Services di konsol Google Cloud .

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

Memeriksa layanan yang diperlukan

Dalam sebagian besar kasus, perintah gcloud endpoints services deploy akan mengaktifkan layanan yang diperlukan ini. Namun, perintah gcloud berhasil diselesaikan, tetapi tidak mengaktifkan layanan yang diperlukan dalam keadaan 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 tempat layanan ini dinonaktifkan secara eksplisit.

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.

Membangun image penayangan Knative ESPv2 baru

Buat konfigurasi layanan Endpoints menjadi image Docker ESPv2 baru. Setelah membuat image ini, Anda dapat men-deploy-nya ke cluster.

Untuk membuat konfigurasi layanan menjadi image Docker ESPv2 baru:

1. Download skrip ini ke komputer lokal tempat gcloud CLI diinstal dan jalankan sebagai:

   chmod +x gcloud_build_image 
   ./gcloud_build_image -s API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog \ 
   -c CONFIG_ID -p ESP_PROJECT_ID

   Skrip menggunakan perintah gcloud untuk mendownload konfigurasi layanan, membangun konfigurasi layanan menjadi image ESPv2 baru, dan mengupload image baru ke Container Registry project Anda. Skrip ini otomatis menggunakan rilis ESPv2 terbaru, yang ditunjukkan oleh ESP_VERSION dalam nama gambar output. Gambar output diupload ke:

   gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog-CONFIG_ID

Men-deploy image inferensi Knative ESPv2

Deploy image layanan ESPv2 Knative ke cluster Anda:

1. Deploy layanan penyajian Knative ESPv2 dengan image baru:

   gcloud run deploy ESP_V2_SERVICE_NAME \ 
     --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog-CONFIG_ID" \ 
     --platform gke \
     --use-http2 \
     --project=ESP_PROJECT_ID

   Untuk ESP_PROJECT_ID, tentukan nama yang ingin Anda gunakan untuk layanan ESPv2. Dalam contoh ini, tetapkan ESP_V2_SERVICE_NAME ke espv2.

2. 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 ESP_V2_SERVICE_NAME \
     --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog-CONFIG_ID" \ 
     --set-env-vars=ESPv2_ARGS=--cors_preset=basic \ 
     --platform gke --use-http2 \
     --project ESP_PROJECT_ID

   Untuk mengetahui informasi dan contoh selengkapnya tentang cara menyetel variabel lingkungan ESPv2_ARGS, termasuk daftar opsi yang tersedia dan informasi tentang cara menentukan beberapa opsi, lihat Flag Extensible Service Proxy V2.

Membuat pemetaan domain ke layanan penayangan Knative ESPv2

Untuk dapat menghilangkan header host saat Anda membuat permintaan, tambahkan pemetaan domain untuk layanan ESPv2:

1. Buka Cloud Run

2. Pilih Kelola Domain Kustom.

3. Pilih Tambahkan Pemetaan.

4. Dari dropdown, pilih Tambahkan pemetaan domain layanan.

5. Di kolom Pilih layanan yang akan dipetakan pada pop-up Tambahkan pemetaan, pilih layanan ESPv2 Anda.

6. Di kolom Enter domain name, tentukan nama domain yang ingin Anda gunakan untuk mengakses layanan Knative melalui Endpoints. Misalnya, tentukan:

   API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog

   Dengan API_NAME adalah nama Endpoints API Anda. Untuk contoh ini, Anda dapat menggunakan "hello-api":

   grpc-bookstore-api.endpoints.ESP_PROJECT_ID.cloud.goog

7. Klik Lanjutkan. Ringkasan pemetaan akan muncul.

8. Pilih Selesai untuk menyimpan pemetaan.

Mengirim permintaan ke API

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

1. Pastikan Anda berada di direktori yang berisi dokumen gRPC, seperti api_config_anthos.yaml.

2. Instal dependensi:

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

3. Kirim permintaan ke API contoh:

   python3 bookstore_client.py --host API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog --port 80

   Contoh:

   python3 bookstore_client.py --host grpc-bookstore-api.endpoints.ESP_PROJECT_ID.cloud.goog --port 80

   Jika semuanya berfungsi dengan benar, Anda akan melihat respons dalam bentuk:

   ListShelves: shelves {
     id: 1
     theme: "Fiction"
   }
   shelves {
     id: 2
     theme: "Fantasy"
   }

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

Mengonfigurasi Endpoints API untuk menggunakan HTTPS

Dukungan TLS otomatis dinonaktifkan secara default untuk penayangan Knative di Google Cloud. Oleh karena itu, dalam contoh ini, saat Anda mengakses Endpoints API melalui ESPv2, Anda melakukan panggilan menggunakan HTTP.

Anda dapat mengonfigurasi ESPv2 untuk mendukung permintaan menggunakan HTTPS. Perhatikan bahwa Anda mengonfigurasi dukungan HTTPS di ESPv2, layanan eksternal, bukan di "hello", layanan backend internal.

Untuk mendukung HTTPS dengan ESPv2, Anda harus:

1. Miliki domain. Jika belum memiliki domain, Anda bisa mendapatkannya dari Google atau dari vendor domain lain.

2. Buat pemetaan domain untuk layanan ESPv2 Anda dan perbarui data DNS Anda sesuai petunjuk di halaman pemetaan domain.

   Jika Anda mendapatkan domain dari Google Domains, gunakan domain tersebut sebagai server DNS Anda. Jika tidak, gunakan Cloud DNS, atau server DNS pilihan Anda. Menggunakan domain dari Google Domains adalah opsi termudah.

3. Dalam spesifikasi OpenAPI Endpoints:

   1. Tetapkan kolom name untuk merujuk ke domain Anda, bukan ke *.cloud.goog.

   2. Hapus tag endpoints dan dua properti turunannya.

Untuk mengetahui petunjuk dan tutorial lengkapnya, lihat Mengaktifkan HTTPS dan sertifikat TLS otomatis.

Melacak aktivitas API

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

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

   Melihat log permintaan Endpoints