FAQ Edge Microgateway

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Memulai

Bagaimana cara menginstal Edge Microgateway?

Lihat Menginstal Edge Microgateway.

Bagaimana cara menjalankan Edge Microgateway?

Lihat Menyiapkan dan mengonfigurasi Edge Microgateway.

Apakah saya memerlukan database untuk menjalankan Microgateway?

API yang di-proxy-kan melalui Edge Microgateway dapat berinteraksi dengan database yang berjalan sebagai bagian dari layanan target. Namun, Edge Microgateway beroperasi secara independen dari database atau penyimpanan data backend.

Operasi

Perubahan apa pada Edge yang memerlukan mulai ulang Edge Microgateway?

Edge Microgateway otomatis melakukan polling untuk perubahan yang dilakukan di Apigee Edge, seperti perubahan pada proxy, produk, atau aplikasi developer yang mendukung microgateway. Interval polling default adalah 600 detik; tetapi, Anda dapat mengubah interval dengan setelan konfigurasi config_change_poll_interval. Lihat atribut edgemicro.

Jika Anda tidak ingin menunggu interval polling, gunakan perintah edgemicro reload untuk mengambil perubahan terbaru. Lihat Memuat ulang cluster microgateway.

Bagaimana cara membedakan antara proxy yang di-deploy di Edge vs. proxy di Edge Microgateway?

Saat Anda mengonfigurasi Edge Microgateway, daftar proxy berbasis microgateway yang di-deploy di Apigee Edge akan didownload ke konfigurasi lokal Edge Microgateway. Proxy yang mendukung microgateway adalah proxy yang diberi nama dengan awalan edgemicro_.

Apa saja opsi saya untuk logging dengan Edge Microgateway?

Edge Microgateway memiliki fitur logging bawaan. Untuk mengetahui detailnya, lihat Mengelola file log.

Anda juga dapat menulis plugin kustom untuk menggunakan layanan logging pihak ketiga dengan Edge Microgateway. Karena cara kerja Edge Microgateway, Anda tidak dapat menggunakan kebijakan Message Logging Apigee Edge untuk mencatat pesan ke dalam log untuk Edge Microgateway. Lihat juga artikel komunitas Plugin Logging untuk Microgateway.

Dapatkah saya menggunakan kembali kombinasi kunci/rahasia antara instance Edge Microgateway?

Selama organisasi dan lingkungannya sama untuk instance Microgateway, Anda dapat menggunakan kembali pasangan kunci/rahasia yang dihasilkan selama konfigurasi.

Bagaimana cara mengonfigurasi Edge Microgateway untuk memulai di lingkungan produksi?

Anda dapat menetapkan variabel lingkungan untuk parameter perintah startup, seperti EDGEMICRO_KEY, EDGEMICRO_SECRET, EDGEMICRO_ORG, dan EDGEMICRO_ENV. Dengan variabel ini (dan lainnya), Anda dapat memulai Edge Microgateway dengan satu perintah edgemicro start. Lihat juga Menetapkan variabel lingkungan.

Dapatkah saya menggunakan atribut aplikasi developer atau produk kustom dengan Edge Microgateway?

Tidak. Secara default, Edge Microgateway hanya bertindak pada atribut yang terkait dengan perutean dan keamanan dasar. Namun, sebagai solusinya, Anda memiliki opsi berikut:

1. Tambahkan atribut kustom ke proxy edgemicro-auth yang di-deploy Edge Microgateway ke Apigee Edge. Atribut ini akan tersedia saat menggunakan keamanan Kunci API atau token OAuth.
2. Ubah plugin OAuth agar bertindak berdasarkan atribut tersebut.

Apakah ada batas untuk ukuran header permintaan?

Jika Anda mengupgrade Node.js ke v8.14.0 atau versi yang lebih baru, perhatikan bahwa ukuran header maksimum yang diizinkan pada permintaan dikurangi dari 80 KB menjadi 8 KB. Header yang melebihi 8 KB akan menyebabkan error HTTP 431.

Opsi konfigurasi Node.js yang ditambahkan di Node.js v11.6.0 memungkinkan Anda mengubah ukuran header maksimum default. Parameter ini, --max-http-header-size, memungkinkan Anda menentukan ukuran maksimum, dalam byte, header HTTP.

Untuk mengubah konfigurasi default, tetapkan nilai variabel lingkungan NODE_OPTIONS pada command line sebagai berikut:

NODE_OPTIONS=--max-http-header-size=NUM_BYTES

Contoh:

NODE_OPTIONS=--max-http-header-size=80000

API pengelolaan apa yang digunakan Edge Microgateway?

