Memulai Cloud Endpoints untuk Grup Instance Terkelola (MIG) dengan ESPv2

OpenAPI   |  gRPC

Tutorial ini menunjukkan cara mengonfigurasi dan men-deploy sampel API dan Extensible Service Proxy V2 (ESPv2) yang berjalan di container Docker bawaan di Managed Instance Group (MIG) .

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

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.

1. Siapkan Google Cloud project. Lihat Sebelum memulai.
2. Download kode contoh. Lihat Mendapatkan kode contoh.
3. Konfigurasi file openapi.yaml, yang digunakan untuk mengonfigurasi Endpoints. Lihat Mengonfigurasi Endpoint.
4. Deploy konfigurasi Endpoints untuk membuat layanan Endpoints. Lihat Men-deploy konfigurasi Endpoints.
5. Deploy API dan ESPv2 di backend Managed Instance Group (MIG). Lihat Men-deploy backend API.
6. Kirim permintaan ke API menggunakan alamat IP. Lihat Mengirim permintaan menggunakan alamat IP.
7. Konfigurasi data DNS untuk contoh API. Lihat Mengonfigurasi DNS untuk Endpoint.
8. Kirim permintaan ke API menggunakan nama domain yang sepenuhnya memenuhi syarat. Lihat Mengirim permintaan menggunakan FQDN.
9. Lacak aktivitas API. Lihat Melacak aktivitas API.
10. Hindari menimbulkan biaya pada akun Google Cloud Anda. Lihat Pembersihan.

Biaya

Di dokumen ini, Anda akan menggunakan komponen Google Cloudyang dapat ditagih berikut:

• Compute Engine
• Endpoints

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga.

Pengguna Google Cloud baru 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, baca bagian Pembersihan.

Sebelum memulai

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.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

1. Catat project ID karena akan diperlukan nanti.

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

   • Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan curl, yang biasanya sudah diinstal sebelumnya di sistem operasi Anda. Jika Anda belum memiliki curl, Anda dapat mendownloadnya dari curl Halaman rilis dan download.
   • Pengguna Windows: Tutorial ini memberikan contoh menggunakan Invoke-WebRequest, yang didukung di PowerShell 3.0 dan yang lebih baru.
3. Download Google Cloud CLI.
4. Update gcloud CLI dan instal komponen Endpoints.

   gcloud components update

5. Pastikan Google Cloud CLI (gcloud) diizinkan untuk mengakses data dan layanan Anda di Google Cloud:

   gcloud auth login

   Di tab browser baru yang terbuka, pilih akun.
6. 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 Anda ingin menggunakan gcloud untuk mengelolanya, lihat Mengelola konfigurasi gcloud CLI.

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.

Mendownload kode contoh

Download kode contoh ke komputer lokal Anda.

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

Mulai

Untuk meng-clone atau mendownload API contoh:

1. Pastikan GOPATH variabel lingkungan 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

Anda harus memiliki dokumen OpenAPI berdasarkan OpenAPI 2.0 atau OpenAPI 3.x yang mendeskripsikan platform aplikasi Anda dan persyaratan autentikasi apa pun. Untuk mempelajari lebih lanjut, lihat Versi OpenAPI yang didukung.

Anda juga perlu menambahkan kolom khusus Google yang berisi URL untuk setiap aplikasi agar ESPv2 memiliki informasi yang diperlukan untuk memanggil aplikasi. Jika Anda baru menggunakan OpenAPI, lihat Ringkasan OpenAPI untuk mengetahui informasi selengkapnya.

OpenAPI 2.0

Untuk mengonfigurasi Endpoints menggunakan spesifikasi OpenAPI 2.0, Anda dapat menggunakan file openapi.yaml yang tersedia di direktori endpoints/getting-started dari contoh kode yang didownload.

Isi spesifikasi OpenAPI 2.0 akan terlihat seperti berikut:

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"

consumes:
  - "application/json"
produces:
  - "application/json"

schemes:
# Uncomment the next line if you configure SSL for this API.
# - "https"
  - "http"

