Mulai menggunakan Cloud Endpoints untuk GKE dengan ESP

---

OpenAPI   |  gRPC

Tutorial ini menunjukkan cara mengonfigurasi dan men-deploy API contoh dan Extensible Service Proxy (ESP) ke cluster Google Kubernetes Engine (GKE).

REST API kode contoh dijelaskan menggunakan spesifikasi OpenAPI. Tutorial ini juga menunjukkan cara membuat kunci API dan menggunakannya saat mengirim permintaan ke API.

Tutorial ini menggunakan image container bawaan dari kode contoh dan ESP, yang disimpan di Artifact Registry.

Untuk ringkasan Cloud Endpoints, lihat Tentang Endpoints dan Arsitektur Endpoints.

Tujuan

Gunakan daftar tugas tingkat tinggi berikut saat Anda mengerjakan tutorial ini. Semua tugas di Bagian 1 diperlukan agar berhasil mengirim permintaan ke API.

Bagian 1

1. Siapkan project Google Cloud. Lihat Sebelum memulai.
2. Buat cluster container di GKE. Lihat Membuat cluster container.
3. Menginstal dan mengonfigurasi software yang digunakan dalam tutorial. Lihat Menginstal dan mengonfigurasi software yang diperlukan.
4. Download kode contoh. Lihat Mendapatkan kode contoh.
5. Konfigurasikan file openapi.yaml, yang digunakan untuk mengonfigurasi Cloud Endpoints. Lihat Mengonfigurasi Endpoint.
6. Deploy konfigurasi Endpoints untuk membuat layanan Endpoints. Lihat Men-deploy konfigurasi Endpoint.
7. Deploy API dan ESP ke cluster. Lihat Men-deploy backend API.
8. Dapatkan alamat IP cluster. Lihat Mendapatkan alamat IP eksternal cluster.
9. Kirim permintaan ke API menggunakan alamat IP. Lihat Mengirim permintaan menggunakan alamat IP.
10. Melacak aktivitas API. Lihat Melacak aktivitas API.

Bagian 2

1. Konfigurasikan data DNS untuk API contoh. Lihat Mengonfigurasi DNS untuk Endpoint.
2. Kirim permintaan ke API menggunakan nama domain yang sepenuhnya memenuhi syarat. Lihat Mengirim permintaan menggunakan FQDN.

Pembersihan

Setelah selesai, lihat Membersihkan untuk menghindari timbulnya biaya pada akun Google Cloud Anda.

Biaya

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

• GKE
• 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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Google Cloud project.

6. Catat project ID Google Cloud, karena Anda akan memerlukannya nanti.

Membuat cluster container

Anda harus membuat cluster container di GKE untuk menjalankan contoh kode backend API.

Untuk membuat cluster penampung API contoh:

1. Di konsol Google Cloud, buka halaman cluster GKE.
   

   Buka halaman cluster Kubernetes

2. Klik Buat kluster.

3. Setujui setelan default dan klik Create. Langkah ini dapat memerlukan waktu beberapa menit.

4. Catat nama dan zona cluster karena diperlukan saat Anda mengautentikasi kubectl ke cluster penampung.

Menginstal dan mengonfigurasi software yang diperlukan

Dalam tutorial ini, Anda akan menginstal gcloud CLI agar dapat menggunakan Google Cloud CLI untuk mengelola project. Anda menggunakan kubectl untuk menjalankan perintah terhadap cluster GKE. Anda juga memerlukan cara untuk menguji API.

Dalam prosedur berikut, jika Anda sudah menginstal software yang diperlukan, lanjutkan ke langkah berikutnya.

Untuk menginstal dan mengonfigurasi software yang diperlukan:

1. Anda memerlukan aplikasi untuk mengirim permintaan ke API contoh.

   • Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan curl, yang biasanya sudah diinstal sebelumnya di sistem operasi Anda. Jika tidak memiliki curl, Anda dapat mendownloadnya dari halaman curl Rilis dan download.
   • Pengguna Windows: Tutorial ini memberikan contoh penggunaan Invoke-WebRequest, yang didukung di PowerShell 3.0 dan yang lebih baru.
2. Instal dan lakukan inisialisasi gcloud CLI.
3. Update gcloud CLI dan instal komponen Endpoints:

   gcloud components update

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

6. Instal kubectl:

   gcloud components install kubectl

7. Dapatkan kredensial pengguna baru untuk digunakan untuk Kredensial Default Aplikasi. Kredensial pengguna diperlukan untuk memberikan otorisasi ke kubectl.

   gcloud auth application-default login

   Di tab browser baru yang terbuka, pilih akun.

