Halaman ini diterjemahkan oleh Cloud Translation API.

Memulai Endpoints for Kubernetes dengan ESP

OpenAPI | gRPC

Tutorial ini menunjukkan cara men-deploy contoh layanan gRPC sederhana dengan Extensible Service Proxy (ESP) ke cluster Kubernetes yang tidak berjalan diGoogle Cloud. Tutorial ini menggunakan contoh bookstore-grpc versi Python. Lihat bagian Langkah berikutnya untuk contoh gRPC dalam bahasa lain.

Tutorial ini menggunakan image container bawaan dari kode contoh dan ESP, yang disimpan di Artifact Registry. Jika Anda belum terbiasa dengan container, lihat informasi selengkapnya di bawah:

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

Mengonfigurasi Endpoint

Contoh bookstore-grpc berisi file yang perlu Anda salin secara lokal dan dikonfigurasi.

Buat file deskripsi protobuf mandiri dari file .proto layanan Anda:
1. Simpan salinan bookstore.proto dari repositori contoh. File ini menentukan API layanan Toko Buku.
2. Buat direktori berikut: mkdir generated_pb2
3. Buat file deskripsi, api_descriptor.pb, menggunakan compiler buffering protokol protoc. Jalankan perintah berikut di direktori tempat Anda menyimpan bookstore.proto:
```
python -m grpc_tools.protoc \
    --include_imports \
    --include_source_info \
    --proto_path=. \
    --descriptor_set_out=api_descriptor.pb \
    --python_out=generated_pb2 \
    --grpc_python_out=generated_pb2 \
    bookstore.proto
```
  Dalam perintah sebelumnya, --proto_path ditetapkan ke direktori kerja saat ini. Di lingkungan build gRPC, jika Anda menggunakan direktori yang berbeda untuk file input .proto, ubah --proto_path sehingga compiler menelusuri direktori tempat Anda menyimpan bookstore.proto.
Buat file YAML konfigurasi gRPC API:
1. Simpan salinan file api_config.yaml. File ini menentukan konfigurasi gRPC API untuk layanan Toko Buku.
2. Ganti MY_PROJECT_ID dalam file api_config.yaml dengan project ID Google Cloud Anda. Contoh:
```
#
# Name of the service configuration.
#
name: bookstore.endpoints.example-project-12345.cloud.goog
```
  Perhatikan bahwa nilai kolom apis.name dalam file ini sama persis dengan nama API yang sepenuhnya memenuhi syarat dari file .proto; jika tidak, deployment tidak akan berfungsi. Layanan Toko Buku ditentukan dalam bookstore.proto di dalam paket endpoints.examples.bookstore. Nama API-nya yang sepenuhnya memenuhi syarat adalah endpoints.examples.bookstore.Bookstore, seperti yang muncul dalam file api_config.yaml.
```
apis:
  - name: endpoints.examples.bookstore.Bookstore
```

Lihat Mengonfigurasi Endpoint untuk mengetahui informasi selengkapnya.

Men-deploy konfigurasi Endpoint

Untuk men-deploy konfigurasi Endpoints, Anda menggunakan perintah gcloud endpoints services deploy. Perintah ini menggunakan Service Infrastructure, platform layanan dasar Google, yang digunakan oleh Endpoints dan layanan lain untuk membuat dan mengelola API serta layanan.

Pastikan Anda berada di direktori tempat file api_descriptor.pb dan api_config.yaml berada.
Pastikan project default yang saat ini digunakan alat command line gcloud adalah project Google Cloud yang menjadi tujuan deployment konfigurasi Endpoints. Validasi project ID yang ditampilkan dari perintah berikut untuk memastikan layanan tidak dibuat di project yang salah.
```
gcloud config list project
```
Jika Anda perlu mengubah project default, jalankan perintah berikut:
```
gcloud config set project YOUR_PROJECT_ID
```
Deploy file proto descriptor dan file konfigurasi menggunakan Google Cloud CLI:
```
gcloud endpoints services deploy api_descriptor.pb api_config.yaml
```
Saat membuat dan mengonfigurasi layanan, Manajemen Layanan akan menampilkan informasi ke terminal. Setelah deployment selesai, pesan yang mirip dengan berikut akan ditampilkan:
```
Service Configuration [CONFIG_ID] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
```
CONFIG_ID adalah ID konfigurasi layanan Endpoints unik yang dibuat oleh deployment. Contoh:
```
Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
```
Pada contoh sebelumnya, 2017-02-13r0 adalah ID konfigurasi layanan dan bookstore.endpoints.example-project.cloud.goog adalah nama layanan. ID konfigurasi layanan terdiri dari stempel tanggal yang diikuti dengan nomor revisi. Jika Anda men-deploy konfigurasi Endpoint lagi pada hari yang sama, nomor revisi akan bertambah di ID konfigurasi layanan.

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 akan mengaktifkan layanan yang diperlukan ini. Namun, perintah gcloud berhasil diselesaikan, tetapi tidak mengaktifkan layanan yang diperlukan dalam keadaan berikut:

Jika Anda menggunakan aplikasi pihak ketiga seperti Terraform, dan Anda tidak menyertakan layanan ini.
Anda men-deploy konfigurasi Endpoints ke projectGoogle Cloud yang sudah ada tempat layanan ini dinonaktifkan secara eksplisit.

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.

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