paths:
  /echo:
    post:
      description: "Echo back a given message."
      operationId: "echo"
      produces:
        - "application/json"
      responses:
        200:
          description: "Echo"
          schema:
            $ref: "#/definitions/echoMessage"
      parameters:
        -
          description: "Message to echo"
          in: body
          name: message
          required: true
          schema:
            $ref: "#/definitions/echoMessage"
      security:
        - api_key: []
  /auth/info/googlejwt:
    get:
      description: "Returns the requests' authentication information."
      operationId: "auth_info_google_jwt"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authenication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_jwt: []
  /auth/info/googleidtoken:
    get:
      description: "Returns the requests' authentication information."
      operationId: "authInfoGoogleIdToken"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authentication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_id_token: []

definitions:
  echoMessage:
    type: "object"
    properties:
      message:
        type: "string"
  authInfoResponse:
    properties:
      id:
        type: "string"
      email:
        type: "string"

securityDefinitions:
  # This section configures basic authentication with an API key.
  api_key:
    type: "apiKey"
    name: "key"
    in: "query"

  # This section configures authentication using Google API Service Accounts
  # to sign a json web token. This is mostly used for server-to-server
  # communication.
  google_jwt:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    # This must match the 'iss' field in the JWT.
    x-google-issuer: "jwt-client.endpoints.sample.google.com"
    # Update this with your service account's email address.
    x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
    # This must match the "aud" field in the JWT. You can add multiple
    # audiences to accept JWTs from multiple clients.
    x-google-audiences: "echo.endpoints.sample.google.com"
  # This section configures authentication using Google OAuth2 ID Tokens.
  # ID Tokens can be obtained using OAuth2 clients, and can be used to access
  # your API on behalf of a particular user.

  google_id_token:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    x-google-issuer: "https://accounts.google.com"
    x-google-jwks_uri: "https://www.googleapis.com/oauth2/v3/certs"
    # Your OAuth2 client's Client ID must be added here. You can add
    # multiple client IDs to accept tokens from multiple clients.
    x-google-audiences: "YOUR_CLIENT_ID"

OpenAPI 3.x

Untuk mengonfigurasi Endpoints menggunakan spesifikasi OpenAPI 3.x, Anda dapat mengganti isi file openapi.yaml yang tersedia di direktori endpoints/getting-started dari kode contoh yang didownload:

1. Buka openapi.yaml di editor teks Anda dan ganti kontennya dengan berikut:

   openapi: 3.0.4
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   servers:
     - url: "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
       x-google-endpoint: {}
   
   paths:
     "/echo":
       post:
         description: "Echo back a given message."
         operationId: "echo"
         requestBody:
           description: "Message to echo"
           required: true
           content:
             "application/json":
               schema:
                 $ref: "#/components/schemas/echoMessage"
         responses:
           '200':
             description: "Echo"
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/echoMessage"
         security:
           - api_key: []
   
     "/auth/info/googlejwt":
       get:
         description: "Returns the requests' authentication information."
         operationId: "auth_info_google_jwt"
         responses:
           '200':
             description: "Authentication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - api_key: []
             google_jwt: []
   
     "/auth/info/googleidtoken":
       get:
         description: "Returns the requests' authentication information."
         operationId: "authInfoGoogleIdToken"
         responses:
           '200':
             description: "Authentication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - api_key: []
             google_id_token: []
   
   components:
     schemas:
       echoMessage:
         type: "object"
         properties:
           message:
             type: "string"
       authInfoResponse:
         properties:
           id:
             type: "string"
           email:
             type: "string"
   
     securitySchemes:
       api_key:
         type: "apiKey"
         name: "key"
         in: "query"
   
       google_jwt:
         type: "oauth2"
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "jwt-client.endpoints.sample.google.com"
           jwksUri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
           audiences: "echo.endpoints.sample.google.com"
   
       google_id_token:
         type: "oauth2"
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "https://accounts.google.com"
           jwksUri: "https://www.googleapis.com/oauth2/v3/certs"
           audiences:
             - "YOUR_CLIENT_ID"

2. Simpan konten baru openapi.yaml.

Catatan: 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.

Tutorial ini menggunakan ekstensi khusus Google untuk spesifikasi OpenAPI yang memungkinkan Anda mengonfigurasi nama layanan. Metode untuk menentukan nama layanan bergantung pada versi spesifikasi OpenAPI yang Anda gunakan.