Deployment

Dapatkah saya men-deploy Edge Microgateway di server yang sama tempat layanan target saya berjalan?

Ya. Edge Microgateway adalah proses ringan yang dapat berjalan dekat dengan layanan target Anda, termasuk di mesin yang sama.

Dapatkah saya men-deploy paket proxy Edge yang ada sebagai deployment Microgateway Edge?

Tidak. Proxy berbasis Microgateway Edge memiliki persyaratan khusus dan tidak mendukung semua fitur proxy Edge reguler. Lihat Bagian 2: Membuat entity di Apigee Edge

Dapatkah saya mengaktifkan failover antara deployment paket proxy Edge dan deployment Edge Microgateway untuk Proxy API yang sama?

Tidak. Edge Microgateway tidak mengetahui deployment proxy API non-microgateway di Apigee Edge.

Apa model deployment ketersediaan tinggi untuk Edge Microgateway?

Untuk diskusi yang baik tentang cara menjalankan Edge Microgateway menggunakan NGINX sebagai load balancer, lihat Mengelola API dengan Edge Microgateway Apigee dan NGINX.

Load balancer mana yang dapat saya gunakan dengan Edge Microgateway?

Edge Microgateway dapat berfungsi dengan load balancer apa pun.

Apakah ada batas jumlah proxy Edge Microgateway yang dapat saya deploy?

Lihat batas konfigurasi produk yang ditentukan untuk proxy Edge reguler. Jumlah proxy yang mendukung microgateway yang dapat Anda deploy di organisasi dan lingkungan Apigee Edge serta melakukan panggilan melalui Edge Microgateway harus sesuai dengan batas yang sama.

Dapatkah saya mengaitkan deployment Edge Microgateway ke organisasi dan lingkungan tertentu?

Saat mengonfigurasi instance Edge Microgateway, Anda harus mengaitkannya dengan organisasi dan lingkungan Edge tertentu.

Dapatkah saya mengaitkan deployment Edge Microgateway ke region tertentu (jika saya adalah pelanggan multi-region)?

Edge Microgateway secara otomatis memilih region terbaik untuk interaksinya dengan Apigee Edge. Anda dapat men-deploy instance Edge Microgateway di setiap region yang ingin Anda layani.

Administrasi

Apakah saya harus menjadi administrator organisasi untuk mengonfigurasi dan men-deploy Edge Microgateway?

Ya. Anda harus memiliki kredensial admin organisasi untuk mengonfigurasi dan men-deploy Edge Microgateway.

Apakah saya harus menjadi administrator organisasi untuk menjalankan Edge Microgateway?

Tidak. Edge Microgateway adalah aplikasi Node.js, dan dapat dijalankan oleh siapa saja yang memiliki izin untuk menjalankan aplikasi tersebut di mesin tertentu.

Dapatkah pengguna organisasi saya menggunakan Edge Microgateway?

Anda tidak perlu menjadi pengguna organisasi Apigee Edge untuk melakukan panggilan API melalui Edge Microgateway. Namun, Anda harus memiliki izin tingkat organisasi untuk membuat atau mengubah proxy yang mendukung Edge Microgateway yang di-deploy di Edge.

Performa

Apa pertimbangan performa untuk menggunakan Edge Microgateway?

Jika menjalankan Edge Microgateway yang ditempatkan bersama dengan aplikasi target, pastikan server memiliki kapasitas yang memadai.

Apa praktik terbaik untuk menjalankan Edge Microgateway dalam skala besar?

Apigee merekomendasikan untuk menjalankan beberapa instance Edge Microgateway di berbagai server yang didahului oleh load balancer seperti NGINX. Lihat juga Mengelola API dengan Apigee Edge Microgateway dan NGINX serta Penskalaan horizontal vertikal di Komunitas Apigee.

Apa TPS Edge Microgateway secara default dan apa persyaratan hardware yang diperlukan untuk instance Microgateway

Persyaratan hardware dan pengukuran TPS sulit diukur dengan Edge Microgateway. Hal ini bergantung pada penyiapan Anda, yang merupakan kombinasi dari penyesuaian Edge Microgateway, penggunaan plugin, plugin kustom, dan mengonfigurasi hal lain seperti TLS. Apigee biasanya merekomendasikan agar Anda mendapatkan gambaran tentang kombinasi item tersebut dan melakukan pengujian performa dengan penyiapan spesifik Anda.

Deployment Private Cloud

Apakah Edge Microgateway berfungsi dengan Edge untuk Private Cloud?

Ya. Untuk mengetahui detailnya, lihat Langkah-langkah konfigurasi Apigee Private Cloud.

Plugin