Mendownload kode contoh

Untuk membantu Anda memulai dan menjalankan dengan cepat, kode contoh disediakan dalam beberapa bahasa.

Untuk mendownload kode contoh ke komputer lokal:

Java

Untuk meng-clone atau mendownload API contoh:

1. Clone repositori aplikasi contoh ke komputer lokal Anda:

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

   Atau, download contoh sebagai file ZIP, lalu ekstrak.

2. Ubah ke direktori yang berisi kode contoh:

   cd java-docs-samples/endpoints/getting-started

Python

Untuk meng-clone atau mendownload API contoh:

1. Clone repositori aplikasi contoh ke komputer lokal Anda:

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

   Atau, download contoh sebagai file ZIP, lalu ekstrak.

2. Ubah ke direktori yang berisi kode contoh:

   cd python-docs-samples/endpoints/getting-started

Go

Untuk meng-clone atau mendownload API contoh:

1. Pastikan variabel lingkungan GOPATH Anda telah ditetapkan.
2. Clone repositori aplikasi contoh ke komputer lokal Anda:

   go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

3. Ubah ke direktori yang berisi kode contoh:

   cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

PHP

Untuk meng-clone atau mendownload API contoh:

1. Clone repositori aplikasi contoh ke komputer lokal Anda:

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

   Atau, download contoh sebagai file ZIP, lalu ekstrak.

2. Ubah ke direktori yang berisi kode contoh:

   cd php-docs-samples/endpoints/getting-started

Ruby

Untuk meng-clone atau mendownload API contoh:

1. Clone repositori aplikasi contoh ke komputer lokal Anda:

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

   Atau, download contoh sebagai file ZIP, lalu ekstrak.

2. Ubah ke direktori yang berisi kode contoh:

   cd ruby-docs-samples/endpoints/getting-started

NodeJS

Untuk meng-clone atau mendownload API contoh:

1. Clone repositori aplikasi contoh ke komputer lokal Anda:

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

   Atau, download contoh sebagai file ZIP, lalu ekstrak.

2. Ubah ke direktori yang berisi kode contoh:

   cd nodejs-docs-samples/endpoints/getting-started

Mengonfigurasi Endpoint

Kode contoh menyertakan file konfigurasi OpenAPI, openapi.yaml, yang didasarkan pada Spesifikasi OpenAPI v2.0.

Untuk mengonfigurasi Endpoint:

1. Di direktori kode contoh, buka file konfigurasi openapi.yaml.
   Java

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Python

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Go

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   PHP

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Ruby

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   NodeJS

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Perhatikan hal berikut:

   • Contoh konfigurasi menampilkan baris di dekat kolom host, yang perlu Anda ubah. Untuk men-deploy file openapi.yaml ke Endpoint, dokumen OpenAPI lengkap diperlukan.
   • 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 yang tidak bergantung pada bahasa. File openapi.yaml yang sama ada dalam contoh getting-started di setiap repositori GitHub bahasa untuk memudahkan.

2. Di kolom host, ganti teks dengan nama layanan Endpoints, 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 Endpoints. 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 Endpoints, lihat Mengonfigurasi Endpoints.

Setelah menyelesaikan semua langkah konfigurasi berikut sehingga Anda dapat berhasil mengirim permintaan ke API contoh menggunakan alamat IP, lihat Mengonfigurasi DNS 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, Anda menggunakan perintah gcloud endpoints services deploy. Perintah ini menggunakan Pengelolaan Layanan untuk membuat layanan terkelola.

Untuk men-deploy konfigurasi Endpoint:

1. Pastikan Anda berada di direktori endpoints/getting-started.
2. Upload konfigurasi dan buat layanan terkelola:

   gcloud endpoints services deploy openapi.yaml
   

Perintah gcloud kemudian memanggil Service Management API untuk membuat layanan terkelola dengan nama yang Anda tentukan di kolom host 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 Endpoints.

Saat membuat dan mengonfigurasi layanan, Pengelolaan Layanan akan menampilkan 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 dengan ID konfigurasi layanan dan nama layanan, mirip dengan 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 yang 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 Endpoints > Services di Konsol Google Cloud.

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

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.

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 memandu Anda men-deploy container bawaan untuk API dan ESP contoh ke cluster.

Memeriksa izin yang diperlukan

