Halaman ini menunjukkan cara men-deploy contoh layanan gRPC sederhana dengan Extensible Service Proxy (ESP) dalam penampung Docker di Compute Engine.
Halaman 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.
- Siapkan project Google Cloud, dan download software yang diperlukan. Lihat Sebelum memulai.
- Buat instance VM Compute Engine. Lihat Membuat instance Compute Engine.
- Salin dan konfigurasikan file dari
contoh
bookstore-grpc
. Lihat Mengonfigurasi Endpoint. - Deploy konfigurasi Endpoint untuk membuat layanan Endpoint. Lihat Men-deploy konfigurasi Endpoint.
- Deploy API dan ESP di VM Compute Engine. Lihat Men-deploy backend API.
- 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 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: Di tab browser baru yang terbuka, pilih 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. - Ikuti langkah-langkah di panduan memulai gRPC Python untuk menginstal gRPC dan alat gRPC.
Membuat instance Compute Engine
- In the Google Cloud console, go to the Create an instance page.
- Di bagian Firewall, pilih Izinkan traffic HTTP dan Izinkan traffic HTTPS.
- Untuk membuat VM, klik Create.
- Pastikan Anda dapat terhubung ke instance VM.
- In the list of virtual machine instances, click SSH in the row of the instance that you want to connect to.
- Anda kini dapat menggunakan terminal untuk menjalankan perintah Linux di instance Debian.
- Masukkan
exit
untuk memutuskan koneksi dari instance.
- Catat nama instance, zona, dan alamat IP eksternal karena diperlukan nanti.
Untuk membuat instance Compute Engine:
Tunggu hingga instance memulai. Setelah siap, instance akan dicantumkan di halaman VM Instances dengan ikon status hijau.
Mengonfigurasi Endpoint
Clone repositori contoh bookstore-grpc
dari GitHub.
Untuk mengonfigurasi Endpoint:
- 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 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 dan ESP dalam penampung Docker.
Menginstal Docker di instance VM
Untuk menginstal Docker di instance VM:
- 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.
- Hubungkan ke instance Anda menggunakan perintah berikut:
gcloud compute ssh INSTANCE_NAME
Ganti INSTANCE_NAME dengan nama instance VM Anda.
- 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 ESP contoh di container Docker
Untuk menjalankan contoh layanan gRPC dengan ESP dalam penampung Docker agar klien dapat menggunakannya:
- Pada instance VM, buat jaringan penampung Anda sendiri yang disebut
esp_net
.sudo docker network create --driver bridge esp_net
- 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
- Jalankan container Docker ESP yang telah dikemas sebelumnya. Di
opsi startup ESP, ganti
SERVICE_NAME dengan nama layanan Anda. Ini adalah
nama yang sama dengan yang Anda konfigurasikan di
kolom
name
dalam fileapi_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:1 \ --service=SERVICE_NAME \ --rollout_strategy=managed \ --http2_port=9000 \ --backend=grpc://bookstore:8000
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.
Jika Anda mengaktifkan Transcoding, pastikan untuk mengonfigurasi port untuk traffic HTTP1.1 atau SSL.
Jika Anda menerima pesan error, lihat Memecahkan Masalah Endpoint di Compute Engine.
Mengirim permintaan ke API
Jika Anda mengirim permintaan dari instance yang sama dengan 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 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 layanan Anda. - In the Google Cloud console, go to the VM instances page.
- Select the checkbox for the instance that you want to delete.
- To delete the instance, click More actions, click Delete, and then follow the instructions.