Tentang lingkungan dan grup lingkungan

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Bagian ini menjelaskan lingkungan dan grup lingkungan.

Ringkasan

Lingkungan Apigee adalah perangkat lunak , dalam suatu organisasi, untuk membuat dan men-deploy proxy API. Anda harus men-deploy proxy API ke lingkungan sebelum dapat diakses. Anda dapat men-deploy API proxy ke satu lingkungan atau ke beberapa lingkungan.

Setiap lingkungan memiliki batas jumlah proxy API, alur bersama, dan resource lain yang dapat di-deploy ke lingkungan tersebut. Batasan ini bervariasi berdasarkan jenis organisasi Apigee (Langganan, Bayar sesuai penggunaan, atau hybrid) yang menggunakan lingkungan fleksibel App Engine. Untuk informasi selengkapnya, lihat dokumentasi Batas.

Grup lingkungan (terkadang disebut envgroup di Apigee API) adalah mekanisme dasar untuk menentukan cara permintaan dirutekan ke lingkungan individual. Anda menentukan nama host di grup lingkungan Anda (bukan di lingkungan individual), dan Apigee merutekan permintaan ke lingkungan dalam grup menggunakan definisi nama host tersebut.

Lingkungan harus menjadi anggota setidaknya satu grup lingkungan sebelum Anda dapat {i>access proxy <i}yang di deploy di dalamnya. Dengan kata lain, Anda harus menetapkan lingkungan ke grup sebelum Anda dapat menggunakannya.

Pengelompokan lingkungan yang logis berdasarkan grup lingkungan memberikan manfaat berikut:

• Pengelolaan nama host terpusat: Grup lingkungan memberikan server nama host terpusat tempat untuk mengelola nama {i>host<i}.
• Insight gabungan: Dengan grup, Anda dapat menganalisis error dengan melihat laporan untuk seluruh grup lingkungan sekaligus, bukan lingkungan individual.
• Penghindaran konflik: Dengan mengelompokkan lingkungan, Anda dapat memastikan bahwa jalur dasar untuk proxy yang di-deploy berada di nama host yang sama.

Jenis deployment yang didukung

Apigee mendukung jenis deployment berikut di lingkungan:

Jenis	Deskripsi
Proxy	Kembangkan dan uji proxy API Anda di lingkungan pengembangan Apigee, lalu deploy proxy ke pengujian integrasi dan lingkungan produksi Apigee. Lihat Men-deploy proxy API.
Arsipkan	Kembangkan dan uji proxy API yang dapat diprogram menggunakan Apigee di VS Code.

Ringkasan tindakan yang dicegah dengan deployment arsip

Saat mengaktifkan deployment arsip di lingkungan Apigee, Anda tidak akan dapat melakukan tindakan tindakan berikut di dalam lingkungan untuk mencegah konflik:

• Di UI Apigee, Anda tidak dapat melihat, mengonfirmasi status deployment, atau mengelola deployment arsip, seperti yang dijelaskan Men-deploy proxy API, atau menggunakan UI Debug seperti yang dijelaskan dalam Menggunakan Debug. Sebagai solusinya, Anda dapat menggunakan gcloud atau API untuk Mencantumkan semua deployment arsip dalam suatu lingkungan dan gunakan Debug API.
• Anda tidak dapat membuat, mengupdate, atau menghapus file resource atau server target menggunakan UI Apigee, API, atau gcloud.
• Untuk saat ini, Autentikasi Google menggunakan Akun Layanan tidak didukung.

Catatan: Anda dapat mengelola peta nilai kunci (KVM), dan keystore TLS di lingkungan Apigee yang diaktifkan untuk deployment arsip.

Jika Anda mencoba melakukan tindakan yang dicegah yang tercantum di atas, tindakan tersebut akan gagal dengan pesan error berikut:

FAILED_PRECONDITION

Unit deployment proxy

Unit deployment proxy menghitung proxy dan alur bersama yang di-deploy ke lingkungan per region.

Berikut adalah jenis unit deployment:

• Unit deployment proxy standar menghitung jumlah proxy yang saat ini di-deploy yang memenuhi syarat sebagai Proxy standar.
• Unit deployment proxy yang dapat diperluas menghitung jumlah proxy yang saat ini di-deploy yang memenuhi syarat sebagai Proxy yang dapat diperluas.
• Unit deployment alur bersama menghitung jumlah deployment alur bersama.