ESP dan ESPv2 memanggil layanan Google yang menggunakan IAM untuk memverifikasi apakah identitas panggilan memiliki izin yang cukup untuk mengakses resource IAM yang digunakan. Identitas panggilan adalah akun layanan terlampir yang men-deploy ESP dan ESPv2.

Saat di-deploy di pod GKE, akun layanan terlampir adalah akun layanan node. Biasanya, akun layanan default Compute Engine. Ikuti rekomendasi izin ini untuk memilih akun layanan node yang sesuai.

Jika Workload Identity digunakan, akun layanan terpisah selain akun layanan node dapat digunakan untuk berkomunikasi dengan layanan Google. Anda dapat membuat akun layanan Kubernetes untuk pod agar dapat menjalankan ESP dan ESPv2, membuat akun layanan Google, dan mengaitkan akun layanan Kubernetes ke akun layanan Google.

Ikuti langkah-langkah berikut untuk mengaitkan akun layanan Kubernetes dengan akun layanan Google. Akun layanan Google ini adalah akun layanan terlampir.

Jika akun layanan yang dilampirkan adalah akun layanan default Compute Engine dari project dan konfigurasi layanan endpoint di-deploy di project yang sama, akun layanan harus memiliki izin yang cukup untuk mengakses resource IAM, sehingga langkah penyiapan peran IAM dapat dilewati. Jika tidak, peran IAM berikut harus ditambahkan ke akun layanan yang dilampirkan.

Tambahkan peran IAM yang diperlukan:

Bagian ini menjelaskan resource IAM yang digunakan oleh ESP dan ESPv2 serta peran IAM yang diperlukan agar akun layanan yang terpasang dapat mengakses resource ini.

Konfigurasi Layanan Endpoint

ESP dan ESPv2 memanggil Kontrol Layanan yang menggunakan konfigurasi layanan endpoint. Konfigurasi layanan endpoint adalah resource IAM dan ESP serta ESPv2 memerlukan peran Service Controller untuk mengaksesnya.

Peran IAM ada di konfigurasi layanan endpoint, bukan di project. Project dapat memiliki beberapa konfigurasi layanan endpoint.

Gunakan perintah gcloud berikut untuk menambahkan peran ke akun layanan yang terlampir 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 terlampir.

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 adalah sama. Di ESPv2, project pelacakan dapat ditentukan oleh flag --tracing_project_id, dan ditetapkan secara default ke project deployment.

ESP dan ESPv2 memerlukan peran Cloud Trace Agent untuk mengaktifkan Cloud Trace.

Gunakan perintah gcloud berikut untuk menambahkan peran ke akun layanan yang terlampir:

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 project ID pelacakan
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com adalah akun layanan yang terpasang. Untuk mengetahui informasi selengkapnya, lihat Apa yang dimaksud dengan peran dan izin?

Men-deploy container ke cluster

Container menawarkan mekanisme paket logis yang memungkinkan Anda membuat abstraksi aplikasi dari lingkungan tempat aplikasi tersebut berjalan. Anda menggunakan prosedur berikut untuk men-deploy API dan ESP contoh ke cluster.

Untuk men-deploy container ke cluster:

1. Dapatkan kredensial cluster dan sediakan untuk kubectl:

   gcloud container clusters get-credentials NAME 
   
       --zone ZONE

   Ganti NAME dengan nama cluster dan ZONE dengan zona cluster.
2. Men-deploy layanan Kubernetes ke cluster GKE. Layanan Kubernetes menerapkan API. Edit file konfigurasi Kubernetes /endpoints/getting-started/deployment.yaml, dan ganti SERVICE_NAME di opsi startup ESP dengan nama layanan Anda.
   Java

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
     ]

   Python

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
     ]

   Go

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   PHP

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   Ruby

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   NodeJS

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   Contoh:

     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=echo-api.endpoints.example-project-12345.cloud.goog ",
       "--rollout_strategy=managed",
     ]

   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 informasi tentang opsi ESP lain yang digunakan, lihat Opsi startup ESP.

   Sebaiknya tetapkan imagePullPolicy dalam spec penampung di atas ke Always. Hal ini akan memungkinkan pod yang baru dibuat untuk selalu mengambil ESP versi terbaru. Baca praktik terbaik konfigurasi untuk mengetahui detail selengkapnya. Saat ESP versi baru dirilis, Anda dapat melakukan mulai ulang bertahap semua pod untuk memastikan versi terbaru digunakan.

3. Mulai layanan Kubernetes menggunakan perintah kubectl apply:

   kubectl apply -f deployment.yaml

