Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Edge Microgateway v. 3.1.x
Apigee Edge Microgateway adalah pemroses pesan berbasis HTTP yang aman untuk API. Tugas utamanya adalah memproses permintaan serta respons ke dan dari layanan backend dengan aman sambil mendorong data eksekusi API yang berharga secara asinkron ke Apigee Edge yang 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 dekat dengan layanan target backend. Platform ini memberikan keamanan tingkat perusahaan, dan beberapa fitur plugin utama seperti penangkapan lonjakan, kuota, dan analisis, tetapi bukan 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 jika menginginkannya.
Anda dapat menjalankan Edge Microgateway sebagai proses mandiri atau menjalankannya di container Docker. Lihat Menggunakan Docker dengan Edge Microgateway. Anda juga dapat menggunakan Edge Microgateway untuk menyediakan pengelolaan Apigee API untuk layanan yang berjalan di cluster Kubernetes. Baik Anda memigrasikan layanan dan API yang sudah ada ke stack Kubernetes atau membuat layanan dan API baru, Edge Microgateway membantu memberikan pengalaman pengelolaan API yang rapi dan mencakup keamanan, pengelolaan traffic, analisis, publikasi, dan banyak lagi. Lihat Mengintegrasikan Edge Microgateway dengan Kubernetes.
Kasus penggunaan umum
Kasus penggunaan umum untuk solusi pengelolaan Cloud API hybrid seperti Edge Microgateway meliputi:
- Mengurangi latensi traffic API untuk layanan yang berjalan berdekatan. Misalnya, jika konsumen dan produsen API berdekatan, Anda tentu tidak ingin API melewati gateway pusat.
- Pastikan traffic API berada dalam batas yang disetujui perusahaan untuk tujuan keamanan atau kepatuhan.
- Lanjutkan pemrosesan pesan jika koneksi internet terputus untuk sementara.
- Menyediakan pengelolaan API Apigee untuk layanan yang berjalan di cluster Kubernetes. Lihat Mengintegrasikan Edge Microgateway dengan Kubernetes.
Untuk kasus penggunaan lain, baca artikel Komunitas Apigee ini.
Fitur dan manfaat utama
| Fitur | Manfaat |
|---|---|
| Keamanan | Edge Microgateway mengautentikasi permintaan dengan token akses atau kunci API bertanda tangan yang dikeluarkan untuk 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, yang 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. |
| Pengenalan | 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 memerlukan pemrograman untuk menyiapkan dan mengelola Edge Microgateway. Semuanya ditangani melalui konfigurasi. |
| Kemudahan | Anda dapat mengintegrasikan Edge Microgateway dengan infrastruktur dan proses pemantauan serta pengelolaan aplikasi yang ada. |
| Logging | File log menjelaskan semua peristiwa normal dan luar biasa yang dialami 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 Edge Microgateway
Bagian ini menjelaskan cara kerja Edge Microgateway, arsitektur dasar, konfigurasi, dan deployment-nya.
Mengapa menggunakan Edge Microgateway?
Memindahkan komponen pengelolaan API dekat ke aplikasi target backend dapat mengurangi latensi jaringan. Meskipun Anda dapat menginstal Apigee Edge secara lokal di cloud pribadi, deployment penuh Apigee Edge tentunya berukuran besar dan kompleks untuk mendukung set fitur lengkap dan fitur-fiturnya yang sarat data seperti pengelolaan kunci, monetisasi, dan analisis. Artinya, men-deploy Apigee Edge secara lokal di setiap pusat data tidak selalu diinginkan.
Dengan Edge Microgateway, Anda mendapatkan aplikasi jejak yang relatif kecil yang berjalan dekat dengan aplikasi backend. Selain itu, Anda dapat memanfaatkan Apigee Edge lengkap untuk analisis, keamanan, dan fitur lainnya.
Contoh skenario deployment
Bagian ini mengilustrasikan beberapa kemungkinan skenario deployment untuk Edge Microgateway.
Perangkat yang sama
Gambar 1 menunjukkan jalur pemrosesan permintaan saat Edge Microgateway di-deploy dalam konfigurasinya yang sesederhana mungkin, dengan Edge Microgateway dan API target backend diinstal di mesin yang sama. Satu instance Edge Microgateway dapat digunakan untuk menangani beberapa aplikasi target backend
Mesin berbeda
Karena semua komunikasi antara klien, Edge Microgateway, dan implementasi API backend adalah HTTP, Anda dapat menginstal Apigee Edge Microgateway di komputer yang berbeda dari implementasi API, seperti dalam Gambar 2.
Dengan load balancer
Edge Microgateway sendiri dapat di-front-end oleh reverse proxy atau load-balancer standar untuk penghentian dan/atau load balancing SSL, 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-kan melalui Apigee Edge Cloud, dan mencapai target backend https://mycompany.com/orders. 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 dapat berfungsi dengan benar. Cara utama yang digunakan Edge Microgateway untuk berinteraksi dengan Edge adalah:
- Setelah memulai, Edge Microgateway akan memperoleh daftar proxy "Edge Microgateway-aware" khusus 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 menyediakan kunci API yang diperlukan oleh klien yang melakukan panggilan API melalui Edge Microgateway. Anda dapat memperoleh token ini menggunakan perintah CLI yang disediakan dengan Edge Microgateway.
Konfigurasi satu kali
Anda harus terlebih dahulu mengonfigurasi Edge Microgateway agar dapat berkomunikasi dengan organisasi Apigee Edge. Saat memulai, Edge Microgateway akan 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 tentang {i>proxy<i} ini.
Edge Microgateway tidak harus ditempatkan bersama Apigee Edge; penawaran cloud publik dan pribadi Apigee Edge juga berfungsi sama baiknya.
Yang perlu Anda ketahui tentang proxy berbasis Edge Microgateway
Proxy berbasis 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 dapat memilih untuk membuat proxy ini di Apigee Edge menggunakan UI pengelolaan Apigee Edge atau dengan cara lain jika ingin. Cara ini mudah dilakukan, dan kami akan membahas detailnya di Menyiapkan dan mengonfigurasi Edge Microgateway.
Karakteristik proxy yang mendukung Edge Microgateway adalah:
- Keduanya memberi Edge Microgateway dua informasi penting: jalur dasar dan URL target.
- Link 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 informasi selengkapnya.
- Nama proxy harus diawali dengan
edgemicro_. Contoh:edgemicro_weather. - Anda tidak dapat menambahkan kebijakan atau alur bersyarat ke proxy ini. Jika Anda mencobanya, notifikasi akan diabaikan. Jika tidak, proxy berbasis Edge Microgateway akan muncul di UI Pengelolaan Edge dengan cara yang sama seperti proxy API lainnya di Edge.
- Properti tersebut dapat digabungkan ke dalam produk dan dikaitkan dengan aplikasi developer.
- Data traffic muncul di Edge Analytics.
- Keduanya 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 secara asinkron mengirimkan data eksekusi API ke Apigee Edge, tempat data tersebut disimpan dan diproses oleh sistem Analisis Edge. Komunikasi asinkron ini memungkinkan Edge Microgateway memanfaatkan fitur analisis Edge, sambil 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 Anda untuk menganalisis traffic yang melewati Edge Microgateway.
Untuk informasi lebih lanjut tentang Edge Analytics, lihat dasbor Analytics.
Tentang keamanan Edge Microgateway
Peran Apigee Edge
Seperti yang disebutkan sebelumnya, Apigee Edge berperan dalam mengamankan semua permintaan klien ke Edge Microgateway. Peran utama Apigee Edge adalah:
- Menyediakan kredensial klien yang digunakan sebagai kunci API atau untuk membuat token akses valid yang digunakan oleh klien untuk melakukan panggilan API yang aman melalui Edge Microgateway.
- Memberikan kredensial yang diperlukan Edge Microgateway untuk mengirimkan data eksekusi API ke sistem Apigee Edge Analytics. Kredensial ini diperoleh satu kali oleh Edge Microgateway selama 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 dihasilkan 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 telah 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 dalam mendapatkan dan menggunakan token akses dan kunci API.
Autentikasi Edge Microgateway di Apigee Edge
Panggilan asinkron Edge Microgateway membuat pembaruan 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, seperti Anda dapat membuat dan memaketkan entitas seperti produk dan aplikasi developer untuk proxy Apigee Edge reguler, Anda dapat melakukan hal yang sama persis untuk proxy Edge Microgateway. Keamanan level API dapat diwujudkan 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 baru yang "sadar microgateway." Proxy ini harus diberi nama dengan awalan khusus, edgemicro_. Saat memulai, Edge Microgateway menemukan proxy edgemicro_* ini dan mendownload informasi konfigurasi untuk setiap proxy. Informasi ini mencakup URL target dan jalur resource. Sejak saat itu, proxy tidak digunakan. Kebijakan atau alur bersyarat dalam proxy ini tidak akan pernah dijalankan.
Alasan lain untuk memiliki proxy berbasis microgateway adalah Edge Microgateway secara asinkron mengirim data analisis ke Edge untuk setiap proxy yang mendukung microgateway. Anda kemudian dapat melihat data analisis untuk proxy yang mendukung microgateway seperti yang Anda lakukan untuk proxy lainnya di UI Analisis Edge.
Topik penyiapan ini akan memandu Anda melakukan semua langkah yang perlu dilakukan untuk memulai 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 peka terhadap microgateway. Lihat Menyiapkan dan mengonfigurasi Edge Microgateway.
Pelajari Edge Microgateway lebih lanjut
Apigee menyediakan resource berikut:
-
Dokumentasi Edge Microgateway - Dokumen ini berisi panduan penginstalan dan tutorial memulai, serta referensi lengkap dan informasi konfigurasi.
-
Video - Serial Video Empat Menit untuk Developer Apigee mencakup serangkaian episode di Edge Microgateway.
-
Komunitas Apigee adalah tempat yang tepat untuk mengajukan pertanyaan dan mendapatkan manfaat dari pertanyaan yang diajukan dan dijawab oleh orang lain.