Mengintegrasikan dengan Deployment Manager

Deployment Manager menawarkan kemampuan untuk mendaftarkan API pihak ketiga dengan layanan Deployment Manager. Setelah mendaftarkan API sebagai penyedia jenis ke Deployment Manager, Anda dapat menggunakan Deployment Manager untuk men-deploy resource dari API sebagai jenis dalam konfigurasi.

Dokumen ini adalah panduan satu halaman yang menjelaskan proses mengintegrasikan API pihak ketiga dengan Deployment Manager. Halaman ini tidak berisi petunjuk lengkap untuk setiap langkah proses, tetapi menyediakan ringkasan dan link tambahan untuk informasi selengkapnya. Gunakan halaman ini untuk mendapatkan gambaran tingkat tinggi tentang proses penambahan API, tetapi lihat dokumentasi mendetail untuk mendapatkan petunjuk langkah demi langkah.

Menentukan apakah API memenuhi syarat untuk berintegrasi dengan Deployment Manager

Deployment Manager memiliki ekspektasi tertentu dari setiap API yang mencoba berintegrasi dengannya. Secara khusus:

  • Deployment Manager mengharapkan API RESTful. Artinya, API mengekspos antarmuka seperti REST dengan metode Create, Read, Update, dan Delete (CRUD).
  • Semua parameter jalur dan kueri berhasil di-resolve. Semua parameter jalur dan kueri API harus ada sebagai bagian dari isi resource atau ada di semua metode API, sehingga Deployment Manager dapat mencocokkan parameter tersebut saat pengguna menyediakannya.
  • Endpoint dokumen deskriptor API harus dapat diakses. Deployment Manager membuat permintaan HTTP untuk mendapatkan dokumen deskripsi API sehingga dokumen tersebut harus dihosting di tempat yang dapat diakses oleh Deployment Manager. Dokumen harus tersedia untuk publik atau dilindungi oleh autentikasi dasar.
  • Terkait dengan poin sebelumnya, API memiliki autentikasi dasar, atau, jika API berjalan di Google Kubernetes Engine atau Google Cloud Endpoints, API mendukung autentikasi OAuth 2.0 menggunakan token akses dari akun layanan project. Baca selengkapnya tentang autentikasi.
  • Jika API Anda kompleks, Anda mungkin perlu mengonfigurasi opsi tambahan untuk menjelaskan kepada Deployment Manager cara menangani perilaku API yang kurang jelas.

Untuk informasi selengkapnya, baca dokumentasi Persyaratan API.

Menambahkan API ke Deployment Manager

Setelah menentukan bahwa API Anda cocok dengan persyaratan di atas, tambahkan API sebagai resource Penyedia Jenis. Anda harus menyediakan dokumen deskripsi API dan secara opsional, opsi API tambahan apa pun menggunakan opsi lanjutan. Menambahkan API sebagai penyedia jenis akan mengekspos semua resource API tersebut ke Deployment Manager dan memungkinkan pengguna membuat, mengupdate, atau menghapus resource tersebut dengan Deployment Manager.

Jika API Anda memiliki pola API halus yang mungkin tidak mudah dikenali, Anda juga harus memberikan pemetaan input ke Deployment Manager agar dapat menangani permintaan API dengan benar. Untuk mengetahui informasinya, baca Opsi API Lanjutan.

Memanggil penyedia jenis di file konfigurasi

Setelah API didaftarkan ke Deployment Manager, Anda dapat membuat resource API dengan memanggil resource API tersebut sebagai jenis dalam konfigurasi Anda.

Misalnya, jika memberi nama penyedia jenis Anda example-directory-api dan ingin membuat resource API yang dikenal sebagai person, Anda dapat menetapkan jenis tersebut dalam konfigurasi Anda seperti berikut:

resources:
- name: Jane
  type: my-project/example-directory-api:person
  properties:
  - name: Jane
    website: www.example.com
    ...

Sebagai perbandingan, ini adalah proses yang sama dengan memanggil Google API dan membuat resource API:

resource:
- name: example-instance
  type: compute.v1.instance
  properties:
  - machineType: n1-standard-1
    ...

Langkah selanjutnya