Bagaimana Kuota diterapkan dengan Edge Microgateway?

Secara opsional, Anda dapat menambahkan plugin kuota ke instance Edge Microgateway. Untuk mengetahui detailnya, lihat Menggunakan plugin kuota.

Bagaimana Spike Arrest ditegakkan dengan Edge Microgateway?

Secara opsional, Anda dapat menambahkan plugin spike arrest ke instance Edge Microgateway. Untuk mengetahui detailnya, lihat Menggunakan plugin penghentian lonjakan.

Apakah ada cara lain untuk menulis plugin selain Node.js untuk Edge Microgateway?

Tidak. Plugin harus ditulis dalam bahasa Node.js.

Apa yang terjadi jika Edge Microgateway tidak dapat mengupload data Analytics ke Edge?

Edge Microgateway memiliki buffering dalam memori. Jika buffer terisi, payload yang lebih lama akan dihapus agar traffic API dapat mengalir lancar.

Dapatkah saya menambahkan kebijakan ke Edge Microgateway?

Jika Anda melampirkan kebijakan Apigee Edge reguler ke proxy yang mendukung microgateway di Apigee Edge, kebijakan tersebut akan diabaikan. Sebagai gantinya, Edge Microgateway menggunakan plugin untuk menyediakan fungsi yang mirip dengan kebijakan di Edge, seperti kuota, penangkapan lonjakan, keamanan kunci API, dan keamanan OAuth2. Anda juga dapat menulis plugin kustom. Lihat Menggunakan plugin dan Mengembangkan plugin kustom.

Postingan dan blog Komunitas Apigee berikut membahas kasus penggunaan plugin tambahan:

• Cara mengganti URL default di Edge Microgateway
• Cara agar Kuota berfungsi di Edge Microgateway
• Menambahkan plugin logger ke Edge Microgateway

Keamanan

Bagaimana cara melindungi resource /products?

Ringkasan

Saat Anda mengonfigurasi Edge Microgateway, proxy API bernama edgemicro-auth akan di-deploy ke organisasi:lingkungan Anda di Apigee Edge. Proxy ini mengekspos endpoint /products yang menampilkan daftar Produk API. Jika Anda menginstal Edge Microgateway pada atau sebelum 5 Oktober 2018, Apigee merekomendasikan agar Anda mengambil langkah-langkah untuk melindungi endpoint ini, karena responsnya berisi alamat email developer yang membuat dan mengubah Produk API di organisasi Apigee Anda.

Anda dapat melindungi endpoint dengan mengupgrade Edge Microgateway atau dengan mengonfigurasi TLS Bersama. Kedua opsi ini dijelaskan di bawah.

Memeriksa apakah endpoint /products dilindungi

Jika Anda tidak yakin apakah endpoint /products dilindungi atau tidak, buka bagian Memverifikasi bahwa resource /products dilindungi dan lakukan langkah-langkah di sana sebelum melanjutkan.

Opsi 1: Mengupgrade Edge Microgateway

Jika Anda menginstal Edge Microgateway pada atau sebelum 5 Oktober 2018, Apigee merekomendasikan agar Anda mengupgrade ke Edge Microgateway versi terbaru. Ikuti langkah-langkah di Mengupgrade Edge Microgateway jika Anda memiliki koneksi internet.

Jika Anda tidak dapat melakukan upgrade saat ini, lanjutkan ke Opsi 2.

Opsi 2: Mengonfigurasi TLS Bersama

Jika saat ini Anda tidak dapat mengupgrade Edge Microgateway, Apigee menyarankan agar Anda melindungi komunikasi antara Edge Microgateway dan proxy edgemicro-auth dengan TLS bersama (juga dikenal sebagai TLS dua arah).

1. Buka file $HOME/.edgemicro/org-env-config.yaml. Lihat Lokasi penginstalan Edge Microgateway jika Anda tidak dapat menemukan file ini.
2. Tambahkan blok tlsOptions berikut ke file org-env-config.yaml untuk mengaktifkan TLS bersama antara Edge Microgateway dan Apigee Edge:

   edge_config:
     bootstrap: >-
       https://domain/edgemicro/bootstrap/organization/org/environment/env
     jwt_public_key: 'https://domain/edgemicro-auth/publicKey'
     managementUri: 'https://api.enterprise.apigee.com'
     tlsOptions:
       agentOptions:
         requestCert: true
         cert: 'path/to/cert'
         key: 'path/to/key'
   

   Contoh:

   tlsOptions:
     agentOptions:
       requestCert: true
       cert: '/Users/jdoe/twowayssl/ssl/client.key'
       key: '/Users/jdoe/twowayssl/ssl/ca.crt'

   Anda juga dapat menyertakan parameter agentOptions opsional berikut:

   • ca: Menentukan jalur ke otoritas sertifikasi.
   • pfx: Sertakan jika Anda ingin menggunakan file p12/pfx, bukan sertifikat dan kunci.
   • passphrase: Frasa sandi untuk file pfx.
   • ciphers: Menentukan cipher TLS.
