Tutorial ini menunjukkan cara mengonfigurasi dan men-deploy contoh API dan Extensible Service Proxy (ESP) ke cluster Kubernetes yang tidak ada di Google Cloud. Jika Anda ingin menggunakan Google Kubernetes Engine (GKE), gunakan artikel Mulai Menggunakan Endpoint di GKE.
REST API kode contoh dijelaskan menggunakan spesifikasi OpenAPI. Tutorial ini juga menunjukkan cara membuat kunci API untuk mengirim permintaan ke API.
Tutorial ini menggunakan image container yang telah dibuat sebelumnya dari kode contoh dan ESP, yang disimpan di Container Registry. Jika belum memahami container, lihat artikel berikut untuk mengetahui informasi selengkapnya:
Untuk ringkasan Cloud Endpoints, lihat Tentang Endpoint dan arsitektur Endpoint.
Tujuan
Gunakan daftar tugas tingkat tinggi berikut saat Anda mengerjakan tutorial. Semua tugas di Bagian 1 diperlukan agar berhasil mengirim permintaan ke API.
Bagian 1
- Menyiapkan project Google Cloud. Lihat Sebelum memulai.
- Menginstal dan mengonfigurasi software yang digunakan dalam tutorial. Lihat Menginstal dan mengonfigurasi software yang diperlukan.
- Jika ingin, download kode contoh. Lihat Mendapatkan kode contoh.
- Download file konfigurasi Kubernetes. Lihat Mendapatkan file konfigurasi Kubernetes.
- Konfigurasi file
openapi.yaml
, yang digunakan untuk mengonfigurasi Endpoint. Lihat Mengonfigurasi Endpoint. - Deploy konfigurasi Endpoint untuk membuat layanan Cloud Endpoints. Lihat Men-deploy konfigurasi Endpoint.
- Buat kredensial untuk layanan Endpoint Anda. Lihat Membuat kredensial untuk layanan Anda.
- Men-deploy API dan ESP ke cluster. Lihat Men-deploy backend API.
- Dapatkan alamat IP eksternal layanan. Lihat Mendapatkan alamat IP eksternal.
- Kirim permintaan ke API menggunakan alamat IP. Lihat Mengirim permintaan menggunakan alamat IP.
- Melacak aktivitas API. Lihat Aktivitas Tracking API.
Bagian 2
- Konfigurasikan data DNS untuk API contoh. Lihat Mengonfigurasi DNS untuk Endpoint.
- Kirim permintaan ke API menggunakan nama domain. Lihat Mengirim permintaan menggunakan FQDN.
Pembersihan
Setelah selesai, lihat Pembersihan untuk menghindari timbulnya tagihan ke akun Google Cloud Anda.
Biaya
Dalam dokumen ini, Anda 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
Tutorial ini mengasumsikan bahwa Anda telah menyiapkan Minikube atau cluster Kubernetes. Untuk mengetahui informasi selengkapnya, lihat dokumentasi Kubernetes.
- Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.
-
Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.
-
Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.
-
Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.
-
Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.
- Catat ID project Google Cloud karena akan diperlukan nanti.
Menginstal dan mengonfigurasi software yang diperlukan
Dalam tutorial ini, Anda akan menginstal Google Cloud CLI untuk menggunakan gcloud CLI untuk mengelola project Anda.
Anda menggunakan kubectl
, antarmuka command line, untuk menjalankan perintah pada cluster Kubernetes. Anda juga
memerlukan cara untuk menguji API.
Dalam prosedur berikut, jika Anda telah menginstal software yang diperlukan, lanjutkan ke langkah berikutnya.
Untuk menginstal dan mengonfigurasi software yang diperlukan:
-
Anda memerlukan aplikasi untuk mengirim permintaan ke API contoh.
- Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan
curl
, yang biasanya telah diinstal sebelumnya di sistem operasi Anda. Jika tidak memilikicurl
, Anda dapat mendownloadnya daricurl
Halaman rilis dan download. - Pengguna Windows: Tutorial ini memberikan contoh menggunakan
Invoke-WebRequest
, yang didukung di PowerShell 3.0 dan yang lebih baru.
- Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan
- Instal dan lakukan inisialisasi gcloud CLI.
-
Update gcloud CLI dan instal komponen Endpoint:
gcloud components update
-
Pastikan Google Cloud CLI (
gcloud
) diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud: Di tab baru yang terbuka, pilih akun.gcloud auth login
- Setel 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. - Instal
kubectl
:gcloud components install kubectl
-
Mendapatkan kredensial pengguna baru untuk digunakan pada kredensial default aplikasi.
Kredensial pengguna memberi otorisasi kepada
kubectl
.gcloud auth application-default login
- Di tab baru yang terbuka, pilih akun.
- Jalankan perintah berikut untuk memastikan klien Kubernetes Anda dikonfigurasi dengan benar:
kubectl version
Anda akan melihat output yang mirip dengan berikut ini:
Client Version: version.Info{Major:"1", Minor:"8", GitVersion:"v1.8.4", GitCommit:"9befc2b8928a9426501d3bf62f72849d5cbcd5a3", GitTreeState:"clean", BuildDate:"2017-11-20T05:28:34Z", GoVersion:"go1.8.3", Compiler:"gc", Platform:"linux/amd64"} Server Version: version.Info{Major:"1", Minor:"7+", GitVersion:"v1.7.8-gke.0", GitCommit:"a7061d4b09b53ab4099e3b5ca3e80fb172e1b018", GitTreeState:"clean", BuildDate:"2017-10-10T18:48:45Z", GoVersion:"go1.8.3", Compiler:"gc", Platform:"linux/amd64"}
Mendownload kode contoh
Jika ingin, download kode contoh. Dalam tutorial ini, Anda akan men-deploy image container bawaan, sehingga Anda tidak perlu membangun container dari kode contoh. Namun, Anda dapat mendownload kode contoh, yang disediakan dalam beberapa bahasa untuk membantu Anda memahami cara kerja API contoh.
Untuk mendownload kode contoh:
Untuk meng-clone atau mendownload contoh API:
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd java-docs-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/python-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd python-docs-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Pastikan
variabel lingkungan
GOPATH
Anda ditetapkan. - Clone repositori aplikasi contoh ke komputer lokal Anda:
go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
- Ubah ke direktori yang berisi kode contoh:
cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/php-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd php-docs-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd ruby-docs-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd nodejs-docs-samples/endpoints/getting-started
Mendapatkan file konfigurasi Kubernetes
Clone repositori GitHub yang berisi file
yaml
yang digunakan dalam tutorial ini ke mesin lokal Anda:git clone https://github.com/googlecloudplatform/endpoints-samples
Atau, download sampel sebagai file zip dan ekstrak.
Ubah ke direktori yang berisi file konfigurasi:
cd endpoints-samples/kubernetes
Mengonfigurasi Endpoint
Kode contoh mencakup file konfigurasi OpenAPI, openapi.yaml
, yang
didasarkan pada
spesifikasi OpenAPI v2.0.
Untuk mengonfigurasi Endpoint:
- Di direktori kode contoh, buka file konfigurasi
openapi.yaml
.Perhatikan hal-hal berikut:
- Contoh konfigurasi menampilkan garis di dekat kolom
host
, yang perlu Anda ubah. Untuk men-deploy fileopenapi.yaml
ke Endpoint, diperlukan dokumen OpenAPI lengkap. - Contoh file
openapi.yaml
berisi bagian untuk mengonfigurasi autentikasi yang tidak diperlukan untuk tutorial ini. Anda tidak perlu mengonfigurasi baris dengan YOUR-SERVICE-ACCOUNT-EMAIL dan YOUR-CLIENT-ID. - OpenAPI adalah spesifikasi tanpa bahasa. File
openapi.yaml
yang sama ada dalam contohgetting-started
di repositori GitHub setiap bahasa untuk memudahkan.
- Contoh konfigurasi menampilkan garis di dekat kolom
- Di kolom
host
, ganti teks dengan nama layanan Endpoint, yang harus dalam format berikut:host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
Ganti YOUR_PROJECT_ID dengan ID project Google Cloud Anda. Contoh:
host: "echo-api.endpoints.example-project-12345.cloud.goog"
Perhatikan bahwa echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
adalah nama layanan Endpoint. Ini bukan nama domain yang sepenuhnya memenuhi syarat (FQDN) yang Anda gunakan untuk mengirim permintaan ke API.
Untuk mengetahui informasi tentang kolom dalam dokumen OpenAPI yang diperlukan Endpoint, lihat Mengonfigurasi Endpoint.
Setelah menyelesaikan semua langkah konfigurasi berikut, dan Anda dapat
berhasil mengirim permintaan ke API contoh menggunakan alamat IP, lihat
Mengonfigurasi DNS untuk Endpoint
untuk mengetahui informasi tentang cara mengonfigurasi
echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
menjadi FQDN.
Men-deploy konfigurasi Endpoint
Untuk men-deploy konfigurasi Endpoint, gunakan perintah gcloud endpoints
services deploy
. Perintah ini menggunakan Service Management untuk membuat layanan terkelola.
Untuk men-deploy konfigurasi Endpoint:
- Pastikan Anda berada di direktori
endpoints-samples/k8s
. - Upload konfigurasi dan buat layanan terkelola:
gcloud endpoints services deploy openapi.yaml
Kemudian, perintah gcloud
akan memanggil Service Management API untuk membuat layanan terkelola dengan nama yang Anda tentukan di kolom host
pada file openapi.yaml
.
Pengelolaan Layanan mengonfigurasi layanan sesuai dengan setelan dalam file openapi.yaml
. Saat membuat perubahan pada
openapi.yaml
, Anda harus men-deploy ulang file untuk mengupdate
layanan Endpoint.
Saat membuat dan mengonfigurasi layanan, Pengelolaan Layanan akan menghasilkan informasi ke terminal. Anda dapat mengabaikan peringatan tentang jalur dalam file openapi.yaml
yang tidak memerlukan kunci API dengan aman.
Setelah selesai mengonfigurasi layanan, Pengelolaan Layanan akan menampilkan pesan yang berisi ID konfigurasi layanan dan nama layanan, seperti berikut:
Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]
Pada contoh sebelumnya, 2017-02-13r0
adalah ID konfigurasi layanan, dan echo-api.endpoints.example-project-12345.cloud.goog
adalah layanan Endpoint. ID konfigurasi layanan terdiri dari
stempel tanggal diikuti dengan nomor revisi. Jika Anda men-deploy file openapi.yaml
lagi pada hari yang sama, nomor revisi akan bertambah di ID konfigurasi layanan. Anda dapat melihat konfigurasi layanan Endpoints di halaman Endpoint > Services di Konsol Google Cloud.
Jika Anda mendapatkan pesan error, lihat Memecahkan masalah deployment konfigurasi Endpoint.
Memeriksa layanan yang diperlukan
Setidaknya, Endpoint dan ESP mewajibkan pengaktifan layanan Google berikut:Nama | Judul |
---|---|
servicemanagement.googleapis.com |
Service Management API |
servicecontrol.googleapis.com |
Service Control API |
endpoints.googleapis.com |
Endpoint Google Cloud |
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 telah men-deploy konfigurasi Endpoint 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.comgcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com
Aktifkan juga layanan Endpoint Anda:
gcloud services enable ENDPOINTS_SERVICE_NAME
Untuk menentukan ENDPOINTS_SERVICE_NAME, Anda dapat:
Setelah men-deploy konfigurasi Endpoint, buka halaman Endpoint di Konsol Cloud. Daftar kemungkinan ENDPOINTS_SERVICE_NAME ditampilkan di bawah kolom Nama layanan.
Untuk OpenAPI, ENDPOINTS_SERVICE_NAME adalah nilai yang Anda tentukan dalam kolom
host
pada spesifikasi OpenAPI. Untuk gRPC, ENDPOINTS_SERVICE_NAME adalah nilai yang Anda tentukan di kolomname
pada konfigurasi Endpoint gRPC Anda.
Untuk mengetahui informasi selengkapnya tentang perintah gcloud
, lihat
layanan gcloud
.
Membuat kredensial untuk layanan Anda
Untuk menyediakan pengelolaan bagi API Anda, ESP dan ESPv2 memerlukan layanan di Infrastruktur Layanan. Untuk memanggil layanan ini, ESP dan ESPv2 harus menggunakan token akses. Saat Anda men-deploy ESP atau ESPv2 ke lingkungan Google Cloud, seperti GKE, Compute Engine, atau lingkungan fleksibel App Engine, ESP dan ESPv2 akan mendapatkan token akses untuk Anda melalui layanan metadata Google Cloud.
Saat Anda men-deploy ESP atau ESPv2 ke lingkungan non-Google Cloud, seperti desktop lokal, cluster Kubernetes lokal, atau penyedia cloud lainnya, Anda harus menyediakan file JSON akun layanan yang berisi kunci pribadi. ESP dan ESPv2 menggunakan akun layanan untuk membuat token akses guna memanggil layanan yang diperlukan untuk mengelola API Anda.
Anda dapat menggunakan konsol Google Cloud atau Google Cloud CLI untuk membuat akun layanan dan file kunci pribadi:
Konsol
- Di konsol Google Cloud, buka halaman Service Accounts .
- Klik Select a project.
- Pilih project tempat API Anda dibuat, lalu klik Open.
- Klik + Buat Akun Layanan.
- Di kolom Nama akun layanan, masukkan nama akun layanan Anda.
- Klik Create.
- Klik Lanjutkan.
- Klik Done.
- Klik alamat email akun layanan yang baru dibuat.
- Klik Kunci.
- Klik Tambahkan kunci, lalu klik Buat kunci baru.
Klik Create. File kunci JSON akan didownload ke komputer Anda.
Pastikan Anda menyimpan file kunci dengan aman karena file tersebut dapat digunakan untuk melakukan autentikasi sebagai akun layanan Anda. Anda dapat memindahkan dan mengganti nama file ini sesuai keinginan Anda.
Klik Close.
gcloud
Masukkan informasi berikut guna menampilkan project ID untuk project Google Cloud Anda:
gcloud projects list
Ganti PROJECT_ID dalam perintah berikut untuk menetapkan project default ke project tempat API Anda berada:
gcloud config set project PROJECT_ID
Pastikan Google Cloud CLI (
gcloud
) diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud:gcloud auth login
Jika Anda memiliki lebih dari satu akun, pastikan untuk memilih akun yang ada di project Google Cloud tempat API berada. Jika Anda menjalankan
gcloud auth list
, akun yang dipilih akan ditampilkan sebagai akun aktif untuk project.Untuk membuat akun layanan, jalankan perintah berikut dan ganti SERVICE_ACCOUNT_NAME dan
My Service Account
dengan nama dan nama tampilan yang ingin Anda gunakan:gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \ --display-name "My Service Account"
Perintah ini menetapkan alamat email untuk akun layanan dalam format berikut:
SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Alamat email ini diperlukan pada perintah berikutnya.
Buat file kunci akun layanan:
gcloud iam service-accounts keys create ~/service-account-creds.json \ --iam-account SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Tambahkan peran IAM yang diperlukan:
Bagian ini menjelaskan resource IAM yang digunakan oleh ESP dan ESPv2, serta peran IAM yang diperlukan untuk akun layanan yang disertakan untuk mengakses resource ini.
Konfigurasi Layanan Endpoint
ESP dan ESPv2 memanggil Service Control yang menggunakan konfigurasi layanan endpoint. Konfigurasi layanan endpoint adalah resource IAM, dan ESP dan ESPv2 memerlukan peran Pengontrol Layanan untuk mengaksesnya.
Peran IAM ada pada konfigurasi layanan endpoint, bukan pada project. Sebuah project mungkin memiliki beberapa konfigurasi layanan endpoint.
Gunakan perintah gcloud berikut untuk menambahkan peran ke akun layanan yang terpasang untuk konfigurasi layanan endpoint.
gcloud endpoints services add-iam-policy-binding SERVICE_NAME \ --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \ --role roles/servicemanagement.serviceController
Dengan
* SERVICE_NAME
adalah nama layanan endpoint
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com
adalah akun layanan yang disertakan.
Cloud Trace
ESP dan ESPv2 memanggil layanan
Cloud Trace untuk mengekspor Trace ke project. Project ini disebut project
pelacakan. Di ESP, project pelacakan dan project yang memiliki
konfigurasi layanan endpoint sama. Di ESPv2, project pelacakan dapat ditentukan oleh flag --tracing_project_id
, dan ditetapkan secara default ke project deployment.
ESP dan ESPv2 memerlukan peran Agen Cloud Trace untuk mengaktifkan Cloud Trace.
Gunakan perintah gcloud berikut untuk menambahkan peran ke akun layanan yang terpasang:
gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \ --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \ --role roles/cloudtrace.agent
Dengan
* TRACING_PROJECT_ID adalah ID project pelacakan
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com
adalah akun layanan yang disertakan.
Untuk mengetahui informasi selengkapnya, lihat
Apa yang dimaksud dengan peran dan izin?
Lihat
gcloud iam service-accounts
untuk mengetahui informasi selengkapnya tentang perintah ini.
Men-deploy backend API
Sejauh ini Anda telah men-deploy dokumen OpenAPI ke Pengelolaan Layanan, tetapi belum men-deploy kode yang menayangkan backend API. Bagian ini akan menuntun Anda dalam men-deploy container yang telah dibangun untuk contoh API dan ESP ke Kubernetes.
Memeriksa izin yang diperlukan
Berikan izin yang diperlukan ke akun layanan yang terkait dengan cluster Anda:
gcloud endpoints services add-iam-policy-binding SERVICE_NAME \ --member "serviceAccount:SERVICE_ACCOUNT" \ --role roles/servicemanagement.serviceController
Untuk mengetahui informasi selengkapnya, lihat Apa yang dimaksud dengan peran dan izin?
Menyediakan kredensial layanan kepada ESP
ESP, yang berjalan di dalam container, memerlukan akses ke kredensial yang disimpan secara lokal di file service-account-creds.json
. Untuk memberi ESP akses ke kredensial, Anda membuat rahasia Kubernetes dan memasang secret Kubernetes sebagai volume Kubernetes.
Untuk membuat secret Kubernetes dan memasang volume:
Pastikan untuk mengganti nama file JSON menjadi
service-account-creds.json
dan menyalinnya keendpoints-samples/k8s
jika file tersebut didownload ke direktori lain. Dengan cara ini, nama tersebut cocok dengan opsi yang ditentukan dalam file manifes deploymentesp_echo_http.yaml
.Pastikan Anda berada di direktori
endpoints-samples/k8s
.Buat rahasia Kubernetes dengan kredensial akun layanan:
kubectl create secret generic service-account-creds \ --from-file=service-account-creds.json
Jika berhasil, pesan berikut akan ditampilkan:
secret "service-account-creds" created
File manifes deployment yang Anda gunakan untuk men-deploy API dan ESP ke Kubernetes sudah berisi volume rahasia, seperti yang ditunjukkan di dua bagian file berikut:
Mengonfigurasi nama layanan dan memulai layanan
ESP perlu mengetahui nama layanan untuk menemukan konfigurasi yang Anda deploy sebelumnya (dengan menggunakan perintah gcloud endpoints services deploy
).
Untuk mengonfigurasi nama layanan dan memulai layanan:
Buka file manifes deployment,
esp_echo_http.yaml
, dan ganti SERVICE_NAME di opsi startup ESP dengan nama layanan Anda. Nama ini sama dengan nama yang Anda konfigurasikan di kolomhost
pada dokumen OpenAPI Anda. Contoh:"--service=echo-api.endpoints.example-project-12345.cloud.goog"
Opsi
--rollout_strategy=managed"
mengonfigurasi ESP untuk menggunakan konfigurasi layanan yang terakhir di-deploy. Saat Anda menentukan opsi ini, hingga 5 menit setelah Anda men-deploy konfigurasi layanan baru, ESP akan mendeteksi perubahan tersebut dan mulai menggunakannya secara otomatis. Sebaiknya tentukan opsi ini, bukan ID konfigurasi khusus untuk digunakan ESP. Untuk mengetahui informasi tentang opsi ESP lain yang digunakan, lihat opsi startup ESP.Mulai layanan untuk men-deploy layanan Endpoint di Kubernetes:
kubectl create -f echo.yaml
Jika Anda melihat pesan error yang mirip dengan yang berikut ini:
The connection to the server localhost:8080 was refused - did you specify the right host or port?
Hal ini menunjukkan bahwa
kubectl
tidak dikonfigurasi dengan benar. Lihat Mengonfigurasi kubectl untuk mengetahui informasi selengkapnya.
Untuk mengetahui informasi selengkapnya, lihat Men-deploy Endpoint di Kubernetes.
Mendapatkan alamat IP eksternal layanan
Jika Anda menggunakan Minikube, lanjutkan ke Mengirim permintaan menggunakan alamat IP.
Perlu waktu beberapa menit setelah Anda memulai layanan di container sebelum alamat IP eksternal siap.
Untuk melihat alamat IP eksternal layanan:
Jalankan perintah berikut:
kubectl get service
Catat nilai untuk EXTERNAL-IP. Anda akan menggunakan alamat IP tersebut saat mengirim permintaan ke API contoh.
Mengirim permintaan dengan menggunakan alamat IP
Setelah contoh API berjalan di cluster container, Anda dapat mengirim permintaan ke API.
Membuat kunci API dan menetapkan variabel lingkungan
Kode contoh memerlukan kunci API. Untuk menyederhanakan permintaan, Anda harus menetapkan variabel lingkungan untuk kunci API.
Dalam project Google Cloud yang sama dengan yang Anda gunakan untuk API, buat kunci API di halaman kredensial API. Jika Anda ingin membuat kunci API di project Google Cloud lain, baca artikel Mengaktifkan API di project Google Cloud.
- Klik Create credentials, lalu pilih API key.
- Salin kunci ke papan klip.
- Klik Close.
- Di komputer lokal Anda, tempel kunci API untuk menetapkannya ke variabel
lingkungan:
- Di Linux atau macOS:
export ENDPOINTS_KEY=AIza...
- Di Windows PowerShell:
$Env:ENDPOINTS_KEY="AIza..."
- Di Linux atau macOS:
Kirim permintaan ke minikube
Perintah berikut menggunakan variabel lingkungan ENDPOINTS_KEY yang Anda tetapkan sebelumnya.
Linux atau mac OS
NODE_PORT=`kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}'`
MINIKUBE_IP=`minikube ip`
curl --request POST \
--header "content-type:application/json" \
--data '{"message":"hello world"}' \
${MINIKUBE_IP}:${NODE_PORT}/echo?key=${ENDPOINTS_KEY}
PowerShell
$Env:NODE_PORT=$(kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}')
$Env:MINIKUBE_IP=$(minikube ip)
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
-Headers @{"content-type"="application/json"} `
-URI "http://$Env:MINIKUBE_IP:$Env:NODE_PORT/echo?key=$Env:ENDPOINTS_KEY").Content
Mengirim permintaan ke cluster Kubernetes lainnya
Linux atau mac OS
Gunakan curl
untuk mengirim permintaan HTTP menggunakan variabel lingkungan ENDPOINTS_KEY yang Anda setel sebelumnya. Ganti IP_ADDRESS dengan alamat IP eksternal instance Anda.
curl --request POST \ --header "content-type:application/json" \ --data '{"message":"hello world"}' \ "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"
Dalam curl
sebelumnya:
- Opsi
--data
menentukan data yang akan diposting ke API. - Opsi
--header
menentukan bahwa data dalam format JSON.
PowerShell
Gunakan Invoke-WebRequest
untuk mengirim permintaan HTTP menggunakan variabel lingkungan ENDPOINTS_KEY
yang Anda tetapkan sebelumnya. Ganti IP_ADDRESS dengan alamat IP eksternal instance Anda.
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' ` -Headers @{"content-type"="application/json"} ` -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content
Pada contoh sebelumnya, dua baris pertama diakhiri dengan {i>backtick<i}. Saat Anda menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda kutip terbalik. Untuk informasi tentang opsi yang digunakan dalam contoh permintaan, lihat Invoke-WebRequest dalam dokumentasi Microsoft.
Aplikasi pihak ketiga
Anda dapat menggunakan aplikasi pihak ketiga seperti ekstensi browser Chrome Postman untuk mengirim permintaan:
- Pilih
POST
sebagai kata kerja HTTP. - Untuk header, pilih kunci
content-type
dan nilaiapplication/json
. - Untuk isi, masukkan informasi berikut:
{"message":"hello world"}
-
Di URL, gunakan kunci API yang sebenarnya, bukan variabel lingkungan.
Contoh:
http://192.0.2.0:80/echo?key=AIza...
API akan menggemakan kembali pesan yang Anda kirim, dan merespons dengan hal berikut:
{
"message": "hello world"
}
Jika Anda tidak mendapatkan respons yang berhasil, lihat Memecahkan masalah error respons.
Anda baru saja men-deploy dan menguji API di Endpoint.
Aktivitas API pelacakan
Untuk melacak aktivitas API:
Lihat grafik aktivitas untuk API Anda di halaman Endpoint > Services.
Mungkin perlu waktu beberapa saat agar permintaan ditampilkan dalam grafik.Lihat log permintaan untuk API Anda di halaman Logs Explorer.
Mengonfigurasi DNS untuk Endpoint
Karena nama layanan Endpoint untuk API berada di
domain .endpoints.YOUR_PROJECT_ID.cloud.goog
, Anda dapat
menggunakannya sebagai nama domain yang sepenuhnya memenuhi syarat (FQDN) dengan membuat
perubahan kecil pada konfigurasi file openapi.yaml
. Dengan cara ini, Anda dapat mengirim permintaan ke API contoh menggunakan echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
, bukan alamat IP.
Untuk mengonfigurasi DNS Endpoint:
- Buka file konfigurasi OpenAPI,
openapi.yaml
, lalu tambahkan propertix-google-endpoints
di tingkat teratas file (tidak diindentasi atau disarangkan) seperti ditunjukkan dalam cuplikan berikut:host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog" x-google-endpoints: - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog" target: "IP_ADDRESS"
- Di properti
name
, ganti YOUR_PROJECT_ID dengan project ID Anda. - Di properti
target
, ganti IP_ADDRESS dengan alamat IP yang Anda gunakan saat mengirim permintaan ke API contoh. - Deploy file konfigurasi OpenAPI yang telah diupdate ke Service Management:
gcloud endpoints services deploy openapi.yaml
Misalnya, anggaplah file openapi.yaml
memiliki hal berikut yang dikonfigurasi:
host: "echo-api.endpoints.example-project-12345.cloud.goog" x-google-endpoints: - name: "echo-api.endpoints.example-project-12345.cloud.goog" target: "192.0.2.1"
Saat Anda men-deploy file openapi.yaml
menggunakan perintah gcloud
sebelumnya, Pengelolaan Layanan akan membuat data A DNS, echo-api.endpoints.my-project-id.cloud.goog
, yang di-resolve ke alamat IP target, 192.0.2.1
. Mungkin perlu waktu beberapa menit hingga konfigurasi DNS baru diterapkan.
Mengonfigurasi SSL
Untuk mengetahui detail selengkapnya mengenai cara mengonfigurasi DNS dan SSL, baca Mengaktifkan SSL untuk Endpoint.
Mengirim permintaan ke FQDN
Setelah Anda mengonfigurasi data DNS untuk API contoh, kirim permintaan ke data DNS tersebut menggunakan FQDN (ganti YOUR_PROJECT_ID dengan project ID Anda) dan variabel lingkungan ENDPOINTS_KEY yang ditetapkan sebelumnya:- Di Linux atau mac OS:
curl --request POST \ --header "content-type:application/json" \ --data '{"message":"hello world"}' \ "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"
- Di Windows PowerShell:
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content
Membuat portal developer untuk API
Anda dapat menggunakan Portal Cloud Endpoints untuk membuat portal developer, yaitu situs yang dapat digunakan untuk berinteraksi dengan contoh API. Untuk mempelajari lebih lanjut, lihat Ringkasan Portal Cloud Endpoints.
Pembersihan
Agar tidak dikenakan 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-nya.
Hapus layanan dan deployment Kubernetes:
kubectl delete -f esp_echo_http.yaml
Lihat Menghapus instance API dan API untuk mengetahui informasi tentang cara menghentikan layanan yang digunakan oleh tutorial ini.