Mulai menggunakan Cloud Endpoints untuk Kubernetes dengan ESPv2

OpenAPI   |  gRPC

Tutorial ini menunjukkan cara mengonfigurasi dan men-deploy API sampel dan Extensible Service Proxy V2 (ESPv2) ke cluster Kubernetes yang tidak ada di Google Cloud. Jika Anda ingin menggunakan Google Kubernetes Engine (GKE), lihat Mulai menggunakan Endpoints di GKE.

Contoh API dijelaskan menggunakan spesifikasi OpenAPI. Tutorial ini juga menunjukkan cara membuat kunci API untuk mengirim permintaan ke API.

Tutorial ini menggunakan image container bawaan dari kode contoh dan ESPv2, yang disimpan di Artifact Registry. Jika Anda belum memahami container, lihat informasi selengkapnya di bagian berikut:

• Men-deploy aplikasi web dalam container.
• Image container Kubernetes.

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 Google Cloud project. Lihat Sebelum memulai.
2. Instal dan konfigurasi software yang digunakan dalam tutorial. Lihat Menginstal dan mengonfigurasi software yang diperlukan.
3. Secara opsional, download kode contoh. Lihat Mendapatkan kode contoh.
4. Download file konfigurasi Kubernetes. Lihat Mendapatkan file konfigurasi Kubernetes.
5. Konfigurasi file openapi.yaml, yang digunakan untuk mengonfigurasi Endpoints. Lihat Mengonfigurasi Endpoint.
6. Deploy konfigurasi Endpoints untuk membuat layanan Cloud Endpoints. Lihat Men-deploy konfigurasi Endpoints.
7. Buat kredensial untuk layanan Endpoints Anda. Lihat Membuat kredensial untuk layanan Anda.
8. Deploy API dan ESPv2 ke cluster. Lihat Men-deploy backend API.
9. Dapatkan alamat IP eksternal layanan. Lihat Mendapatkan alamat IP eksternal.
10. Kirim permintaan ke API menggunakan alamat IP. Lihat Mengirim permintaan menggunakan alamat IP.
11. Lacak aktivitas API. Lihat Melacak aktivitas API.

Bagian 2

1. Konfigurasi data DNS untuk contoh API. Lihat Mengonfigurasi DNS untuk Endpoint.
2. Kirim permintaan ke API menggunakan nama domain. Lihat Mengirim permintaan menggunakan FQDN.

Pembersihan

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

Biaya

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

• 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

Tutorial ini mengasumsikan bahwa Anda telah menyiapkan Minikube atau cluster Kubernetes. Untuk mengetahui informasi selengkapnya, lihat dokumentasi Kubernetes.

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 ID project Google Cloud karena akan diperlukan nanti.

Menginstal dan mengonfigurasi software yang diperlukan

Dalam tutorial ini, Anda menginstal Google Cloud CLI untuk menggunakan gcloud CLI guna mengelola project Anda. Anda menggunakan kubectl, antarmuka command line, untuk menjalankan perintah terhadap cluster Kubernetes. 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 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.
2. Instal dan lakukan inisialisasi gcloud CLI.
3. Update gcloud CLI dan instal komponen Endpoints:

   gcloud components update

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

   gcloud auth login

   Di tab 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 sebagai kredensial default aplikasi. Kredensial pengguna memberikan otorisasi kubectl.

   gcloud auth application-default login

8. Di tab baru yang terbuka, pilih akun.
9. Jalankan perintah berikut untuk memastikan klien Kubernetes Anda dikonfigurasi dengan benar:

   kubectl version

   Anda akan melihat output yang mirip dengan yang berikut:

      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

Secara opsional, download kode contoh. Dalam tutorial ini, Anda akan men-deploy image container yang telah dibuat sebelumnya, sehingga Anda tidak perlu membuat container dari kode contoh. Namun, Anda mungkin ingin mendownload kode contoh, yang disediakan dalam beberapa bahasa untuk membantu Anda memahami cara kerja contoh API.

Untuk mendownload kode contoh:

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

Mendapatkan file konfigurasi Kubernetes

