Men-deploy proxy API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Catatan: Untuk men-deploy proxy API di lingkungan yang diaktifkan untuk deployment arsip, lihat Men-deploy dan mengelola arsip di lingkungan Apigee.

Anda tidak dapat memanggil proxy API sebelum proxy tersebut di-deploy. Setelah membuat proxy API baru atau mengubah proxy yang sudah ada, Anda dapat men-deploy-nya ke cluster.

Jika Anda membuat revisi baru proxy API tanpa mengubah jalur dasarnya, lalu men-deploy-nya ke lingkungan tempat proxy API sudah di-deploy, revisi sebelumnya akan dibatalkan deployment-nya, dan revisi baru akan di-deploy sebagai penggantinya.

Catatan: Anda tidak dapat membuat perubahan inkremental pada revisi proxy API dan men-deploy ulang revisi yang sama tersebut ke Apigee. Untuk men-deploy perubahan pada proxy API, Anda harus menyimpannya sebagai revisi baru dan men-deploy-nya.

Men-deploy proxy API

Deploy revisi proxy API seperti yang dijelaskan di bagian berikut.

Catatan: Apigee memperkenalkan versi baru Editor Proxy, yang akan mempermudah pengelolaan proxy.

Petunjuk pada dua tab pertama di bawah menjelaskan cara menggunakan Proxy Editor baru atau Proxy Editor klasik.

Editor Proxy Baru

Untuk men-deploy proxy API di UI Apigee:

1. Jika Anda menggunakan APIgee UI in Cloud Console: Pilih Pengembangan proxy > Proxy API.

   Jika Anda menggunakan Apigee UI klasik: Pilih Develop > API Proxies dan di panel Proxies, pilih lingkungan untuk proxy.

2. Klik proxy API yang ingin Anda deploy. UI akan menampilkan halaman Overview:

   

3. Untuk men-deploy perubahan, pertama-tama klik Deploy untuk menampilkan dialog Deploy:

   

4. Masukkan info berikut:
   • Revisi: Nomor revisi proxy yang ingin Anda deploy.
   • Environment: Lingkungan tempat Anda ingin men-deploy proxy.
   • Akun layanan (opsional): Akun layanan untuk proxy.
5. Klik Deploy.

UI akan memulai proses deployment revisi yang dipilih.

Catatan: Mungkin perlu waktu beberapa menit bagi Apigee untuk men-deploy proxy baru.

Saat proxy di-deploy, kolom Status di bagian Deployment menampilkan ikon hijau untuk menunjukkan bahwa revisi 1 proxy telah di-deploy.

Editor Proxy Klasik

Untuk men-deploy proxy API di UI Apigee:

1. Login ke UI Apigee.
2. Pilih Develop > API Proxies.

   UI menampilkan daftar proxy API dan status deployment-nya:

   

3. Dari menu drop-down Environment, pilih lingkungan tempat Anda ingin men-deploy proxy API.

4. Klik proxy API yang ingin Anda deploy.

   UI menampilkan tab API Proxies Overview. Tampilan ini mencakup bagian Deployment, Endpoint Proxy, dan Endpoint Target:

   

   Jika ini adalah proxy API baru yang belum di-deploy sebelumnya (atau proxy API yang belum di-deploy), kolom Revisi akan menampilkan Belum di-deploy.

5. Di kolom Revisi, luaskan pemilih drop-down.

   Jika ini adalah proxy API baru yang belum pernah di-deploy sebelumnya, menu drop-down hanya akan menampilkan 1 dan Undeploy:

   

   Untuk proxy API dengan beberapa revisi, menu drop-down akan menampilkan semua revisi yang dapat Anda pilih, serta menampilkan Batalkan deployment.

   

6. Pilih revisi yang ingin di-deploy dari menu drop-down.

   UI akan meminta Anda untuk mengonfirmasi deployment:

   

