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 lingkungan software, dalam organisasi, untuk membuat dan men-deploy proxy API. Anda harus men-deploy proxy API ke lingkungan sebelum dapat diakses. Anda dapat men-deploy proxy API ke satu lingkungan atau beberapa lingkungan.

Setiap lingkungan tunduk pada batasan jumlah proxy API, alur bersama, dan resource lainnya yang dapat di-deploy ke lingkungan tersebut. Batasan ini bervariasi berdasarkan jenis organisasi Apigee (Langganan, Bayar sesuai pemakaian, atau campuran) yang menggunakan lingkungan. Untuk informasi yang lebih mendetail, lihat dokumentasi Batas.

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

Lingkungan harus menjadi anggota minimal satu grup lingkungan sebelum Anda dapat mengakses proxy yang di-deploy di dalamnya. Dengan kata lain, Anda harus menetapkan lingkungan ke grup sebelum dapat menggunakannya.

Pengelompokan lingkungan secara logis menurut grup lingkungan memberikan manfaat berikut:

• Pengelolaan nama host terpusat: Grup lingkungan menyediakan tempat terpusat untuk mengelola nama host.
• Insight gabungan: Dengan grup, Anda dapat menganalisis error dengan melihat laporan untuk seluruh grup lingkungan sekaligus, bukan lingkungan individual.
• Pencegahan konflik: Dengan mengelompokkan lingkungan, Anda dapat memastikan bahwa jalur dasar untuk proxy yang di-deploy ada di bawah nama host yang sama.

Jenis deployment yang didukung

Apigee mendukung jenis deployment berikut di lingkungan:

Jenis	Deskripsi
Proxy	Kembangkan dan uji proxy API di lingkungan pengembangan Apigee, lalu deploy ke lingkungan produksi dan pengujian integrasi 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 akan dicegah untuk melakukan tindakan berikut dalam lingkungan untuk mencegah konflik:

• Di UI Apigee, Anda tidak dapat melihat, mengonfirmasi status deployment, atau mengelola deployment arsip, seperti yang dijelaskan dalam Men-deploy proxy API, atau menggunakan UI Debug seperti yang dijelaskan dalam Menggunakan Debug. Sebagai solusi, Anda dapat menggunakan gcloud atau API untuk Mencantumkan semua deployment arsip dalam lingkungan dan menggunakan Debug API.
• Anda tidak dapat membuat, memperbarui, atau menghapus file resource atau server target menggunakan UI, API, atau gcloud Apigee.
• 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 salah satu 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 alur bersama yang di-deploy.

Penggunaan Anda mungkin tunduk pada kuota deployment, yang merupakan batas jumlah unit deployment yang dapat Anda gunakan dalam satu waktu. Lihat hak Anda (Pay-as-you-go atau Langganan 2024) untuk mengetahui detailnya. Untuk informasi tentang batas sistem, lihat Unit deployment proxy maksimum per instance.

Untuk mengetahui 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 akan memilih jenis lingkungan: Dasar, 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 mengetahui informasi selengkapnya.

Untuk paket Langganan, jenis lingkungan Anda selalu Komprehensif dan Anda tidak perlu mengetahui jenis lingkungan.

Proxy penerusan

Apigee mendukung penerusan traffic ke URI yang ditentukan. Fitur ini berlaku di tingkat lingkungan dan dapat digunakan untuk mengarahkan traffic ke internet setelah pemrosesan awal di proxy.

Permintaan masuk ke proxy dalam proses lingkungan yang dikonfigurasi untuk setiap kebijakan yang disertakan (lihat Dukungan fitur penerusan proxy), lalu teruskan menggunakan HTTP ke URI baru.

Perubahan yang dilakukan pada setelan proxy penerusan lingkungan akan segera diterapkan hanya untuk permintaan baru. Permintaan yang sudah diproses selesai dengan setelan yang berlaku saat permintaan diterima.

Untuk petunjuk cara mengonfigurasi proxy penerusan, lihat Mengonfigurasi proxy penerusan di lingkungan.

Dukungan fitur penerusan proxy

Tidak semua fitur proxy yang tersedia secara umum memiliki ketersediaan atau penerapan yang sama dengan proxy penerusan.

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

Tabel ini menunjukkan dukungan untuk fungsi tambahan:

Fitur atau kebijakan	Didukung/berlaku untuk proxy penerusan?
Endpoint Target	Ya
Health Check HTTP	Ya
Info Layanan	Ya
Panggilan HTTP melalui JavaScript	Ya
Target integrasi	Ya
Rantai proxy, melalui loopback lokal	Tidak
Memublikasikan pesan	Tidak
Cloud Logging	Tidak
Komunikasi dengan Synchronizer	Tidak
Pencatatan log pesan melalui Syslog	Tidak

Batasan proxy penerusan

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

Poin utama

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

Elemen	Aturan
Organisasi	Dapat berisi beberapa grup lingkungan Harus memiliki minimal satu grup lingkungan
Lingkungan	Harus berada di minimal satu grup lingkungan Dapat berada di lebih dari satu grup Membagikan nama host dengan semua lingkungan lain dalam grup yang sama Dapat digunakan untuk meneruskan traffic ke URI yang ditentukan
Jenis Lingkungan	Menentukan fungsi yang tersedia di dan dengan lingkungan tersebut Menentukan harga untuk lingkungan (Lihat Jenis lingkungan.)
Environment Group	Dapat memiliki beberapa nama host Berisi satu atau beberapa lingkungan Nama host yang ditetapkan ke grup harus unik untuk grup tersebut (tidak dapat digunakan oleh grup lain)

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

Contoh

Bagian berikut menunjukkan cara umum lingkungan disusun dalam grup lingkungan.

Satu grup lingkungan dan satu lingkungan