OpenAPI 2.0

Gunakan kolom host untuk menentukan nama layanan:

host: echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog

Untuk mengonfigurasi Endpoint:

1. Buka file openapi.yaml.
2. Di kolom host, ganti YOUR_PROJECT_ID dengan project ID Google Cloud Anda.
3. Simpan file openapi.yaml.

OpenAPI 3.x

Gunakan kolom url dalam objek servers untuk menentukan nama layanan:

servers:
- url: https://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
  x-google-endpoint: {}

Untuk mengonfigurasi Endpoint:

1. Buka file openapi.yaml.
2. Jika file openapi.yaml Anda memiliki kolom host, hapus kolom tersebut.
3. Tambahkan objek servers seperti yang ditunjukkan.
4. Di kolom url, ganti YOUR_PROJECT_ID dengan project ID Google Cloud Anda.
5. Simpan file openapi.yaml.

Setelah Anda menyelesaikan semua langkah konfigurasi berikut sehingga Anda dapat berhasil mengirim permintaan ke contoh API menggunakan alamat IP, lihat Mengonfigurasi DNS Endpoints untuk mengetahui informasi tentang cara mengonfigurasi echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog agar menjadi nama domain yang sepenuhnya memenuhi syarat (FQDN).

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 tempat file konfigurasi openapi.yaml Anda berada.
2. Upload konfigurasi dan buat layanan terkelola:

   gcloud endpoints services deploy openapi.yaml
   

Kemudian, perintah gcloud memanggil Service Management API untuk membuat layanan terkelola dengan nama yang Anda tentukan di kolom host atau servers.url file openapi.yaml. Service Management mengonfigurasi layanan sesuai dengan setelan dalam file openapi.yaml. Saat membuat perubahan pada openapi.yaml, Anda harus men-deploy ulang file untuk memperbarui layanan Endpoints.

Saat membuat dan mengonfigurasi layanan, Pengelolaan Layanan 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, Service Management akan menampilkan pesan dengan ID konfigurasi layanan dan nama layanan, yang mirip dengan berikut ini:

Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]

Dalam contoh sebelumnya, 2017-02-13r0 adalah ID konfigurasi layanan, dan echo-api.endpoints.example-project-12345.cloud.goog adalah layanan Endpoints. 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 dalam 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 Endpoint.

Memeriksa layanan yang diperlukan

Minimal, Endpoints dan ESP memerlukan 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 projectGoogle Cloud yang sudah ada dan layanan ini dinonaktifkan secara eksplisit di project tersebut.

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.

Men-deploy Backend API

Membuat template instance

Buat template yang akan Anda gunakan untuk membuat grup instance VM. Setiap instance yang dibuat dari template akan meluncurkan ESPv2 dan server aplikasi backend.

1. Di konsol Google Cloud , buka halaman Instance templates.

   Buka Instance templates

2. Klik Create instance template.

3. Di bagian Name, masukkan load-balancing-espv2-template.

4. Di bagian Machine configuration, setel Machine type ke e2-micro.

5. Di bagian Boot disk, tetapkan Image ke Container Optimized OS stable version.

6. Di bagian Firewall, pilih Allow HTTP traffic.

7. Klik Management, security, disks, networking, sole tenancy untuk membuka setelan lanjutan.

8. Klik tab Management. Di bagian Automation, masukkan Startup script berikut. Jangan lupa update ENDPOINTS_SERVICE_NAME.

   sudo docker network create --driver bridge esp_net
   sudo docker run \
     --detach \
     --name=echo \
     --net=esp_net \
     gcr.io/google-samples/echo-python:1.0
   sudo docker run \
     --detach \
     --name=esp \
     --publish=80:9000 \
     --net=esp_net \
     gcr.io/endpoints-release/endpoints-runtime:2 \
     --service=ENDPOINTS_SERVICE_NAME \
     --rollout_strategy=managed \
     --listener_port=9000 \
     --healthz=/healthz \
     --backend=echo:8080
   

   Skrip akan mengambil, menginstal, dan meluncurkan server aplikasi echo dan server proxy ESPv2 saat instance dimulai.