Catatan: Jika cluster GKE bersifat pribadi, Anda harus menggunakan server metadata Compute Engine sebagai DNS resolver untuk me-resolve nama host layanan Google. Tambahkan flag ESP ini: --dns=169.254.169.254

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

Lihat Men-deploy backend API untuk mengetahui informasi tambahan.

Mendapatkan alamat IP eksternal cluster

Untuk mengirim permintaan ke API, Anda memerlukan IP eksternal layanan. Mungkin perlu waktu beberapa menit setelah Anda memulai layanan di penampung sebelum alamat IP eksternal siap.

1. Lihat alamat IP eksternal:

   kubectl get service
   

2. Catat nilai untuk EXTERNAL-IP. Anda menggunakan alamat IP tersebut saat mengirim permintaan ke API contoh.

Mengirim permintaan menggunakan alamat IP

Setelah layanan berjalan di cluster penampung, dan Anda memiliki alamat IP eksternal, Anda dapat mengirim permintaan ke API.

Membuat kunci API dan menetapkan variabel lingkungan

Kode contoh memerlukan kunci API. Untuk menyederhanakan permintaan, Anda menetapkan variabel lingkungan untuk kunci API.

1. Di 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 yang berbeda, lihat Mengaktifkan API di project Google Cloud.

   Buka halaman Kredensial

2. Klik Create credentials, lalu pilih API key.
3. Salin kunci ke papan klip.
4. Klik Close.
5. Di komputer lokal, tempelkan kunci API untuk menetapkannya ke variabel lingkungan:
   • Di Linux atau macOS: export ENDPOINTS_KEY=AIza...
   • Di Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Kirim permintaan

Linux atau Mac OS

Gunakan curl untuk mengirim permintaan HTTP menggunakan variabel lingkungan ENDPOINTS_KEY yang Anda tetapkan 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 tanda petik terbalik. Saat menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda petik 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 nilai application/json.
• Untuk isi, masukkan kode berikut:
  {"message":"hello world"}
• Di URL, gunakan kunci API yang sebenarnya, bukan variabel lingkungan. Misalnya:
  http://192.0.2.0:80/echo?key=AIza...

API akan merespons 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.

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.

Melacak aktivitas API

Untuk melacak aktivitas API:

1. Lihat grafik aktivitas untuk API Anda di halaman Endpoints > Services.
   

   Buka halaman Endpoints Services

   
   Mungkin perlu waktu beberapa saat agar permintaan ditampilkan dalam grafik.

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

   Buka halaman Logs Explorer

Mengonfigurasi DNS untuk Endpoint

Karena nama layanan Endpoints 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 konfigurasi kecil dalam 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:

1. Buka file konfigurasi OpenAPI, openapi.yaml, dan tambahkan properti x-google-endpoints di tingkat teratas file (tidak diindentasi atau bertingkat) seperti yang 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"

2. Di properti name, ganti YOUR_PROJECT_ID dengan project ID Anda.
3. Di properti target, ganti IP_ADDRESS dengan alamat IP yang Anda gunakan saat mengirim permintaan ke API contoh.
4. Deploy file konfigurasi OpenAPI yang telah diperbarui ke Pengelolaan Layanan:

   gcloud endpoints services deploy openapi.yaml
   

Misalnya, asumsikan file openapi.yaml telah mengonfigurasi hal berikut:

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 me-resolve ke alamat IP target, 192.0.2.1. Mungkin perlu waktu beberapa menit agar konfigurasi DNS baru diterapkan.

Mengonfigurasi SSL

Untuk mengetahui detail selengkapnya tentang cara mengonfigurasi DNS dan SSL, lihat Mengaktifkan SSL untuk Endpoint.

Mengirim permintaan menggunakan FQDN

Setelah Anda mengonfigurasi data DNS untuk API contoh, kirim permintaan ke API 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 Cloud Endpoints Portal untuk membuat portal developer, situs yang dapat Anda gunakan untuk berinteraksi dengan API contoh. Untuk mempelajari lebih lanjut, lihat ringkasan Cloud Endpoints Portal.

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.

Lihat Menghapus API dan instance API untuk mengetahui informasi tentang cara menghentikan layanan yang digunakan oleh tutorial ini.

Langkah selanjutnya

• Pelajari cara mem-build image Docker.
• Pelajari cara men-deploy Endpoint di Kubernetes.
• Membagikan API Anda kepada developer lain.
• Pelajari autentikasi lebih lanjut.
• Pelajari opsi dukungan komunitas.
• Memecahkan masalah deployment GKE.