Lihat Men-deploy konfigurasi Endpoints untuk mengetahui informasi tambahan.

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 atau Compute Engine, ESP dan ESPv2 akan mendapatkan token akses untuk Anda melalui layanan metadata Google 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

Di konsol Google Cloud , buka halaman Service Accounts .
Buka halaman Service Accounts
Klik Select a project.
Pilih project tempat API Anda dibuat, lalu klik Open.
Klik + Create Service Account.
Di kolom Service account name, masukkan nama untuk akun layanan Anda.
Klik Buat.
Klik Lanjutkan.
Klik Selesai.
Klik alamat email akun layanan yang baru dibuat.
Klik Kunci.
Klik Tambahkan kunci, lalu klik Buat kunci baru.
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.
Klik Close.

`gcloud`

Masukkan perintah berikut untuk menampilkan project ID untuk project Google Cloud Anda:
```
gcloud projects list
```
Ganti PROJECT_ID dalam perintah berikut untuk menetapkan project default ke project tempat API Anda berada:
```
gcloud config set project PROJECT_ID
```
Penting: Anda harus membuat akun layanan di project yang sama dengan API Anda.
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.
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.

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 Service Control yang menggunakan konfigurasi layanan endpoint. Konfigurasi layanan endpoint adalah resource IAM dan ESP serta ESPv2 memerlukan peran Service Controller untuk mengaksesnya.

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

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

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 konfigurasi layanan ke Service Management, tetapi Anda belum men-deploy kode yang melayani backend API. Bagian ini memandu Anda men-deploy container bawaan untuk contoh API dan ESP ke Kubernetes.

Memberikan kredensial layanan ke ESP

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

Untuk membuat secret Kubernetes dan memasang volume:

Jika Anda menggunakan konsol Google Cloud untuk membuat akun layanan, ganti nama file JSON menjadi service-account-creds.json. Pindahkan ke direktori yang sama tempat file api_descriptor.pb dan api_config.yaml berada.
Buat secret Kubernetes dengan kredensial akun layanan:
```
 kubectl create secret generic service-account-creds
      --from-file=service-account-creds.json
```
Jika berhasil, Anda akan melihat pesan secret "service-account-creds" created.

File manifes deployment yang Anda gunakan untuk men-deploy API dan ESP ke Kubernetes sudah berisi volume rahasia, seperti yang ditunjukkan dalam dua bagian file berikut:

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

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

Mengonfigurasi nama layanan dan memulai layanan

ESP perlu mengetahui nama layanan Anda untuk menemukan konfigurasi yang Anda deploy sebelumnya menggunakan perintah gcloud endpoints services deploy.

Untuk mengonfigurasi nama layanan dan memulai layanan:

Simpan salinan file manifes deployment, k8s-grpc-bookstore.yaml, ke direktori yang sama dengan service-account-creds.json.
Buka k8s-grpc-bookstore.yaml dan ganti SERVICE_NAME dengan nama layanan Endpoints Anda. Ini adalah nama yang sama dengan yang Anda konfigurasi di kolom name pada file api_config.yaml.
```
containers:
  - name: esp
    image: gcr.io/endpoints-release/endpoints-runtime:1
    args: [
      "--http2_port=9000",
      "--service=SERVICE_NAME",
      "--rollout_strategy=managed",
      "--backend=grpc://127.0.0.1:8000",
      "--service_account_key=/etc/nginx/creds/service-account-creds.json"
    ]
```
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 mengetahui detail selengkapnya tentang argumen ESP, lihat Opsi startup ESP.

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 di atas ke Always. Hal ini akan memungkinkan pod yang baru dibuat selalu menarik ESP versi terbaru. Baca praktik terbaik konfigurasi untuk mengetahui detail selengkapnya. Saat versi ESP baru dirilis, Anda dapat melakukan mulai ulang bertahap semua pod untuk memastikan versi terbaru digunakan.
Mulai layanan untuk men-deploy layanan di Kubernetes:
```
kubectl create -f k8s-grpc-bookstore.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.

Mendapatkan alamat IP eksternal layanan

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

Lihat alamat IP eksternal:
```
kubectl get service
```
Catat nilai untuk EXTERNAL-IP dan simpan dalam variabel lingkungan SERVER_IP karena digunakan saat mengirim permintaan ke contoh API.
```
export SERVER_IP=YOUR_EXTERNAL_IP
```

Mengirim permintaan ke API

Untuk mengirim permintaan ke API contoh, Anda dapat menggunakan contoh klien gRPC yang ditulis dalam Python.

Clone repositori git tempat kode klien gRPC dihosting:

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

Ubah direktori kerja Anda:

cd python-docs-samples/endpoints/bookstore-grpc/

Instal dependensi:

pip install virtualenv
virtualenv env
source env/bin/activate
python -m pip install -r requirements.txt

Kirim permintaan ke API contoh:
```
python bookstore_client.py --host SERVER_IP --port 80
```
- Lihat grafik aktivitas untuk API Anda di halaman Endpoints > Services.
  
  Buka halaman Endpoints Services
  
  Mungkin perlu waktu beberapa saat agar permintaan ditampilkan dalam grafik.
- Lihat log permintaan untuk API Anda di halaman Logs Explorer.
  
  Buka halaman Logs Explorer

Jika Anda tidak mendapatkan respons yang berhasil, lihat Memecahkan masalah error respons.

Anda baru saja men-deploy dan menguji API di Endpoints.