1. Clone repositori GitHub yang berisi file yaml yang digunakan dalam tutorial ini ke komputer lokal Anda:

    git clone https://github.com/googlecloudplatform/endpoints-samples

   Atau, download contoh sebagai file ZIP, lalu ekstrak.

2. Ubah ke direktori yang berisi file konfigurasi:

    cd endpoints-samples/kubernetes

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.

Untuk mengonfigurasi Endpoint:

1. Buat file teks baru bernama openapi.yaml. Untuk memudahkan, halaman ini merujuk ke dokumen OpenAPI dengan nama tersebut, tetapi Anda dapat menamainya dengan nama lain jika mau.
2. Salin konten salah satu file berikut ke dalam file openapi.yaml baru Anda. Anda dapat memilih untuk menggunakan OpenAPI 2.0 atau OpenAPI 3.x.

   OpenAPI 2.0

   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

   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"

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

Membuat kredensial untuk layanan Anda

Untuk menyediakan pengelolaan API Anda, ESP dan ESPv2 memerlukan layanan di Service Infrastructure. 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 metadataGoogle Cloud .

Saat men-deploy ESP atau ESPv2 ke lingkungan non-Google Cloud , seperti desktop lokal, cluster Kubernetes lokal, atau penyedia cloud lain, Anda harus memberikan 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 Google Cloud konsol atau Google Cloud CLI untuk membuat akun layanan dan file kunci pribadi:

Konsol

1. Di konsol Google Cloud , buka halaman Service Accounts .

   Buka halaman Service Accounts

2. Klik Select a project.
3. Pilih project tempat API Anda dibuat, lalu klik Open.
4. Klik + Create Service Account.
5. Di kolom Service account name, masukkan nama akun layanan Anda.
6. Klik Buat.
7. Klik Lanjutkan.
8. Klik Done.
9. Klik alamat email akun layanan yang baru dibuat.
10. Klik Kunci.
11. Klik Tambahkan kunci, lalu klik Buat kunci baru.

12. Klik Buat. 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.

13. Klik Close.

gcloud

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

   gcloud projects list

2. Ganti PROJECT_ID dalam perintah berikut untuk menetapkan project default ke project tempat API Anda berada:

   gcloud config set project PROJECT_ID

   Penting: Anda harus membuat akun layanan di project yang sama dengan API Anda.

3. Pastikan Google Cloud CLI (gcloud) diizinkan 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 tempat API berada. Google Cloud Jika Anda menjalankan gcloud auth list, akun yang Anda pilih akan ditampilkan sebagai akun aktif untuk project tersebut.

4. 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 menetapkan alamat email untuk akun layanan dalam format berikut:

   SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

   Alamat email ini diperlukan dalam perintah berikutnya.

5. 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 agar akun layanan terlampir 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 tracing dan project yang memiliki konfigurasi layanan endpoint adalah sama. Di ESPv2, project pelacakan dapat ditentukan oleh flag --tracing_project_id, dan secara default ditetapkan ke project yang di-deploy.

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?

Lihat gcloud iam service-accounts untuk mengetahui informasi selengkapnya tentang perintah.

Men-deploy backend API

Sejauh ini Anda telah men-deploy dokumen OpenAPI ke Service Management, tetapi Anda belum men-deploy kode yang melayani backend API. Bagian ini akan memandu Anda men-deploy container bawaan untuk contoh API dan ESPv2 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?

Memberikan kredensial layanan ke ESPv2

ESPv2, yang berjalan di dalam container, memerlukan akses ke kredensial yang disimpan secara lokal dalam file service-account-creds.json. Untuk memberikan ESPv2 akses ke kredensial, Anda membuat secret Kubernetes dan memasang secret Kubernetes sebagai volume Kubernetes.

Untuk membuat secret Kubernetes dan memasang volume:

1. Pastikan untuk mengganti nama file JSON menjadi service-account-creds.json dan menyalinnya ke endpoints-samples/kubernetes jika file tersebut didownload ke direktori lain. Dengan begitu, nama cocok dengan opsi yang ditentukan dalam file manifes deployment echo.yaml.
2. Pastikan Anda berada di direktori endpoints-samples/kubernetes.

