Referensi CLI untuk Edge Microgateway

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

Edge Microgateway v. 3.3.x

Ringkasan

Edge Microgateway CLI memungkinkan Anda mengontrol dan mengelola semua aspek Edge Microgateway di instance Compute Engine.

Mengelola sertifikat

Perintah cert memungkinkan Anda menginstal dan mengelola pasangan kunci publik/pribadi yang digunakan untuk menandatangani token pembawa yang digunakan klien untuk melakukan panggilan aman melalui Edge Microgateway. Kunci disimpan di Apigee Edge dalam Key Value Map (KVM) terenkripsi. Edge Microgateway menggunakan kunci publik untuk memvalidasi token pembawa yang ditandatangani. Kunci-kunci ini dihasilkan saat Anda menjalankan edgemicro mengonfigurasi ulang, seperti yang dijelaskan dalam Menyiapkan dan mengonfigurasi Edge Microgateway. Anda dapat menggunakan perintah sertifikat yang dijelaskan di sini untuk membuat ulang dan mengelola kunci ini jika diperlukan.

Instal sertifikat

Menginstal kunci dalam Key Value Map (KVM) yang dienkripsi dan menampilkan kunci publik sebagai output. Pasangan kunci memiliki cakupan organisasi yang ditentukan.

Penggunaan

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-u, --username Nama pengguna Apigee Anda. Anda harus menjadi administrator org untuk organisasi/pengaturan.
-p, --password (Opsional) Sandi Anda. Anda akan diminta jika tidak memberikan parameter ini di baris perintah.
-f, --force (Opsional) Jika kunci sudah disimpan di KVM terenkripsi, paksa penggantinya.
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro cert install -o docs -e test -u jdoe@example.com -f

Output

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

Menghapus sertifikat

Menghapus pasangan kunci untuk organisasi.

Penggunaan

edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-u, --username Nama pengguna Apigee Anda. Anda harus menjadi administrator org untuk organisasi/pengaturan.
-p, --password (Opsional) Sandi Anda. Anda akan diminta jika tidak memberikan parameter ini di baris perintah.
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro cert delete -o docs -e test -u jdoe@example.com

Output

deleting vault
Vault deleted!

Periksa sertifikat

Memeriksa apakah organisasi Anda telah menginstal sertifikat.

Penggunaan

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-u, --username Nama pengguna Apigee Anda. Anda harus menjadi administrator org untuk organisasi/pengaturan.
-p, --password (Opsional) Sandi Anda. Anda akan diminta jika tidak memberikan parameter ini di baris perintah.
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro cert check -o docs -e test -u jdoe@example.com

Output (Berhasil)

checked cert successfully

Output (Kegagalan)

Jika sertifikat tidak ada, pesan error akan muncul.

Mendapatkan kunci publik

Menampilkan kunci publik untuk organisasi yang ditentukan. Tidak memerlukan autentikasi.

Penggunaan

edgemicro cert public-key -o [organization] -e [environment]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro cert public-key -o docs -e test

Output (Contoh)

-----BEGIN CERTIFICATE-----

MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD
VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD
ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+
L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4
jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL
0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7
zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4
RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe
2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe
UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o
6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF
xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy
Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY
x9gfPf1/+qo=?

-----END CERTIFICATE-----

Mengonfigurasi Edge Microgateway untuk Apigee Edge Cloud

Memungkinkan Edge Microgateway beroperasi dengan instance Apigee Edge Cloud. Proses ini menggabungkan dan melakukan urutan perintah untuk men-deploy proxy autentikasi yang diperlukan ke Edge, menghasilkan autentikasi token, dan mengupdate file konfigurasi. Untuk contoh kerja yang lengkap, lihat Menyiapkan dan mengonfigurasi Edge Microgateway.