3. Pastikan host virtual tempat proxy edgemicro-auth di-deploy telah mengaktifkan TLS bersama. Untuk mengetahui detailnya, lihat Menentukan host virtual untuk TLS dua arah dalam dokumentasi Apigee Edge.

   Screenshot berikut menunjukkan cara mengaktifkan TLS timbal balik di host virtual di UI Apigee Edge:

   
4. Lihat proxy API edgemicro-auth di UI Edge, dan pastikan host virtual yang benar ditentukan dalam konfigurasi proxy. Misalnya, jika Anda membuat host virtual yang mengaktifkan TLS bernama mutualtls, stanza HTTPProxyConnection proxy akan terlihat seperti ini:

   <HTTPProxyConnection>
       <BasePath>/edgemicro-auth</BasePath>
       <Properties/>
       <VirtualHost>mutualtls</VirtualHost>
   </HTTPProxyConnection>
   

curl -v https://your_domain/edgemicro-auth/products

{
  "error":"unauthorized",
  "error_description": "authentication failed"
}

curl: (35) error:1408F10B:SSL routines:ssl3_get_record:wrong version number

{
   "apiProduct":[
      {
         "apiResources":[
            "/",
            "/**"
         ],
         "approvalType":"auto",
         "attributes":[

         ],
         "createdAt":1537374680948,
         "createdBy":"jdoe@foo.com",
         "description":"",
         "displayName":"mock",
         "environments":[
            "test"
         ],
         "lastModifiedAt":1537374680948,
         "lastModifiedBy":"test@test.com",
         "name":"mock",
         "proxies":[
            "edgemicro-auth",
            "edgemicro_mock"
         ],
         "quota":"null",
         "quotaInterval":"null",
         "quotaTimeUnit":"null",
         "scopes":[
            ""
         ]
      }
   ]
}

curl -v http://your_domain/edgemicro-auth/products

Pengujian dan proses debug

Bagaimana cara mencegah error "terlalu banyak file terbuka" selama pengujian beban?

Dalam beberapa kasus, sistem Anda mungkin mengalami situasi dengan terlalu banyak koneksi file terbuka, dan hal ini dapat menyebabkan Edge Micro error. Logging default memerlukan dua koneksi HTTP untuk transaksi masuk dan keluar melalui Microgateway.

Untuk tujuan pengujian dan benchmark, Apigee merekomendasikan untuk menetapkan perintah ulimit sistem Anda ke unlimited: ulimit -n unlimited. Lihat juga Error Edge Microgateway selama pengujian beban di Komunitas Apigee.

Tips untuk pengembangan dan proses debug yang cepat

Jika Anda mengembangkan plugin untuk Edge Microgateway, Anda mungkin mendapati bahwa dukungan untuk pengembangan cepat terbatas.

Untuk saat ini, berikut beberapa tips:

• Untuk memulai Edge Microgateway, Anda dapat menetapkan variabel lingkungan EDGEMICRO_KEY dan EDGEMICRO_SECRET ke pasangan kunci/rahasia yang diperlukan oleh perintah startup Microgateway. Dengan begitu, Anda dapat memulai Edge Microgateway tanpa memasukkan kunci/secret di command line. Lihat juga Menetapkan variabel lingkungan di dokumen Edge Microgateway.
• Mulai Edge Microgateway dalam mode DEBUG untuk melihat output tambahan di terminal perintah: DEBUG=* edgemicro start -o [org] -e [env] -k [key] -s [secret]

Bisnis dan pemberian lisensi

Apa hubungan antara model dukungan Apigee-127 dan Edge Microgateway?

Apigee-127 adalah project software open source yang didukung dalam model open source. Artinya, Anda dapat melaporkan masalah di project GitHub dan membuat permintaan pull jika Anda mencoba memperbaiki sesuatu. Apigee-127 tidak mewajibkan atau menyertakan Perjanjian Lisensi Software dengan Apigee.

Di sisi lain, Edge Microgateway adalah produk Enterprise yang didukung oleh Apigee untuk pelanggan Apigee. Artinya, pelanggan Apigee dapat membuat tiket dukungan, permintaan fitur, dan laporan bug menggunakan Dukungan Apigee Edge Google Cloud.