Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi
Apigee X. info
Edge Microgateway v. 3.1.x
Microgateway Apigee Edge adalah pemroses pesan berbasis HTTP yang aman untuk API. Tugas utamanya adalah memproses permintaan dan respons ke dan dari layanan backend dengan aman sekaligus secara asinkron mendorong data eksekusi API yang berharga ke Apigee Edge tempat data tersebut digunakan oleh sistem Edge Analytics. Edge Microgateway mudah diinstal dan di-deploy -- Anda dapat mengaktifkan dan menjalankan instance dalam hitungan menit.
Biasanya, Edge Microgateway diinstal dalam jaringan tepercaya yang berdekatan dengan layanan target backend. Layanan ini menyediakan keamanan tingkat perusahaan, dan beberapa fitur plugin utama seperti pembatasan lonjakan, kuota, dan analisis, tetapi tidak mencakup kemampuan atau jejak penuh Apigee Edge. Anda dapat menginstal Edge Microgateway di pusat data yang sama atau bahkan di mesin yang sama dengan layanan backend Anda jika mau.
Anda dapat menjalankan Edge Microgateway sebagai proses mandiri atau menjalankannya dalam container Docker. Lihat Menggunakan Docker dengan Edge Microgateway. Anda juga dapat menggunakan Edge Microgateway untuk menyediakan pengelolaan Apigee API bagi layanan yang berjalan di cluster Kubernetes. Baik Anda memigrasikan layanan dan API yang ada ke stack Kubernetes atau membuat layanan dan API baru, Edge Microgateway membantu memberikan pengalaman pengelolaan API yang bersih yang mencakup keamanan, pengelolaan traffic, analisis, publikasi, dan lainnya. Lihat Mengintegrasikan Edge Microgateway dengan Kubernetes.
Kasus penggunaan umum
Kasus penggunaan umum untuk solusi pengelolaan Cloud API campuran seperti Edge Microgateway meliputi:
- Mengurangi latensi traffic API untuk layanan yang berjalan dalam jarak dekat. Misalnya, jika konsumen dan produsen API Anda berada dalam jarak dekat, Anda tidak perlu meminta API untuk melalui gateway pusat.
- Pastikan traffic API tetap berada dalam batas yang disetujui perusahaan untuk tujuan keamanan atau kepatuhan.
- Melanjutkan pemrosesan pesan jika koneksi internet terputus untuk sementara.
- Memberikan pengelolaan Apigee API untuk layanan yang berjalan di cluster Kubernetes. Lihat Mengintegrasikan Edge Microgateway dengan Kubernetes.
Untuk kasus penggunaan tambahan, lihat artikel Komunitas Apigee ini.
Fitur dan manfaat utama
| Fitur | Manfaat |
|---|---|
| Keamanan | Edge Microgateway mengautentikasi permintaan dengan token akses atau kunci API yang ditandatangani dan dikeluarkan ke setiap aplikasi klien oleh Apigee Edge. |
| Deployment cepat | Tidak seperti deployment penuh Apigee Edge, Anda dapat men-deploy dan menjalankan instance Edge Microgateway dalam hitungan menit. |
| Kedekatan jaringan | Anda dapat menginstal dan mengelola Edge Microgateway di mesin, subnet, atau pusat data yang sama dengan API target backend yang berinteraksi dengan Edge Microgateway. |
| Analytics | Edge Microgateway secara asinkron mengirimkan data eksekusi API ke Apigee Edge, tempat data tersebut diproses oleh sistem Edge Analytics. Anda dapat menggunakan rangkaian lengkap metrik, dasbor, dan API Edge Analytics. |
| Mengurangi latensi | Semua komunikasi dengan Apigee Edge bersifat asinkron dan tidak terjadi sebagai bagian dari pemrosesan permintaan API klien. Hal ini memungkinkan Edge Microgateway mengumpulkan data API dan mengirimkannya ke Apigee Edge tanpa memengaruhi latensi. |
| Familiaritas | Edge Microgateway menggunakan dan berinteraksi dengan fitur Apigee Edge yang sudah dipahami dengan baik oleh administrator Edge, seperti proxy, produk, dan aplikasi developer. |
| Konfigurasi | Tidak diperlukan pemrograman untuk menyiapkan dan mengelola Edge Microgateway. Semuanya ditangani melalui konfigurasi. |
| Kemudahan | Anda dapat mengintegrasikan Edge Microgateway dengan infrastruktur dan proses pengelolaan serta pemantauan aplikasi yang ada. |
| Logging | File log menjelaskan semua peristiwa normal dan pengecualian yang terjadi selama pemrosesan API oleh Edge Microgateway. |
| CLI | Antarmuka command line memungkinkan Anda memulai, menghentikan, dan memulai ulang Edge Microgateway, mengekstrak statistik operasi, melihat file log, meminta token akses, dan lainnya. |
Yang perlu Anda ketahui tentang Microgateway Edge
Bagian ini menjelaskan cara kerja Edge Microgateway, arsitektur dasar, konfigurasi, dan deployment-nya.
Mengapa menggunakan Edge Microgateway?
Memindahkan komponen pengelolaan API ke dekat aplikasi target backend dapat mengurangi latensi jaringan. Meskipun Anda dapat menginstal Apigee Edge di tempat di cloud pribadi, deployment lengkap Apigee Edge harus besar dan kompleks untuk mendukung kumpulan fitur lengkap dan fitur yang membutuhkan banyak data seperti pengelolaan kunci enkripsi, monetisasi, dan analisis. Artinya, men-deploy Apigee Edge di setiap pusat data tidak selalu diinginkan.
Dengan Edge Microgateway, Anda mendapatkan aplikasi dengan jejak yang relatif kecil yang berjalan dekat dengan aplikasi backend Anda. Selain itu, Anda dapat memanfaatkan Apigee Edge secara penuh untuk analisis, keamanan, dan fitur lainnya.
Contoh skenario deployment
Bagian ini mengilustrasikan beberapa kemungkinan skenario deployment untuk Edge Microgateway.
Mesin yang sama
Gambar 1 menunjukkan jalur pemrosesan permintaan saat Edge Microgateway di-deploy dalam konfigurasi yang paling sederhana, dengan Edge Microgateway dan API target backend diinstal di mesin yang sama. Satu instance Edge Microgateway dapat digunakan untuk memproses beberapa aplikasi target backend
Komputer lain
Karena semua komunikasi antara klien, Edge Microgateway, dan implementasi API backend adalah HTTP, Anda dapat menginstal Edge Microgateway Apigee di komputer yang berbeda dari implementasi API, seperti yang ditunjukkan pada Gambar 2.
Dengan load balancer
Edge Microgateway itu sendiri dapat di-front-end oleh reverse proxy atau load-balancer standar untuk penghentian SSL dan/atau load balancing, seperti yang ditunjukkan pada Gambar 3.
Deployment intranet
Gunakan Edge Microgateway untuk melindungi traffic intranet sekaligus melindungi traffic internet dengan
Apigee Edge, seperti yang diilustrasikan dalam Gambar 4. Misalnya, endpoint API /orders di-proxy melalui Apigee Edge Cloud, dan endpoint tersebut menjangkau target backend https://mycompany.com/orders. Hal ini diwakili oleh implementasi API target
di sebelah kiri. API ini kemudian dapat memanggil beberapa endpoint API yang diwakili oleh implementasi target di sebelah kanan. Misalnya, kode ini dapat memanggil /customers dan
/transactions secara internal. Lihat juga
postingan ini di Komunitas Apigee.
Dependensi pada Apigee Edge
Edge Microgateway bergantung pada dan berinteraksi dengan Apigee Edge. Edge Microgateway harus berkomunikasi dengan Apigee Edge agar berfungsi dengan benar. Cara utama Edge Microgateway berinteraksi dengan Edge adalah:
- Saat memulai, Edge Microgateway akan mendapatkan daftar proxy khusus "Edge Microgateway-aware" dan daftar semua produk API dari organisasi Apigee Edge Anda. Untuk setiap permintaan klien yang masuk, Edge Microgateway menentukan apakah permintaan tersebut cocok dengan salah satu proxy API ini, lalu memvalidasi token akses atau kunci API yang masuk berdasarkan kunci dalam produk API yang terkait dengan proxy tersebut.
- Sistem Apigee Edge Analytics menyimpan dan memproses data API yang dikirim secara asinkron dari Edge Microgateway.
- Apigee Edge menyediakan kredensial yang digunakan untuk menandatangani token akses atau memberikan kunci API yang diperlukan oleh klien yang melakukan panggilan API melalui Edge Microgateway. Anda bisa mendapatkan token ini menggunakan perintah CLI yang disediakan dengan Edge Microgateway.
Konfigurasi satu kali
Anda harus mengonfigurasi Edge Microgateway terlebih dahulu agar dapat berkomunikasi dengan organisasi Apigee Edge Anda. Saat memulai, Edge Microgateway memulai operasi bootstrap dengan Apigee Edge. Edge Microgateway mengambil informasi yang diperlukan dari Apigee Edge untuk memproses panggilan API sendiri, termasuk daftar proxy yang mendukung Edge Microgateway yang di-deploy di Apigee Edge. Kami akan segera membahas lebih lanjut proxy ini.
Edge Microgateway tidak harus ditempatkan bersama dengan Apigee Edge; penawaran cloud publik dan pribadi Apigee Edge berfungsi dengan baik.
Yang perlu Anda ketahui tentang proxy yang mendukung Edge Microgateway
Proxy yang mendukung Edge Microgateway memberikan informasi tertentu kepada Edge Microgateway yang memungkinkannya memproses permintaan API klien. Informasi tentang proxy ini didownload dari Apigee Edge ke Edge Microgateway saat Edge Microgateway dimulai.
Anda atau tim API Anda dapat membuat proxy ini di Apigee Edge menggunakan UI pengelolaan Apigee Edge atau melalui cara lain jika Anda mau. Caranya mudah, dan kami akan membahas detailnya di artikel Menyiapkan dan mengonfigurasi Edge Microgateway.
Karakteristik proxy yang mendukung Edge Microgateway adalah:
- Kedua layanan tersebut menyediakan dua informasi penting bagi Edge Microgateway: jalur dasar dan URL target.
- URL tersebut harus mengarah ke endpoint target HTTP. Target backend tidak boleh berupa aplikasi Node.js yang direferensikan oleh elemen ScriptTarget dalam definisi TargetEndpoint. Lihat catatan sebelumnya untuk mengetahui informasi selengkapnya.
- Nama proxy harus diawali dengan
edgemicro_. Misalnya:edgemicro_weather. - Anda tidak dapat menambahkan kebijakan atau alur bersyarat ke proxy ini. Jika Anda mencobanya, perintah tersebut akan diabaikan. Jika tidak, proxy yang mendukung Edge Microgateway akan muncul di UI Pengelolaan Edge sama seperti proxy API lainnya di Edge.
- API ini dapat dipaketkan ke dalam produk dan dikaitkan dengan aplikasi developer.
- Data traffic muncul di Edge Analytics.
- Peristiwa tersebut tidak dapat dilacak menggunakan alat Apigee Edge Trace.
Tentang Edge Microgateway dan Apigee Edge Analytics
Saat traffic API mengalir melalui Edge Microgateway, Edge Microgateway akan melakukan buffering dan mengirim data eksekusi API secara asinkron ke Apigee Edge, tempat data disimpan dan diproses oleh sistem Edge Analytics. Komunikasi asinkron ini memungkinkan Edge Microgateway memanfaatkan fitur analisis Edge, sekaligus mempertahankan jejak yang relatif kecil dengan overhead atau pemblokiran pemrosesan minimal. Rangkaian lengkap dasbor Edge Analytics dan kemampuan pelaporan kustom tersedia bagi Anda dan tim untuk menganalisis traffic yang melewati Edge Microgateway.
Untuk informasi selengkapnya tentang Edge Analytics, lihat Dasbor Analytics.
Tentang keamanan Microgateway Edge
Peran Apigee Edge
Seperti yang disebutkan sebelumnya, Apigee Edge berperan dalam mengamankan semua permintaan klien ke Edge Microgateway. Peran utama yang dimainkan Apigee Edge adalah:
- Memberikan kredensial klien yang digunakan sebagai kunci API atau untuk membuat token akses yang valid yang digunakan oleh klien untuk melakukan panggilan API yang aman melalui Edge Microgateway.
- Menyediakan kredensial yang diperlukan Edge Microgateway untuk mengirim data eksekusi API ke sistem Apigee Edge Analytics. Kredensial ini diperoleh sekali oleh Edge Microgateway selama langkah-langkah penyiapan awal.
- Menyediakan platform untuk memaketkan resource API ke dalam produk, mendaftarkan dan mengelola developer, serta membuat dan mengelola aplikasi developer.
Autentikasi aplikasi klien
Edge Microgateway mendukung autentikasi klien melalui token akses dan kunci API. Kunci dan token keamanan dibuat oleh Apigee Edge dan divalidasi oleh Edge Microgateway untuk setiap panggilan API. Jika plugin OAuth diaktifkan, Edge Microgateway akan memeriksa token akses atau kunci API yang ditandatangani dan jika valid, panggilan API akan dilanjutkan ke target backend. Jika tidak valid, error akan ditampilkan.
Lihat Menyiapkan dan mengonfigurasi Edge Microgateway untuk mengetahui langkah-langkah yang diperlukan guna mendapatkan dan menggunakan token akses dan kunci API.
Autentikasi Edge Microgateway di Apigee Edge
Panggilan asinkron yang dilakukan Edge Microgateway untuk memperbarui data analisis di Apigee Edge memerlukan autentikasi. Autentikasi ini disediakan melalui pasangan kunci publik/rahasia yang diteruskan ke Edge Microgateway melalui CLI atau menggunakan variabel lingkungan. Anda mendapatkan dan menggunakan kunci ini satu kali saat pertama kali menginstal dan memulai Edge Microgateway.
Platform pengelolaan produk API
Edge berfungsi sebagai platform untuk memaketkan resource API ke dalam produk, mendaftarkan dan mengelola developer, serta membuat dan mengelola aplikasi developer. Misalnya, sama seperti Anda dapat membuat dan memaketkan entity seperti produk dan aplikasi developer untuk proxy Apigee Edge reguler, Anda dapat melakukan hal yang sama persis untuk proxy Edge Microgateway. Keamanan tingkat API dimungkinkan dengan membuat kunci keamanan publik dan pribadi untuk setiap "paket". Mekanisme ini identik dengan cara kerja keamanan API di Apigee Edge.
Dapatkah saya memindahkan implementasi proxy Edge yang ada ke Edge Microgateway?
Anda tidak dapat memigrasikan proxy yang ada dengan kebijakan terkait atau alur bersyarat ke Edge Microgateway. Edge Microgateway mengharuskan Anda membuat proxy "yang mengetahui microgateway" baru. Proksi ini harus diberi nama dengan awalan khusus, edgemicro_. Saat dimulai, Edge Microgateway menemukan proxy edgemicro_* ini dan mendownload informasi konfigurasi untuk setiap proxy. Informasi ini mencakup URL target dan jalur resource-nya. Mulai saat itu, proxy tidak akan digunakan. Kebijakan atau alur kondisional apa pun di proxy ini tidak akan pernah dieksekusi.
Alasan lain untuk memiliki proxy yang mendukung microgateway adalah Edge Microgateway secara asinkron mendorong data analisis ke Edge untuk setiap proxy yang mendukung microgateway. Selanjutnya, Anda dapat melihat data analitik untuk proxy yang mendukung microgateway seperti yang Anda lakukan untuk proxy lainnya di UI Analytics Edge.
Topik penyiapan akan memandu Anda melalui semua langkah yang perlu dilakukan untuk mulai melakukan proxy panggilan API melalui Edge Microgateway, termasuk beberapa langkah sederhana yang perlu dilakukan di Apigee Edge untuk menyiapkan konfigurasi yang diperlukan Edge Microgateway, termasuk pembuatan proxy yang mendukung microgateway. Lihat Menyiapkan dan mengonfigurasi Edge Microgateway.
Pelajari Edge Microgateway lebih lanjut
Apigee menyediakan resource berikut:
-
Dokumentasi Edge Microgateway - Dokumen ini mencakup panduan penginstalan dan tutorial memulai, serta informasi referensi dan konfigurasi lengkap.
-
Video - Seri Video Apigee empat menit untuk Developer mencakup serangkaian episode tentang Edge Microgateway.
-
Komunitas Apigee adalah tempat yang tepat untuk mengajukan pertanyaan dan mendapatkan manfaat dari pertanyaan yang diajukan dan dijawab oleh orang lain.