Penggunaan

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-u, --username Nama pengguna Apigee Anda. Anda harus menjadi administrator org untuk organisasi/pengaturan.
-p, --password (Opsional) Sandi Anda. Anda akan diminta jika tidak memberikan parameter ini di baris perintah.
-r, --url (Opsional) Menentukan alias host virtual untuk organisasi:environment Anda. Lihat Dokumentasi Edge untuk mempelajari host virtual. Default: org-env.apigee.net
-c, --configDir (Opsional) Menentukan jalur ke file konfigurasi Edge Microgateway. Secara {i>default<i}, file konfigurasi ada di ./config/config.yaml. (Ditambahkan v2.4.x)
-x, --proxyName (Opsional) Menetapkan basepath untuk proxy edgemicro-auth. Jika Proxy edgemicro-auth di-deploy di jalur yang berbeda dari default, /edgemicro-auth, fitur ini memungkinkan Anda menetapkan jalur baru di Edge Microgateway. Secara default, jalur basisnya adalah /edgemicro-auth. (Ditambahkan v2.4.x)
-t, --token (Opsional) Memungkinkan Anda menggunakan token OAuth untuk autentikasi, bukan nama pengguna/sandi. Lihat juga Mengamankan panggilan API dengan token akses OAuth2. Contoh:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (Opsional) Mengganti {i>host<i} virtual default, yang "default,secure". Gunakan opsi ini jika Anda memiliki {i>host<i} virtual yang ditentukan untuk Organisasi Edge:lingkungan selain default ini. Lihat dokumentasi Edge untuk belajar tentang {i>host<i} virtual.
-d, --debug (Opsional) Memberikan informasi debug.
-h, --help Menampilkan informasi penggunaan.

Catatan penggunaan

Perintah ini menyimpan informasi konfigurasi di ~/.edgemicro/org-env-config.yaml.

Contoh

edgemicro configure -o docs -e test -u jdoe@example.com

Output

Setelah berhasil, perintah akan menampilkan serangkaian kunci yang perlu Anda gunakan saat memulai Edge Microgateway.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Membuat kunci

Perintah genkeys menghasilkan pasangan kunci dan rahasia yang digunakan oleh Edge Microgateway untuk mengautentikasi dirinya sendiri saat memposting data analisis secara asinkron ke Apigee Edge.

Penggunaan

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-u, --username Nama pengguna Apigee Anda. Anda harus menjadi administrator org untuk organisasi/pengaturan.
-p, --password (Opsional) Sandi Anda. Anda akan diminta jika tidak memberikan parameter ini di baris perintah.
-t, --token (Opsional) Memungkinkan Anda menggunakan token OAuth untuk autentikasi, bukan nama pengguna/sandi. Lihat juga Mengamankan panggilan API dengan token akses OAuth2. Contoh:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help Menampilkan informasi penggunaan.

Catatan penggunaan

Setelah berhasil, perintah akan menampilkan tiga item. Yang pertama adalah URL yang perlu Anda tempatkan file konfigurasi. Dua lainnya adalah pasangan kunci yang diperlukan saat Anda memulai Edge di instance Microgateway.

  • URL bootstrap: URL ini mengarah ke layanan Apigee Edge yang memungkinkan Instance Edge Microgateway untuk mengirim data analisis ke Apigee Edge. Anda harus menyalin URL tersebut ke dalam file konfigurasi Edge Microgateway: ~/.edgemicro/org-env-config.yaml.
  • key: Kunci. Kunci ini, dan rahasianya, diperlukan sebagai input untuk CLI yang digunakan untuk memulai instance Edge Microgateway.
  • rahasia: Rahasianya.

Contoh

edgemicro genkeys -o docs -e test -u jdoe@example.com

Output (Contoh)

Setelah berhasil, perintah akan menampilkan serangkaian kunci yang perlu Anda gunakan saat memulai Edge Microgateway.

configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1
Please copy the following property to the edge micro agent config
  bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test

The following credentials are required to start edge micro
  key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f
  secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae

finished

Mengonfigurasi Edge Microgateway untuk Apigee Edge Private Cloud