Penggunaan Anda mungkin tunduk kepada kuota deployment, yang merupakan batas jumlah yang dapat Anda gunakan sekaligus. Melihat hak Anda (Pay-as-you-go atau Langganan 2024) untuk mengetahui detailnya.

Untuk informasi selengkapnya tentang cara melihat penggunaan unit deployment proxy dan detail kuota deployment untuk organisasi Anda, lihat Melihat penggunaan deployment proxy.

Jenis lingkungan

Untuk pengguna Bayar sesuai penggunaan, saat membuat lingkungan, Anda harus memilih jenis lingkungan: Basis, Menengah, atau Komprehensif. Fitur, fungsi, dan biaya yang terkait dengan lingkungan bergantung pada jenis lingkungan. Lihat Jenis lingkungan bayar sesuai penggunaan dan Hak bayar sesuai penggunaan untuk informasi selengkapnya.

Untuk paket Langganan, jenis lingkungan Anda selalu Komprehensif dan Anda tidak perlu ketahui tentang jenis-jenis lingkungan.

Teruskan proxy

Apigee mendukung penerusan traffic ke URI tertentu. Fitur ini berlaku di tingkat lingkungan dan dapat digunakan untuk mengarahkan lalu lintas ke internet setelah dalam proses awal di proxy.

Permintaan masuk untuk proxy dalam proses lingkungan yang dikonfigurasi untuk semua kebijakan yang disertakan (lihat Teruskan dukungan fitur proxy) lalu teruskan menggunakan HTTP ke URI baru.

Perubahan yang dibuat pada setelan maju proxy lingkungan akan segera berlaku untuk hanya permintaan. Permintaan yang sudah diproses selesai dengan setelan yang ada di ketika permintaan diterima.

Untuk petunjuk tentang konfigurasi forward proxy, lihat Mengonfigurasi maju proxy dalam lingkungan.

Dukungan fitur penerusan proxy

Tidak semua fitur proxy yang tersedia secara umum memiliki ketersediaan yang sama atau keberlakuan dengan forward proxying.

Apigee saat ini tidak mendukung Autentikasi Dasar dengan proxy maju, kecuali di Apigee Hybrid.

Tabel ini menunjukkan dukungan untuk fungsi tambahan:

Fitur atau kebijakan	Didukung/berlaku untuk forward proxy?
Endpoint Target	Ya
Health Check HTTP	Ya
Pemanggilan Layanan	Ya
Panggilan HTTP melalui JavaScript	Ya
Target integrasi	Ya
Perantaian proxy, melalui loopback lokal	Tidak
Memublikasikan pesan	Tidak
Cloud Logging	Tidak
Komunikasi dengan Sinkronisasi	Tidak
Logging pesan melalui Syslog	Tidak

Batasan penerusan proxy

GoogleToken melalui audiens eksternal saat ini tidak didukung dengan forward proxy.

Poin utama

Tabel berikut mencantumkan hal-hal penting yang perlu diingat tentang lingkungan, organisasi, dan grup lingkungan:

Elemen	Aturan
Organisasi	Dapat berisi beberapa grup lingkungan Harus memiliki setidaknya satu grup lingkungan
Lingkungan	Setidaknya harus dalam satu grup lingkungan Dapat berada di lebih dari satu grup Berbagi nama host dengan semua lingkungan lain di grup yang sama Dapat digunakan untuk meneruskan traffic ke URI tertentu
Jenis Lingkungan	Menentukan fungsionalitas yang tersedia di dan dengan lingkungan tersebut Menentukan harga untuk lingkungan (Lihat Jenis lingkungan.)
Grup Lingkungan	Dapat memiliki beberapa nama host Berisi satu atau beberapa lingkungan Nama host yang ditetapkan ke grup harus unik untuk grup tersebut (tidak boleh digunakan oleh grup lain)

Pengguna Apigee Hybrid: Setiap grup lingkungan yang Anda buat dengan lingkungan terlampir harus disertakan dalam semua file pengganti tempat lingkungan digunakan.

Contoh

Bagian berikut menunjukkan cara umum untuk menyusun lingkungan dalam lingkungan grup.

Satu grup lingkungan dan satu lingkungan

Struktur yang paling sederhana adalah satu grup lingkungan dengan satu lingkungan di dalamnya. Hal ini umum bagi organisasi yang sedang mengevaluasi produk atau belum menyiapkan pengujian dan analisis, serta tidak memiliki {i>proxy<i} yang di-deploy dalam produksi.