Struktur yang paling sederhana adalah satu grup lingkungan dengan satu lingkungan di dalamnya. Hal ini umum terjadi pada organisasi yang saat ini mengevaluasi produk atau belum menyiapkan infrastruktur pengujian atau analisis, atau belum men-deploy proxy dalam produksi.

Beberapa lingkungan dalam satu grup lingkungan

Grup lingkungan dapat berisi beberapa lingkungan. Dalam contoh di bawah, ada satu grup lingkungan, prod-group, yang berisi tiga lingkungan, cart-prod, catalog-prod, dan payment-prod.

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

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

Membatasi pemilihan rute ke satu lingkungan

Pada contoh sebelumnya, permintaan dapat dirutekan ke proxy di ketiga lingkungan dengan satu nama host. Jika Anda ingin membatasi akses ke proxy di satu lingkungan, misalnya catalog-prod, buat 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, nama host catalog.example.com, untuk grup lingkungan catalog-prod-group, hanya dapat merutekan permintaan ke proxy di lingkungan catalog-prod.

Siap membuat grup? Membuka Konsol

Untuk mempelajari lebih lanjut lingkungan: Lanjutkan Membaca

Untuk mempelajari lebih lanjut grup lingkungan: Lanjutkan Membaca

Jalur pemilihan rute dan dasar

Dalam konfigurasi sederhana, permintaan ke proxy API yang di-deploy terdiri dari nama host, jalur dasar, 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 menggunakannya. Jalur dasar dan resource API ditentukan di proxy API.

Catatan: Nama lingkungan dan grup tidak memengaruhi URL endpoint API. API ini hanya dimaksudkan untuk Anda guna mengatur dan mengonfigurasi lingkungan, dan tidak ditampilkan kepada pengguna akhir proxy.

Untuk informasi selengkapnya tentang jalur dasar dan resource API, mulai dengan Memahami rute. Selain itu, lihat Referensi konfigurasi alur dan Referensi variabel alur untuk mendapatkan pemahaman yang lebih baik tentang cara menyatukan bagian-bagian ini.

Nama host

Saat membuat grup lingkungan, Anda akan melampirkan satu atau beberapa nama host ke grup tersebut. Misalnya, Anda mungkin memiliki grup lingkungan berikut, masing-masing dengan nama hostnya 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 membuatnya.

Saat Anda men-deploy proxy ke lingkungan dalam grup, nama host beserta jalur dasar dan nama resource bersama-sama menentukan endpoint permintaan API ke proxy tersebut.

Anda dapat menentukan lebih dari satu nama host di grup lingkungan. Semuanya dapat digunakan untuk memanggil proxy apa pun 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 ditentukan di dalamnya:

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

• Proksi 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 merutekan ke proxy catalog di lingkungan catalog-prod.
• catalog.example.com/catalog/cart merutekan ke proxy cart di lingkungan cart-prod.
• payment.example.com/payment merutekan ke proxy payment di lingkungan pymnt-prod.

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

Tips:

Nama host yang Anda tentukan di grup lingkungan:

• Harus unik di semua grup lingkungan dalam organisasi; 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 hostname ke grup.

Lingkungan dan pemilihan rute bersama

Lingkungan dapat menjadi bagian dari beberapa grup lingkungan. Jika Anda men-deploy proxy ke lingkungan tersebut, proxy akan memiliki beberapa alamat, satu untuk setiap grup lingkungan yang menjadi bagian dari lingkungan. Hal ini berguna jika pelanggan memiliki sertifikat pengganti (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. Tindakan ini akan memberi 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 menyediakan cakupan untuk beberapa kemampuan Apigee. Misalnya, data peta nilai kunci (KVM) dapat disediakan di tingkat organisasi, yang berarti bahwa proxy API yang di-deploy ke lingkungan mana pun dalam organisasi tersebut dapat mengakses data KVM yang sama.

Demikian pula, beberapa kemampuan dapat dicakup untuk lingkungan atau grup lingkungan dalam organisasi. Misalnya, data analisis Apigee dipartisi oleh kombinasi organisasi, lingkungan, dan (pada akhirnya) grup lingkungan.

Pertimbangan

Setiap deployment ke lingkungan berpotensi memengaruhi pemilihan rute traffic untuk setiap grup lingkungan tempat lingkungan tersebut dilampirkan. Saat ditambahkan, basepath baru dapat mulai menangkap traffic yang sepenuhnya baru, atau dapat mulai menangkap subset traffic yang ada yang telah ditangani oleh deployment yang ada.

Demikian pula, saat dihapus, basepath mungkin sesuai dengan endpoint yang tidak lagi menerima traffic, atau dapat menyebabkan traffic yang ada dialihkan ke proxy lain. Saat traffic dialihkan, traffic tersebut mungkin dialihkan ke proxy di lingkungan yang sama, atau jika beberapa lingkungan berbagi satu grup lingkungan, traffic tersebut mungkin dialihkan ke proxy di lingkungan yang berbeda.

Jumlah total jalur dasar proxy API yang ditambahkan ke lingkungan, atau grup lingkungan, juga harus dipertimbangkan. Untuk performa yang optimal, Apigee merekomendasikan penggunaan tidak lebih dari 3.000 jalur dasar proxy API per lingkungan atau grup lingkungan Apigee. Melebihi rekomendasi ini dapat menyebabkan peningkatan latensi untuk semua deployment proxy API baru dan yang sudah ada.

Referensi lainnya

Informasi berikut menjelaskan cara mengelola lingkungan dan grup lingkungan:

• Dengan UI Apigee:

  • Bekerja dengan lingkungan
  • Bekerja dengan grup lingkungan

• Dengan Apigee API:

  • Environments API
  • Environment groups API
  • API lampiran grup lingkungan