Mengonfigurasi Edge Microgateway agar berfungsi dengan penginstalan Apigee Edge Private Cloud.

Penggunaan

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-u, --username Nama pengguna Apigee Anda. Anda harus menjadi administrator org untuk organisasi/pengaturan.
-p, --password (Opsional) Sandi Anda. Anda akan diminta jika tidak memberikan parameter ini di baris perintah.
-r, --runtime-url Menentukan URL runtime untuk instance cloud pribadi Anda.
-m, --mgmt-url URL server pengelolaan untuk instance cloud pribadi Anda.
-v, --virtualHosts Daftar host virtual yang dipisahkan koma untuk organisasi:environment Anda. Default "default,secure".
-c, --configDir (Opsional) Menentukan jalur ke file konfigurasi Edge Microgateway. Secara {i>default<i}, file konfigurasi ada di ./config/config.yaml. (Ditambahkan v2.4.x)
-t, --token (Opsional) Memungkinkan Anda menggunakan token OAuth untuk autentikasi, bukan nama pengguna/sandi. Lihat juga Mengamankan panggilan API dengan token akses OAuth2. Contoh:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (Opsional) Memberikan informasi debug.
-h, --help Menampilkan informasi penggunaan.

Catatan penggunaan

Perintah ini menyimpan informasi konfigurasi di ~/.edgemicro/org-env-config.yaml.

Contoh

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080

Output

Setelah berhasil, perintah akan menampilkan serangkaian kunci yang perlu Anda gunakan saat memulai Edge Microgateway.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Memulai Edge Microgateway

Sebelum memulai Edge Microgateway, Anda harus menjalankan konfigurasi edgemicro terlebih dahulu (Cloud Publik) atau konfigurasi pribadi edgemicro (Private Cloud). Konfigurasi mengembalikan nilai kunci dan rahasia yang diperlukan untuk memulai Edge Microgateway.

Penggunaan

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-k, --key Nilai kunci yang ditampilkan dan ditampilkan saat Anda menjalankan "edgemicro configure" perintah.
-s, --secret Nilai rahasia yang ditampilkan dan ditampilkan saat Anda menjalankan "edgemicro configure" perintah.
-p, --processes (Opsional) Jumlah proses yang akan dimulai. Default: Jumlah core di sistem file.
-d, --pluginDir (Opsional) Jalur absolut ke direktori plugin.
-r, --port (Opsional) Ganti nomor port yang ditentukan di ~/.edgemicro/org-env-config.yaml file. Default: 8000
-c, --cluster

(Opsional) Memulai Edge Microgateway dalam mode cluster.

Catatan: Mulai v2.3.1, opsi ini telah dihapus. Di v2.3.1 dan versi yang lebih baru, Edge Micro selalu dimulai dalam mode cluster.
-c, --configDir (Opsional) Menentukan jalur ke file konfigurasi Edge Microgateway. Secara {i>default<i}, file konfigurasi ada di ./config/config.yaml. (Ditambahkan v2.4.x)
-u, --configUrl (Opsional) Menentukan endpoint tempat Edge Microgateway akan mendownload konfigurasinya . (Ditambahkan v2.5.x)
-d, --debug (Opsional) Memberikan informasi debug.
-h, --help Menampilkan informasi penggunaan.

Menyetel port

Perintah start memungkinkan Anda menentukan nomor port untuk menggantikan port yang ditentukan di file konfigurasi. Anda juga dapat menentukan nomor port menggunakan PORT variabel lingkungan. Contoh:

edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002

atau

export PORT=8002
edgemicro start -o org -e test -k key -s secret -p 2

Jika port sedang digunakan, Edge Microgateway akan menampilkan error.

Tentang pengelompokan

Edge Microgateway menggunakan Node.js modul cluster untuk mengaktifkan pengelompokan. Pengelompokan memungkinkan Edge Microgateway untuk mengambil keunggulan sistem multi-core. Untuk mengetahui detailnya, lihat dokumentasi Node.js ini.