7. Klik Deploy.

   UI akan memulai proses deployment revisi yang dipilih.

   Catatan: Mungkin perlu waktu beberapa menit bagi Apigee untuk men-deploy proxy baru.

   Arahkan kursor ke link Details di kolom Status untuk melihat status deployment. Jika ada satu atau beberapa revisi yang sudah di-deploy, Anda dapat memantau status pembatalan deployment-nya, seperti yang ditunjukkan pada gambar berikut. Untuk mengetahui informasi selengkapnya, lihat Deployment tanpa periode nonaktif.

   

   Setelah deployment selesai, detail Status menunjukkan bahwa revisi telah di-deploy sepenuhnya:

   

   Perhatikan bahwa deployment bukanlah proses yang instan. Model deployment Apigee yang konsisten pada akhirnya berarti bahwa deployment baru akan diluncurkan ke cluster dalam jangka waktu singkat dan tidak segera. Untuk informasi selengkapnya, lihat Tentang deployment.

   Untuk mengetahui informasi tentang arti indikator status dan cara memeriksa statusnya, lihat Melihat status deployment.

   

Atau, Anda dapat men-deploy revisi saat ini yang sedang diedit di tab Develop. Jika Anda melakukannya, Apigee akan membuat revisi baru untuk Anda.

1. Klik menu drop-down Deploy to: env_name

   

   UI menampilkan daftar lingkungan. Di kolom Revisi, UI mencantumkan revisi yang saat ini di-deploy (atau "‐‐" jika tidak ada).

2. Klik Deploy revision untuk men-deploy revisi yang terakhir Anda edit.

   UI akan meminta Anda untuk mengonfirmasi deployment.

3. Klik Deploy.

   UI akan memulai proses deployment revisi yang dipilih.

API Apigee

Bagian berikut memberikan contoh penggunaan Apigee API untuk men-deploy revisi proxy API dan mencantumkan deployment untuk organisasi Anda.

• Membuat laporan perubahan deployment sebelum men-deploy
• Men-deploy revisi proxy API menggunakan API
• Mencantumkan deployment proxy API menggunakan API

Lihat juga Melihat status deployment.

Membuat laporan perubahan deployment sebelum men-deploy

Men-deploy proxy di lebih dari satu lingkungan dalam grup lingkungan yang sama dapat menyebabkan perilaku yang tidak ditentukan. Untuk menentukan apakah hal ini akan terjadi, Anda dapat membuat laporan menggunakan metode generateDeployChangeReport sebagai berikut:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/deployments:generateDeployChangeReport" \
-X POST \
-H "Authorization: Bearer $TOKEN"

Tindakan ini akan menampilkan laporan perubahan deployment yang memperingatkan Anda jika jalur dasar di proxy yang ingin di-deploy tidak akan menerima traffic karena deployment yang ada sudah menggunakan jalur dasar tersebut.

Men-deploy revisi proxy API menggunakan API

Untuk men-deploy revisi proxy API, gunakan panggilan API berikut:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi tentang variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Poin Penting: Jika revisi proxy API yang ada di-deploy, tetapkan parameter kueri override ke true. Dalam hal ini, Apigee men-deploy revisi baru sepenuhnya sebelum membatalkan deployment revisi yang ada, seperti yang dijelaskan dalam Deployment zero-time.

Berikut ini contoh output respons. Dalam contoh ini, revisi 1 dari proxy API helloworld berhasil di-deploy ke lingkungan test:

{
  "environment": "test",
  "apiProxy": "helloworld",
  "revision": "1",
  "deployStartTime": "1559149080457"
}

Untuk informasi selengkapnya, lihat Men-deploy API revisi proxy API.

Mencantumkan deployment menggunakan API

Untuk menampilkan daftar semua deployment proxy API dan alur bersama untuk organisasi Anda, masukkan panggilan API berikut:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/deployments" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi tentang variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Poin Penting: Saat melihat daftar deployment, status deployment tidak akan ditampilkan. Untuk melihat status deployment revisi proxy API individual, lihat Melihat status deployment.

Berikut ini contoh respons. Dalam contoh ini, ada tiga proxy API yang di-deploy, termasuk helloworld yang di-deploy di bagian sebelumnya.