3. Buat secret Kubernetes dengan kredensial akun layanan menggunakan perintah berikut:

   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 ESPv2 ke Kubernetes sudah berisi volume rahasia, seperti yang ditunjukkan dalam dua bagian file berikut:

volumes:
  - name: service-account-creds
    secret:
      secretName: service-account-creds

volumeMounts:
  - mountPath: /etc/esp/creds
    name: service-account-creds
    readOnly: true

Mengonfigurasi nama layanan dan memulai layanan

ESPv2 perlu mengetahui nama layanan Anda untuk menemukan konfigurasi yang Anda deploy sebelumnya (dengan menggunakan perintah gcloud endpoints services deploy).

Untuk mengonfigurasi nama layanan dan memulai layanan:

1. Buka file manifes deployment, echo.yaml, dan ganti SERVICE_NAME di opsi startup ESPv2 dengan nama layanan Anda. Ini adalah nama yang sama dengan yang Anda konfigurasi di kolom host atau server.url pada dokumen OpenAPI Anda. Contoh:

   "--service=echo-api.endpoints.example-project-12345.cloud.goog"

   containers:
   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:2
     args: [
       "--listener_port=8080",
       "--backend=127.0.0.1:8081",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
       "--non_gcp",
       "--service_account_key=/etc/esp/creds/service-account-creds.json"
     ]
     ports:
       - containerPort: 8080
     volumeMounts:
       - mountPath: /etc/esp/creds
         name: service-account-creds
         readOnly: true
   - name: echo
     image: gcr.io/endpoints-release/echo:latest
     ports:
       - containerPort: 8081
   

   Opsi "--rollout_strategy=managed" mengonfigurasi ESPv2 untuk menggunakan konfigurasi layanan yang di-deploy terbaru. Saat Anda menentukan opsi ini, dalam waktu satu menit setelah Anda men-deploy konfigurasi layanan baru, ESPv2 akan mendeteksi perubahan dan otomatis mulai menggunakannya. Sebaiknya tentukan opsi ini, bukan memberikan ID konfigurasi tertentu untuk digunakan ESPv2. Untuk mengetahui informasi tentang opsi ESPv2 lainnya yang digunakan, lihat Opsi startup ESPv2.

   Catatan: Jika Anda menggunakan MiniKube, Anda perlu mengubah kolom type layanan dari LoadBalancer menjadi NodePort dalam file konfigurasi.
   Catatan: Sebaiknya Anda menyetel imagePullPolicy dalam spesifikasi penampung ke Always. Hal ini akan memungkinkan pod yang baru dibuat selalu menarik ESPv2 versi terbaru. Baca praktik terbaik konfigurasi untuk mengetahui detail selengkapnya. Saat versi baru ESPv2 dirilis, Anda dapat melakukan mulai ulang bertahap semua pod untuk memastikan versi terbaru digunakan.

2. Mulai layanan untuk men-deploy layanan Endpoints di Kubernetes dengan perintah berikut:

   kubectl create -f echo.yaml

   Jika Anda melihat pesan error yang mirip dengan 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 bagian Mengirim permintaan menggunakan alamat IP. Mungkin perlu waktu beberapa menit setelah Anda memulai layanan di penampung sebelum alamat IP eksternal siap.

Untuk melihat alamat IP eksternal layanan:

1. Jalankan perintah berikut:

   kubectl get service

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

Mengirim permintaan menggunakan alamat IP

Setelah API contoh berjalan di cluster container, Anda dapat mengirim permintaan ke API.

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 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 lain

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.

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 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 ke 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

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.

Pembersihan

• Hapus layanan dan deployment Kubernetes:

  kubectl delete -f echo.yaml

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

Langkah berikutnya

• Pelajari cara men-deploy Endpoints Google Kubernetes Engine.
• Pelajari cara membangun image Docker.
• Bagikan API Anda dengan developer lain.
• Pelajari autentikasi lebih lanjut.
• Pelajari opsi dukungan komunitas.
• Memecahkan masalah deployment GKE.