Contoh

edgemicro start -o docs -e test -k abc123 -s xyz456

Contoh output:

...

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
info: jwk_public_keys download from null returned 200 undefined
info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK
info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK
info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK
PROCESS PID : 17991

Mengelola token

Perintah token memungkinkan Anda mendapatkan, mendekode, dan memverifikasi akses OAuth2 yang ditandatangani token kata. Lihat juga Amankan panggilan API dengan token akses OAuth2.

Mendekode token

Mendekode token pemilik yang ditandatangani dan dienkode ke JSON JWT (Java Web Token) teks biasa merepresentasinya. Token menyampaikan informasi tentang aplikasi developer Apigee Edge yang menyediakan kunci yang digunakan untuk membuat token, termasuk nama aplikasi, client_id, daftar produk, dan lainnya.

Penggunaan

edgemicro token decode -f [filename]

Parameter

Parameter Deskripsi
-f, --file Nama file yang berisi token JWT yang akan didekode.
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro token decode -f token.jwt

Output (Contoh)

{ header: { typ: 'JWT', alg: 'RS256' },

  payload:
   { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
     client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
     scopes: [],
     api_product_list: [ 'MicroTest' ],
     iat: 1436280566,
     exp: 1436282365 },
  signature: '' }

Membuat token

Menghasilkan token pemilik yang ditandatangani. Token memungkinkan aplikasi klien melakukan panggilan API yang diautentikasi ke Edge Microgateway. Token tersebut adalah JSON Web Token (JWT) yang mematuhi OAuth 2.0. Memerlukan memasukkan nilai Kunci Konsumen (ID klien) dan Rahasia Konsumen (rahasia klien) dari aplikasi developer di Apigee Edge. Lihat juga Amankan panggilan API dengan token akses OAuth2.

Penggunaan

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-1, --key Client-ID dari Aplikasi Developer yang terkait dengan Microgateway Anda {i>proxy<i}.
-s, --secret Rahasia Klien dari aplikasi Developer yang terkait dengan Microgateway-aware Anda {i>proxy<i}.
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz

Output (Contoh)

{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }

Anda juga dapat membuat JWT menggunakan API pengelolaan:

curl -i -X POST "http://$ORG-$ENV.apigee.net/edgemicro-auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "$CLIENT_ID": "your consumer key",
    "$CLIENT_SECRET": "your consumer secret",
    "grant_type": "client_credentials"
  }'

Dengan keterangan:

  • $ORG adalah nama organisasi Edge Anda (Anda harus menjadi administrator org).
  • $ENV adalah lingkungan di organisasi Anda (seperti "test" atau "prod").
  • $CLIENT_ID adalah ID Konsumen di Aplikasi Developer yang Anda buat sebelumnya.
  • $CLIENT_SECRET adalah Rahasia Konsumen di Aplikasi Developer yang Anda buat seperti yang telah dibahas sebelumnya.

Memverifikasi token

Memverifikasi token pemilik yang ditandatangani terhadap kunci publik yang disimpan di Apigee Edge untuk organisasi dan lingkungan.

Penggunaan

edgemicro token verify -o [org] -e [env] -f [filename]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-f, --file Nama file yang berisi JWT yang akan diverifikasi.
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro token get -o docs -e test -f token.jwt

Contoh output untuk token yang valid

{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Contoh output untuk token yang tidak valid

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

Contoh output untuk token yang sudah tidak berlaku

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

Melakukan inisialisasi konfigurasi Edge Microgateway baru

Jalankan perintah ini satu kali setelah Anda menginstal Edge Microgateway untuk pertama kalinya. Membuat default baru file konfigurasi: ~/.edgemicro/default.yaml.

Penggunaan

edgemicro init

Parameter

Parameter Deskripsi
-c, --configDir (Opsional) Menentukan jalur ke file konfigurasi Edge Microgateway. Secara {i>default<i}, file konfigurasi ada di ./config/config.yaml. (Ditambahkan v2.4.x)
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro init

Output (Berhasil)

config initialized to /MyHome/.edgemicro/default.yaml

Memverifikasi konfigurasi Microgateway Edge

Memverifikasi bahwa Edge Microgateway dikonfigurasi dengan benar.

Penggunaan

edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]