Beberapa lingkungan dalam satu grup lingkungan

Grup lingkungan dapat berisi beberapa lingkungan. Pada contoh di bawah ini, adalah grup lingkungan tunggal, prod-group, yang berisi tiga lingkungan, cart-prod, catalog-prod, dan payment-prod.

Grup lingkungan memiliki satu nama host, example.com. Anda dapat menggunakan untuk merutekan permintaan ke proxy yang di-deploy di lingkungan mana pun. Perlu diketahui bahwa nama host ditentukan pada tingkat grup lingkungan: tidak dirutekan ke lingkungan tertentu.

Lihat Bekerja dengan grup lingkungan untuk mempelajari cara membuat grup lingkungan ini.

Membatasi perutean ke satu lingkungan

Pada contoh sebelumnya, permintaan dapat dirutekan ke proxy di ketiga lingkungan dengan satu nama host. Jika Anda ingin membatasi akses ke {i>proxy<i} di satu lingkungan, misalnya catalog-prod, membuat grup lingkungan lain yang hanya berisi lingkungan catalog-prod. Kemudian, nama host yang ditentukan untuk grup lingkungan tersebut hanya dapat mengakses catalog-prod.

Dalam contoh di bawah ini, nama host catalog.example.com, untuk grup lingkungan catalog-prod-group, dapat hanya merutekan permintaan ke proxy di lingkungan catalog-prod.

Siap membuat grup? Buka Console

Untuk mempelajari lebih lanjut lingkungan: Terus Membaca

Untuk mempelajari lebih lanjut grup lingkungan: Terus Membaca

Pemilihan rute dan jalur dasar

Dalam konfigurasi sederhana, permintaan ke proxy API yang di-deploy terdiri dari nama host, basis jalur, dan nama resource API; misalnya:

https://www.example.com/shopping/cart/addItem
        |_____________| |___________| |_____|
               |             |           |
            hostname      basepath     resource

Anda menentukan nama host di grup lingkungan sehingga beberapa lingkungan dapat membagikannya. Basepath dan resource API ditetapkan di proxy API.

Catatan: Lingkungan dan nama grup tidak memengaruhi URL endpoint API. Mereka hanya ditujukan bagi Anda untuk mengatur dan mengkonfigurasi lingkungan fleksibel, dan tidak diekspos ke pengguna akhir proxy.

Untuk informasi selengkapnya tentang jalur dasar dan resource API, mulailah dengan Memahami rute. Selain itu, lihat Referensi konfigurasi flow dan Referensi variabel flow untuk mendapatkan pemahaman yang lebih baik tentang bagaimana bagian-bagian ini saling melengkapi.

Nama host

Saat membuat grup lingkungan, Anda melampirkan satu atau beberapa nama host ke grup tersebut. Sebagai misalnya, Anda mungkin memiliki grup lingkungan berikut, masing-masing dengan nama host-nya sendiri:

Nama Grup Lingkungan (Lingkungan)	prod-group (catalog-prod cart-prod pymnt-prod)	dev-group (dev-env)	test-group (test-env)
Nama host	Catalog.example.com payment.example.com	dev.example.com	test.example.com

Anda menentukan jalur dasar di proxy saat Anda buat file tersebut.

Saat Anda men-deploy proxy ke lingkungan dalam grup, nama host ditambah jalur dasar dan nama resource bersama-sama menentukan endpoint API ke {i>proxy<i} tersebut.

Anda dapat menentukan lebih dari satu nama host pada grup lingkungan. Semuanya dapat digunakan untuk memanggil yang di-deploy ke lingkungan mana pun dalam grup. Misalnya, catalog.example.com/proxy1 dan payment.example.com/proxy1 akan memanggil resource proxy1 jika nama host catalog.example.com dan payment.example.com ditentukan di grup lingkungan yang sama.

Contoh pemilihan rute

Contoh:

• Grup lingkungan prod-group berisi lingkungan berikut:

  • catalog-prod
  • cart-prod
  • pymnt-prod

• prod-group memiliki nama host berikut yang telah ditentukan:

  • catalog.example.com
  • payment.example.com

• Proxy berikut di-deploy ke lingkungan ini:

  • Proxy catalog di catalog-prod dengan jalur dasar /catalog
  • Proxy cart di cart-prod dengan jalur dasar /catalog/cart
  • Proxy payment di pymnt-prod dengan jalur dasar /payment

Tindakan ini akan membuat endpoint berikut:

• catalog.example.com/catalog rute ke Proxy catalog di lingkungan catalog-prod.
• catalog.example.com/catalog/cart rute ke Proxy cart di lingkungan cart-prod.
• payment.example.com/payment rute ke Proxy payment di lingkungan pymnt-prod.

Contoh berikut menunjukkan bahwa permintaan dirutekan ke proxy berbeda yang di-deploy ke lingkungan dalam grup, yang cocok dengan nama host dan jalur dasar:

Tips:

Nama host yang Anda tentukan pada grup lingkungan:

• Harus unik di semua grup lingkungan dalam suatu organisasi; mereka tidak dapat digunakan oleh lebih dari satu grup
• Tidak mendukung karakter pengganti
• Jalur dasar harus unik dalam grup lingkungan (tidak ada dua proxy yang dapat memiliki jalur dasar yang sama dalam grup lingkungan)

Untuk informasi selengkapnya, lihat Menambahkan nama host ke grup.

Lingkungan dan pemilihan rute bersama

Sebuah lingkungan dapat dimiliki oleh beberapa grup lingkungan. Jika Anda men-deploy proxy ke tertentu, {i>proxy<i} akan memiliki beberapa alamat, satu untuk setiap grup lingkungan yang yang mengikutinya. Hal ini berguna jika pelanggan memiliki sertifikat {i>wildcard<i} (seperti *.example.com) untuk beberapa partner.

Contoh:

• shared-env termasuk dalam dua grup lingkungan:
  • partner-1 dengan alias host api.partner-1.com
  • partner-2 dengan alias host api.partner-2.com
• Proxy foo di-deploy ke shared-env dengan jalur dasar /foo. Karena shared-env digunakan bersama oleh kedua grup lingkungan, foo memiliki dua alamat:
  • api.partner-1.com/foo
  • api.partner-2.com/foo

Perhatikan bahwa kedua nama host dirutekan ke lingkungan yang sama. Cara ini memberikan setiap grup lingkungan nama domain yang unik. Untuk Apigee Hybrid, skenario ini dapat menggunakan mTLS dengan sertifikat yang berbeda untuk setiap partner.

Tentang cakupan lingkungan

Organisasi ini menyediakan cakupan untuk beberapa kemampuan Apigee. Misalnya, peta nilai kunci (KVM) data dapat tersedia di tingkat organisasi, yang berarti bahwa {i>proxy<i} API di-deploy ke lingkungan dalam organisasi itu dapat mengakses data KVM yang sama.

Demikian pula, beberapa kemampuan dapat mencakup lingkungan atau grup lingkungan dalam organisasi/pengaturan. Misalnya, data analisis Apigee dipartisi berdasarkan kombinasi organisasi, {i>environment<i}, dan (akhirnya) {i>environment<i}.

Pertimbangan

Setiap deployment ke lingkungan berpotensi memengaruhi pemilihan rute traffic untuk setiap grup lingkungan tempat lingkungan tersebut disertakan. Ketika {i>basepath<i} baru ditambahkan, jalur itu mungkin mulai menangkap traffic yang sama sekali baru, atau mereka dapat mulai menangkap subset traffic yang ada sudah ditangani oleh deployment yang ada.

Demikian pula, jika jalur dasar dihapus, jalur tersebut mungkin sesuai dengan endpoint yang tidak lagi menerima lalu lintas apa pun, atau dapat menyebabkan lalu lintas yang ada dialihkan ke proxy yang berbeda. Saat lalu lintas dialihkan, mungkin ke proxy di lingkungan yang sama, atau ketika beberapa lingkungan berbagi satu grup lingkungan, mungkin juga ke {i>proxy<i} di lingkungan yang berbeda.

Jumlah total basepath proxy API yang ditambahkan ke suatu lingkungan, atau grup lingkungan, juga harus dipertimbangkan. Untuk performa yang optimal, Apigee merekomendasikan untuk tidak menggunakan lebih dari 3.000 basepath proxy API per lingkungan Apigee atau grup lingkungan. Jika rekomendasi ini terlampaui, latensi untuk semua deployment proxy API baru dan yang sudah ada dapat meningkat.

Referensi lainnya

Informasi berikut menjelaskan cara mengelola lingkungan dan grup lingkungan Anda:

• Dengan UI Apigee:

  • Bekerja dengan lingkungan
  • Bekerja dengan grup lingkungan

• Dengan Apigee API:

  • Environments API
  • Environment groups API
  • Environment group attachment API