9. Klik Buat.

Tunggu hingga template selesai dibuat sebelum melanjutkan.

Membuat grup instance terkelola regional

Untuk menjalankan aplikasi, gunakan template instance untuk membuat grup instance terkelola regional:

1. Di konsol Google Cloud , buka halaman Instance groups.

   Buka Instance groups

2. Klik Create instance group.

3. Di bagian Name, masukkan load-balancing-espv2-group.

4. Di bagian Lokasi, pilih Beberapa zona.

   Tips Pro: Untuk memastikan aplikasi Anda tersedia selama peristiwa ekstrem, seperti pemadaman layanan di zona tertentu, Compute Engine merekomendasikan agar Anda mendistribusikan aplikasi di beberapa zona ini.

5. Di bagian Region, pilih us-central1.

6. Klik menu drop-down Konfigurasi zona untuk menampilkan Zona. Pilih zona berikut:

   • us-central1-b
   • us-central1-c
   • us-central1-f

7. Di bagian Instance template, pilih load-balancing-espv2-template.

8. Di bagian Penskalaan otomatis, pilih Jangan lakukan penskalaan otomatis.

9. Setel Number of instances ke 3.

   Tips Pro: Saat membuat grup instance terkelola regional, Compute Engine merekomendasikan agar Anda menyediakan instance yang cukup sehingga, jika semua instance di satu zona tidak tersedia, instance yang tersisa masih memenuhi jumlah minimum instance yang Anda perlukan. Namun, menyediakan lebih banyak instance dari yang Anda butuhkan dapat menimbulkan biaya tambahan. Untuk mengetahui informasi selengkapnya, lihat Memilih ukuran grup instance untuk memastikan ketersediaan.

10. Di bagian Redistribusi instance, pilih Aktif.

11. Di bagian Autohealing dan Health check, pilih No health check.

12. Klik Buat. Tindakan ini akan mengalihkan Anda kembali ke halaman Grup instance.

    Catatan: Anda mungkin perlu menunggu beberapa menit hingga semua instance dalam grup berjalan dan siap menampilkan aplikasi web.

Membuat load balancer

Bagian ini menjelaskan langkah-langkah yang diperlukan untuk membuat load balancer global yang mengarahkan traffic HTTP ke grup instance Anda.

Load balancer ini menggunakan frontend untuk menerima traffic masuk dan backend untuk mendistribusikan traffic ini ke instance yang berfungsi dengan baik. Karena load balancer terdiri dari beberapa komponen, tugas ini dibagi menjadi beberapa bagian:

• Konfigurasi backend
• Konfigurasi frontend
• Tinjau dan selesaikan

Selesaikan semua langkah untuk membuat load balancer.

1. Di konsol Google Cloud , buka halaman Create a load balancer.

   Buka Create a load balancer

2. Di bagian Application Load Balancer (HTTP/S), klik Start configuration.

3. Di bagian Internet facing or internal only, pilih From Internet to my VMs. Kemudian, klik Continue.

4. Untuk Name load balancer, masukkan espv2-load-balancer.

Konfigurasi backend

1. Di panel kiri halaman Create global external Application Load Balancer, klik Backend configuration.
2. Klik Create or select backend services & backend buckets untuk membuka menu drop-down. Klik Backend services, lalu klik Create a backend service.
3. Di jendela baru, untuk Name aplikasi backend, masukkan espv2-backend.
4. Setel Instance group ke load-balancing-espv2-group.
5. Setel Transfer nomor ke 80. Hal ini memungkinkan traffic HTTP antara load balancer dan grup instance.
6. Di bagian Balancing mode, pilih Utilization.
7. Klik Done untuk membuat backend.