{
  "deployments": [
    {
      "environment": "test",
      "apiProxy": "helloworld",
      "revision": "1",
      "deployStartTime": "1559149080457"
    },
    {
      "environment": "test",
      "apiProxy": "weather",
      "revision": "1",
      "deployStartTime": "1558620435217"
    },
    {
      "environment": "test",
      "apiProxy": "testproxy",
      "revision": "2",
      "deployStartTime": "1558635113086"
    }
  ]
}

gcloud

Bagian berikut memberikan contoh penggunaan perintah CLI gcloud apigee untuk men-deploy revisi proxy API dan mencantumkan deployment untuk organisasi Anda.

• Men-deploy revisi proxy API menggunakan gcloud CLI
• Mencantumkan deployment proxy API menggunakan gcloud CLI

Lihat juga Melihat status deployment.

Untuk mengetahui informasi selengkapnya dan deskripsi variabel lingkungan yang digunakan dalam contoh, lihat Mulai menggunakan gcloud dengan Apigee.

Men-deploy revisi proxy API menggunakan gcloud CLI

Untuk men-deploy revisi proxy API, gunakan perintah gcloud berikut:

gcloud apigee apis deploy $REV --api=$API --environment=$ENV

Poin Penting: Jika revisi proxy API yang ada di-deploy, tetapkan flag override ke true. Dalam hal ini, Apigee men-deploy revisi baru sepenuhnya sebelum membatalkan deployment revisi yang ada, seperti yang dijelaskan dalam Deployment zero-time.

Berikut ini contoh output respons. Dalam contoh ini, revisi 1 dari proxy API helloworld berhasil di-deploy ke lingkungan test:

Using Apigee organization 'my-org'
apiProxy: helloworld
deployStartTime: '1598032332802'
environment: test
revision: '1'

Untuk informasi selengkapnya, lihat Men-deploy CLI revisi proxy API.

Mencantumkan deployment menggunakan gcloud CLI

Untuk menampilkan daftar semua deployment proxy API dan alur bersama untuk organisasi Anda, gunakan perintah gcloud berikut:

gcloud apigee deployments list

Poin Penting: Saat melihat daftar deployment, status deployment tidak akan ditampilkan. Untuk melihat status deployment proxy API individual, lihat Melihat status deployment.

Berikut ini contoh respons. Dalam contoh ini, ada tiga proxy API yang di-deploy, termasuk helloworld yang di-deploy di bagian sebelumnya.

Using Apigee organization `my-org`
 - apiProxy: helloworld
   deployStartTime: 1598032332802
   environment: test
   revision: 1
 - apiProxy: weather
   deployStartTime: 1558620435217
   environment: test
   revision: 1
 - apiProxy: testproxy
   deployStartTime: 1558635113086
   environment: test
   revision: 2

Untuk mengetahui informasi selengkapnya, lihat Daftar deployment CLI.

Pemecahan masalah

Jika Anda tidak dapat men-deploy proxy API, periksa apakah salah satu skenario umum berikut mungkin terjadi.

Penamaan batasan untuk grup lingkungan

Jika nama grup lingkungan Anda tidak mematuhi batasan penamaan yang tidak akan di-deploy oleh proxy Anda. Dalam beberapa kasus, Anda dapat membuat grup lingkungan dan menambahkan lingkungan ke dalamnya tanpa harus memenuhi batasan ini. Namun, hal ini akan mencegah deployment proxy.

Lihat Membuat grup lingkungan untuk mengetahui deskripsi pedoman dan batasan penamaan.

Lingkungan yang dibuat dengan nama lingkungan yang digunakan sebelumnya

Jika Anda membuat lingkungan dengan nama yang sama dengan lingkungan yang sebelumnya dihapus, proxy Anda tidak akan di-deploy. Misalnya, jika Anda membuat lingkungan bernama prod-1 setelah sebelumnya membuat dan menghapus lingkungan prod-1, Anda harus menghapusnya. Anda dapat menggunakan langkah-langkah berikut untuk menyelesaikan masalah ini:

1. Lepaskan lingkungan prod-1 dari grup lingkungan Anda menggunakan API.
2. Hapus lingkungan prod-1 menggunakan API.
3. Buat lingkungan baru. Misalnya, prod-2.
4. Lampirkan lingkungan prod-2 baru ke grup lingkungan Anda menggunakan API.