Parameter

Contoh

edgemicro verify -o docs -e test -k abc123 -s xyz456

Output (Berhasil)

logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988
installed plugin from analytics
installed plugin from oauth
a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000
verifying analytics negative case: OK
verifying bootstrap url availability:OK
verifying jwt_public_key availability: OK
verifying products availability: OK
verifying quota with configured products: OK
verifying analytics with payload: OK
verification complete

Memeriksa status cluster microgateway

Secara default, Edge Microgateway dimulai dalam mode cluster. Anda dapat menggunakan perintah ini untuk memeriksa untuk menentukan status cluster.

Penggunaan

edgemicro status

Parameter

Parameter Deskripsi
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro status

Output (Berhasil)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
edgemicro is running with 8 workers

Menghentikan gugus microgateway

Menghentikan cluster Edge Microgateway.

Penggunaan

edgemicro stop

Parameter

Parameter Deskripsi
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro stop

Output (Berhasil)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
Stop Completed Successfully

Memuat ulang cluster microgateway

Menyediakan mulai ulang tanpa periode nonaktif setelah perubahan konfigurasi. Memuat ulang Edge Microgateway dengan menarik konfigurasi baru.

Penggunaan

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-k, --key Nilai kunci yang ditampilkan dan ditampilkan saat Anda menjalankan "edgemicro configure" perintah.
-s, --secret Nilai rahasia yang ditampilkan dan ditampilkan saat Anda menjalankan "edgemicro configure" perintah.
-h, --help Menampilkan informasi penggunaan.

Contoh

edgemicro reload -o docs -e test -k abc123 -s xyz456

Output (Berhasil)

...

Reload Completed Successfully

Mengupgrade proxy edgemicro-auth

Untuk menggunakan rotasi kunci, Anda harus mengupgrade Proxy edgemicro-auth yang di-deploy di organisasi Apigee Edge Anda. (Ditambahkan v2.5.x)

Catatan: Jika Anda mengonfigurasi instance Edge Micro saat ini sebelum versi 2.5.2, Anda harus meng-upgrade proxy ini jika Anda ingin menggunakan rotasi kunci. Anda hanya perlu melakukan {i>upgrade <i}ini sekali.

Penggunaan

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-u, --username Nama pengguna Apigee Anda. Anda harus menjadi administrator org untuk organisasi/pengaturan.
-p, --password (Opsional) Sandi Anda. Anda akan diminta jika tidak memberikan parameter ini di baris perintah.
-v, --virtualhost (Opsional) Host virtual proxy.
-b, --baseuri (Opsional) URI dasar untuk organisasi Anda di Apigee Edge. Defaultnya adalah lapisan URI untuk deployment cloud Apigee adalah api.enterprise.apigee.com. Untuk deployment lokal, URL dasarnya mungkin berbeda.

Contoh

edgemicro upgradeauth -o docs -e test -u jdoe@example.com

Output (Berhasil)

Setelah berhasil, perintah akan menampilkan output yang mirip dengan berikut ini:

Going to create revision 2 of API edgemicro-auth
Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file
Creating revision 2 of API edgemicro-auth
Uploading java resource micro-gateway-products-javacallout-2.0.0.jar
Uploading jsc resource generate-verify-jwt.js
Uploading jsc resource send-public-key.js
Uploading jsc resource set-jwt-variables.js
Uploading jsc resource set-response.js
Uploading node resource index.js
Uploading node resource node_modules_apigee-access.zip
Uploading node resource node_modules_base64url.zip
Uploading node resource node_modules_buffer-equal-constant-time.zip
Uploading node resource node_modules_ecdsa-sig-formatter.zip
Uploading node resource node_modules_jsrsasign.zip
Uploading node resource node_modules_jwa.zip
Uploading node resource node_modules_jws.zip
Uploading node resource node_modules_safe-buffer.zip
Uploading node resource package.json
Uploading policy Access-App-Info-2.xml
Uploading policy Access-App-Info.xml
Uploading policy AccessTokenRequest.xml
Uploading policy Add-Custom-Claims.xml
Uploading policy Create-OAuth-Request.xml
Uploading policy Create-Refresh-Request.xml
Uploading policy Extract-API-Key.xml
Uploading policy Extract-OAuth-Params.xml
Uploading policy Extract-Refresh-Params.xml
Uploading policy Get-Private-Key.xml
Uploading policy Get-Public-Key.xml
Uploading policy Get-Public-Keys.xml
Uploading policy JavaCallout.xml
Uploading policy Products-to-JSON-2.xml
Uploading policy Products-to-JSON.xml
Uploading policy Raise-Fault-Unknown-Request.xml
Uploading policy RefreshAccessToken.xml
Uploading policy Send-Public-Key.xml
Uploading policy Set-JWT-Variables.xml
Uploading policy Set-Response.xml
Uploading policy Verify-API-Key.xml
Uploading target TargetEndpoint-1
Uploading proxy default
Deploying revision 2 of edgemicro-auth to test
Deployment on test successful
edgemicro-auth proxy upgraded

Upgrade Peta Nilai Kunci (KVM)

Gunakan perintah edgemicro upgradekvm untuk mengupgrade KVM di Apigee organisasi/pengaturan. Upgrade KVM diperlukan jika Anda ingin menggunakan rotasi kunci.

Penggunaan

Edge untuk Cloud Publik: 

edgemicro upgradekvm -o [organization] -e [environment] -k [key] -s [secret]

Edge untuk Private Cloud: 

edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'

Parameter

Parameter Deskripsi
-o, --org Organisasi Apigee yang Anda konfigurasikan Edge Microgateway.
-e, --env Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-k, --key Nilai kunci yang ditampilkan dan ditampilkan saat Anda menjalankan "edgemicro configure" perintah.
-s, --secret Nilai rahasia yang ditampilkan dan ditampilkan saat Anda menjalankan "edgemicro configure" perintah.
-p, --proxyuri URI untuk proxy edgemicro_auth

Edge Public Cloud: Opsional.
Edge Private Cloud: Wajib.

Contoh Edge Public Cloud: 

 -p 'https://[org]-[env].apigee.net/edgemicro-auth'

Contoh Edge Private Cloud: 

-p 'https://[hostname]/edgemicro-auth'

Contoh

edgemicro upgradekvm -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Output (Berhasil)

Setelah berhasil, perintah akan menampilkan output yang mirip dengan berikut ini:

current nodejs version is v12.5.0
current edgemicro version is 3.1.5
password:
Checking for certificate...
Certificate found!
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv
Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq
z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ
3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB
Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1
HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5
WQIDAQAB
-----END PUBLIC KEY-----
KVM update complete

Rotasi kunci

Gunakan perintah edgemicro rotatekey untuk merotasi pasangan kunci publik/pribadi yang digunakan untuk menghasilkan token JWT yang digunakan untuk keamanan OAuth di Edge Microgateway.

Untuk mempelajari lebih lanjut, lihat Memutar kunci JWT.

Penggunaan

Edge untuk Cloud Publik: 

edgemicro rotatekey -o [organization] -e [environment] -k [key] -s [secret]

Edge untuk Private Cloud: 

edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'

Parameter