8. Buat health check untuk backend load balancer:

   Tips Pro: Health check digunakan untuk load balancing dan autohealing, tetapi untuk tujuan yang berbeda:

   • Health check untuk load balancing digunakan untuk mendeteksi instance yang tidak responsif dan mengalihkan traffic darinya.
   • Health check untuk autohealing digunakan untuk mendeteksi dan membuat ulang instance yang gagal.

   Gunakan health check terpisah untuk load balancing dan untuk autohealing. Menggunakan health check yang sama untuk layanan ini akan menghapus perbedaan antara instance yang tidak responsif dan instance yang gagal, sehingga menyebabkan latensi dan/atau ketidaktersediaan yang tidak perlu bagi pengguna. Untuk mengetahui informasi selengkapnya, lihat Konsep Health Check.

   1. Di bagian Health check, pilih Create a health check (atau Create another health check) dari menu drop-down. Jendela baru akan terbuka.
   2. Di jendela baru di bagian Name, masukkan espv2-load-balancer-check.
   3. Setel Protocol ke HTTP.
   4. Di bagian Port, masukkan 80.
   5. Untuk tutorial ini, setel Request path ke /healthz, yang merupakan jalur yang disiapkan untuk merespons oleh ESPv2.

   6. Setel Kriteria respons berikut:

      1. Setel Check interval ke 3 detik. Fungsi menentukan jumlah waktu dari awal satu pemeriksaan hingga awal pemeriksaan berikutnya.
      2. Setel Waktu Tunggu ke 3 detik. Fungsi ini menentukan jumlah waktu yang dibutuhkan Google Cloud untuk menunggu respons atas penyelidikan. Nilainya harus kurang dari atau sama dengan interval pemeriksaan.
      3. Setel Batas Responsif ke 2 keberhasilan berturut-turut. Hal ini menentukan jumlah pemeriksaan berurutan yang harus berhasil agar instance dianggap responsif.
      4. Setel Batas Tidak Responsif ke 2kegagalan berturut-turut. Ini menentukan jumlah pemeriksaan berurutan yang harus gagal agar instance dianggap tidak responsif.

      Tips Pro: Untuk mengetahui informasi tentang cara menyaring nilai Periksa interval dan Waktu tunggu untuk aplikasi Anda, lihat Cara kerja health check. Untuk menyempurnakan nilai Batas Responsif dan Batas Tidak Responsif untuk aplikasi Anda sendiri, gunakan kriteria berikut:

      • Jika traffic diarahkan ke instance dengan latensi tinggi meskipun instance yang lebih cepat tersedia, kurangi nilai minimum untuk traffic dengan membuat health check lebih agresif.
      • Jika traffic dialihkan dari instance dengan latensi rendah, tingkatkan nilai minimum untuk traffic dengan membuat health check Anda lebih konservatif.

      Untuk mengetahui informasi selengkapnya tentang cara mengoptimalkan dan mengukur latensi, lihat Mengoptimalkan Latensi Aplikasi dengan Load Balancing

   7. Klik Save and continue untuk membuat health check.

9. Klik Create untuk membuat layanan backend.

Konfigurasi frontend

1. Di panel kiri halaman Create global external Application Load Balancer, klik Frontend configuration.
2. Di halaman Frontend configuration, di bagian Name, masukkan espv2-ipv4-frontend.
3. Setel Protocol ke HTTP.
4. Tetapkan Port ke 80.
5. Klik Done untuk membuat frontend.

Tinjau dan selesaikan

1. Verifikasi setelan load balancing Anda sebelum membuat load balancer:

   1. Di panel kiri halaman Create global external Application Load Balancer, klik Review and finalize.

   2. Di halaman Review and finalize, verifikasi setelan Backend berikut:

      • Layanan backend adalah espv2-backend.
      • Protokol endpoint adalah HTTP.
      • Health check adalah espv2-load-balancer-check.
      • Grup instance adalah load-balancing-espv2-group.

   3. Di halaman yang sama, pastikan Frontend menggunakan alamat IP dengan Protokol HTTP.

2. Di panel kiri halaman Create global external Application Load Balancer, klik Create untuk menyelesaikan pembuatan load balancer.

   Anda mungkin perlu menunggu beberapa menit hingga pembuatan load balancer selesai.

3. Setelah load balancer dibuat, temukan alamat IP dari halaman Load Balancer.

   Buka Load Balancer

Mengirim permintaan menggunakan alamat IP

Setelah API contoh dan ESPv2 berjalan di backend yang di-deploy, Anda dapat mengirim permintaan ke API dari komputer lokal.

Membuat kunci API dan menetapkan variabel lingkungan

Contoh kode 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 Google Cloud project lain, lihat Mengaktifkan API di Google Cloud project Anda.

   Buka halaman Kredensial

2. Klik Create credentials, lalu pilih API key.
3. Salin kunci ke papan klip.
4. Klik Close.
5. Di komputer lokal Anda, 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}"

Pada 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 mengetahui 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 sebenarnya, bukan variabel lingkungan. Contoh:
  http://192.0.2.0:80/echo?key=AIza...

API akan mengembalikan pesan yang Anda kirim, dan merespons dengan 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 Endpoints.

Catatan: Jika Anda ingin memberi tahu kami apa yang Anda sukai tentang tutorial ini, silakan berikan 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 apa yang salah. Grup ini menerima respons dari pengguna Endpoints lainnya dan dari engineer Google, yang memantau grup.

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 melakukan sedikit perubahan konfigurasi dalam file openapi.yaml. Dengan cara ini, Anda dapat mengirim permintaan ke contoh API dengan menggunakan echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog alih-alih alamat IP.

Untuk mengonfigurasi DNS Endpoints:

OpenAPI 2.0

1. Buka file konfigurasi OpenAPI Anda, openapi.yaml, lalu 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 contoh API.
4. Deploy file konfigurasi OpenAPI yang telah diupdate ke Service Management:

   gcloud endpoints services deploy openapi.yaml
   

OpenAPI 3.x

1. Buka file konfigurasi OpenAPI Anda, openapi.yaml, lalu tambahkan properti servers.url di tingkat teratas file (tidak diindentasi atau bertingkat) seperti yang ditunjukkan dalam cuplikan berikut:

   servers:
     - url: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
       x-google-endpoint:
         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 contoh API.
4. Deploy file konfigurasi OpenAPI yang telah diupdate ke Service Management:

   gcloud endpoints services deploy openapi.yaml
   

Misalnya, asumsikan file openapi.yaml telah dikonfigurasi sebagai berikut:

OpenAPI 2.0

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"

OpenAPI 3.x

servers:
  - url: "echo-api.endpoints.example-project-12345.cloud.goog"
    x-google-endpoint:
      target: "192.0.2.1"

Saat Anda men-deploy file openapi.yaml menggunakan perintah gcloud sebelumnya, Service Management 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 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 mengonfigurasi data DNS untuk contoh API, 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

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

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.

1. Pastikan gcloud CLI (gcloud) diizinkan untuk mengakses data dan layanan Anda di Google Cloud:

   gcloud auth login
   

2. Masukkan perintah berikut untuk menampilkan project ID untuk project Google Cloud Anda:

   gcloud projects list
   

3. Dengan menggunakan project ID yang berlaku dari langkah sebelumnya, tetapkan projectGoogle Cloud default ke project tempat aplikasi Anda berada:

   gcloud config set project [YOUR_PROJECT_ID]
   

4. Dapatkan nama semua layanan terkelola di project Google Cloud Anda:

   gcloud endpoints services list
   

5. Hapus layanan dari Pengelolaan Layanan. Ganti SERVICE_NAME dengan nama layanan yang ingin Anda hapus.

   gcloud endpoints services delete SERVICE_NAME
   

   Menjalankan gcloud endpoints services delete tidak akan langsung menghapus layanan terkelola. Pengelolaan Layanan menonaktifkan layanan terkelola selama 30 hari, sehingga Anda memiliki waktu untuk memulihkannya jika perlu. Setelah 30 hari, Service Management akan menghapus layanan terkelola secara permanen.

6. Buka halaman Load Balancer.

   Buka Load Balancer

   Hapus load balancer espv2-load-balancer dengan layanan backend espv2-backend dan health check espv2-load-balancer-check.

7. Buka halaman Instance Groups.

   Buka Instance Groups

   Hapus load-balancing-espv2-group

8. Buka halaman Instance Template.

   Buka Instance Templates

   Hapus load-balancing-espv2-template.

Langkah berikutnya

• Membagikan API Anda kepada developer lain
• Pelajari autentikasi lebih lanjut.
• Pelajari opsi dukungan komunitas