Setelah mengonfigurasi file .proto
dan file konfigurasi gRPC API, Anda dapat men-deploy-nya sehingga Cloud Endpoints memiliki informasi yang diperlukan untuk mengelola API Anda. Untuk
men-deploy konfigurasi Endpoint, gunakan
perintah gcloud
endpoints services deploy
. Perintah ini menggunakan Infrastruktur Layanan, platform layanan dasar Google, yang digunakan oleh Endpoint dan layanan lainnya untuk membuat serta mengelola API dan layanan. Halaman ini menjelaskan cara men-deploy file konfigurasi ke Endpoint.
Prasyarat
Sebagai titik awal, halaman ini mengasumsikan bahwa Anda telah:
Membuat project Google Cloud tempat Anda memiliki peran Editor atau Owner. Setelah deployment awal, Anda dapat memberikan peran Service Config Editor yang lebih ketat. Lihat Memberikan dan mencabut akses ke API untuk informasi selengkapnya.
Endpoint yang Dikonfigurasi, yang mencakup:
Jika menggunakan nama domain kustom (seperti
example.com
), Anda harus memverifikasi nama domain sebelum dapat men-deploy file konfigurasi gRPC.
Menyiapkan Google Cloud CLI untuk deployment
Gunakan alat command line gcloud
untuk men-deploy konfigurasi. Baca
Referensi gcloud untuk mengetahui informasi lebih lanjut tentang perintah.
Untuk mempersiapkan deployment:
- Menginstal dan melakukan inisialisasi gcloud CLI.
- Update gcloud CLI:
gcloud components update
- Pastikan gcloud CLI diberi otorisasi untuk mengakses data dan layanan Anda:
gcloud auth login
Tab browser baru akan terbuka dan Anda akan diminta untuk memilih akun.
- Tetapkan project default. Ganti
[YOUR-PROJECT-ID]
dengan project ID GCP Andagcloud config set project [YOUR-PROJECT-ID]
- Jika Anda akan men-deploy backend API ke Kubernetes atau Kubernetes Engine, jalankan perintah berikut untuk mendapatkan kredensial pengguna baru yang akan digunakan untuk Kredensial Default Aplikasi. Kredensial pengguna diperlukan untuk mengizinkan
kubectl
.gcloud auth application-default login
Tab browser baru akan terbuka dan Anda akan diminta untuk memilih akun.
Men-deploy file konfigurasi
- Pastikan Anda berada di direktori tempat file
api_descriptor.pb
danapi_config.yaml
berada. - 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
- 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 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 revisinya akan bertambah di ID konfigurasi layanan.
Jika konfigurasi layanan Anda berupa beberapa file YAML, Anda dapat meneruskan semuanya ke perintah deploy
. Misalnya, Bookstore memiliki konfigurasi dasar di api_config.yaml
, tetapi Anda dapat mengaktifkan transcoding HTTP untuk layanan dengan juga men-deploy api_config_http.yaml
, yang memiliki konfigurasi tambahan untuk fitur ini:
gcloud endpoints services deploy api_descriptor.pb api_config.yaml api_config_http.yaml
Perlu diperhatikan bahwa jika ada nilai yang bertentangan dalam file YAML, nilai dalam file yang terakhir ditentukan akan menggantikan nilai yang lain. Anda dapat mengetahui lebih lanjut cara Endpoint menangani penggabungan beberapa file YAML di Mengonfigurasi layanan gRPC.
Jika Anda menerima pesan error, lihat Memecahkan masalah deployment konfigurasi Endpoint untuk mendapatkan informasi tentang cara memecahkan masalah error tersebut.
Men-deploy ulang
Setiap kali Anda mengubah sesuatu di file YAML konfigurasi layanan atau .proto
, deploy kembali file tersebut agar Extensible Service Proxy (ESP) memiliki versi terbaru konfigurasi layanan API Anda. Jika sebelumnya Anda men-deploy ESP dengan opsi rollout
yang ditetapkan ke managed
, Anda tidak perlu memulai ulang atau men-deploy ulang ESP. Opsi rollout=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 mendeteksi perubahan dan otomatis mulai menggunakannya. Sebaiknya
tentukan opsi ini, bukan ID konfigurasi tertentu
yang akan digunakan ESP.
Setelah deployment konfigurasi Endpoint awal, Anda dapat memberi pengguna, akun layanan, atau grup peran yang memungkinkan mereka men-deploy ulang konfigurasi Endpoint. Lihat Memberikan dan mencabut akses ke API untuk informasi selengkapnya.
Langkah selanjutnya
- Mulai menggunakan Portal Cloud Endpoints
- Men-deploy backend API
- Menjalankan ESP secara Lokal atau di platform lain
- Mendapatkan nama layanan dan ID konfigurasi