Parameter Deskripsi
-o, --org (Wajib) Organisasi Apigee tempat Anda mengonfigurasi Edge Microgateway.
-e, --env (Wajib) Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-k, --key Nilai kunci yang ditampilkan dan ditampilkan saat Anda menjalankan "edgemicro configure" perintah.
-s, --secret Nilai rahasia yang ditampilkan dan ditampilkan saat Anda menjalankan "edgemicro configure" perintah.
-p Jalur ke kunci pribadi kustom yang akan digunakan oleh Apigee Edge. (Ditambahkan 3.1.6)
-c Jalur ke sertifikat khusus yang akan digunakan oleh Apigee Edge. (Ditambahkan 3.1.6)
-n, --nbf

Konfigurasi penundaan dalam menit agar kunci pribadi baru menjadi efektif. Ini memungkinkan waktu bagi instance microgateway untuk dimuat ulang dengan tombol. Sebaiknya tetapkan penundaan menjadi lebih dari setelan konfigurasi config_change_poll_internal, yaitu 10 menit secara {i>default<i}. Untuk informasi selengkapnya, lihat Mengonfigurasi "not before" tertunda. (Ditambahkan 3.1.6)

Catatan: Jika Anda menggunakan opsi ini dengan versi edgemicro-auth yang lebih lama dari versi yang didistribusikan dengan Edge Microgateway 3.1.6, flag diabaikan.

-i, --kid (Opsional) ID yang digunakan untuk mencocokkan kunci tertentu. Edge Microgateway menggunakan nilai ini untuk memilih di antara set kunci selama rotasi kunci. Jika parameter ini dihilangkan (direkomendasikan), Edge Microgateway menghasilkan kunci berbasis stempel waktu. Untuk informasi selengkapnya, lihat Bagian 4.5 dari spesifikasi Kunci Web JSON.
-r, --rotatekeyuri Merotasi URI kunci.

Edge Public Cloud: Opsional.
Edge Private Cloud: Wajib.

Contoh Public Cloud: 

-r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey'

Contoh Edge Private Cloud: 

-r '[hostname]/edgemicro-auth/rotateKey'

Contoh

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Output (Berhasil)

Setelah berhasil, perintah akan menampilkan output yang mirip dengan berikut ini:

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
Checking if private key exists in the KVM...
Checking for certificate...
Found Certificate
Generating New key/cert pair...
Extract new public key
Key Rotation successfully completed!

Setelah rotasi, Anda dapat melihat di UI Edge bahwa kunci baru telah ditambahkan ke microgateway dan konfigurasi VM.

Contoh

Contoh ini menggunakan flag -p dan -c untuk menentukan jalur ke pasangan kunci/sertifikat pribadi. Opsi ini memungkinkan Anda meneruskan kunci pribadi dan sertifikat kustom berpasangan. 

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \
-p /users/home/keys.pem -c /users/home/cert.cert

Pemantauan selamanya

Cabut kunci

Gunakan perintah edgemicro revokekeys untuk mencabut kredensial kunci dan kredensial rahasia untuk Konfigurasi Edge Microgateway.

Penggunaan

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

Parameter

Parameter Deskripsi
-o, --org (Wajib) Organisasi Apigee tempat Anda mengonfigurasi Edge Microgateway.
-e, --env (Wajib) Lingkungan tempat Anda mengonfigurasi Edge Microgateway.
-u, --username (-u atau -t wajib diisi) Nama pengguna Apigee Anda. Anda harus menjadi administrator org untuk organisasi/pengaturan. Parameter ini tidak diperlukan jika Anda menentukan parameter -t.
-p, --password (Opsional) Sandi Anda. Anda akan diminta jika tidak memberikan parameter ini di baris perintah.
-k, --key (Wajib) Kunci yang akan dicabut.
-s, --secret (Wajib) Rahasia yang akan dicabut.
-t, --token (-u atau -t wajib diisi) Memungkinkan Anda menggunakan token OAuth untuk autentikasi, bukan nama pengguna/sandi. Jika -t ditentukan, parameter -u tidak diperlukan. Lihat juga Mengamankan panggilan API dengan token akses OAuth2. Contoh: 
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

Contoh

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

Jika berhasil, Anda akan melihat pesan berikut:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully