Edge Mikro Ağ Geçidi için CLI referansı

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin.
bilgi

Edge Microgateway v. 3.3.x

Genel bakış

Edge Microgateway CLI, bir Edge Microgateway örneğinin tüm özelliklerini kontrol etmenizi ve yönetmenizi sağlar.

Sertifikaları yönetme

cert komutları, Edge Microgateway üzerinden güvenli çağrılar yapmak için istemciler tarafından kullanılan taşıyıcı jetonlarını imzalamak için kullanılan genel/özel anahtar çiftini yükleyip yönetmenizi sağlar. Anahtarlar, Apigee Edge'de şifrelenmiş bir Anahtar/Değer Eşlemesi (KVM) içinde saklanır. Edge Microgateway, imzalı hamiline ait jetonları doğrulamak için ortak anahtarı kullanır. Bu anahtarlar, Edge Mikro Ağ Geçidi'ni kurma ve yapılandırma bölümünde açıklandığı gibi, Edgemicro yapılandırması komutunu çalıştırdığınızda oluşturulur. Gerekirse bu anahtarları yeniden oluşturmak ve yönetmek için burada açıklanan cert komutlarını kullanabilirsiniz.

Sertifika yükle

Anahtarları şifrelenmiş bir Anahtar/Değer Eşlemesi'ne (KVM) yükler ve ortak anahtarı çıkış olarak döndürür. Anahtar çiftleri, belirtilen bir kuruluşun kapsamına alınır.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kuruluş için bir kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında girmezseniz istenir.
-f, --force (İsteğe bağlı) Şifrelenmiş KVM'de depolanan bir anahtarın değiştirilmesini zorunlu kılın.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış

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

Sertifika silme

Kuruluşun anahtar çiftini siler.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kuruluş için bir kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında girmezseniz istenir.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış

deleting vault
Vault deleted!

Sertifikaları kontrol etme

Kuruluşunuzda bir sertifika yüklü olup olmadığını kontrol eder.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kuruluş için bir kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında girmezseniz istenir.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış (Başarılı)

checked cert successfully

Çıkış (Hata)

Sertifika yoksa bir hata döndürülür.

Ortak anahtarı alma

Belirtilen kuruluş için ortak anahtarı döndürür. Kimlik doğrulama gerektirmez.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro cert public-key -o docs -e test

Çıkış (Örnek)

-----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-----

Apigee Edge Cloud için Edge Mikro ağ geçidini yapılandırma

Edge Microgateway'in Apigee Edge Cloud örneğiyle çalışmasını sağlar. Bu API, gerekli kimlik doğrulama proxy'sini Edge'e dağıtmak, kimlik doğrulama jetonları oluşturmak ve yapılandırma dosyalarını güncellemek için bir dizi komutu sarmalar ve yürütür. Tam bir çalışan örnek için Edge Mikro Ağ Geçidi'ni kurma ve yapılandırma sayfasına bakın.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kuruluş için bir kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında girmezseniz istenir.
-r, --url (İsteğe bağlı) Kuruluşunuz için sanal ana makine takma adını belirtir. Sanal ana makineler hakkında bilgi edinmek için Edge belgelerine bakın. Varsayılan: org-env.apigee.net
-c, --configDir (İsteğe bağlı) Edge Microgateway yapılandırma dosyasının yolunu belirtir. Yapılandırma dosyası varsayılan olarak ./config/config.yaml dizinindedir. (Sürüm 2.4.x eklendi)
-x, --proxyName (İsteğe bağlı) edgemicro-auth proxy'si için temel yolu ayarlar. edgemicro-auth proxy'si, varsayılan /edgemicro-auth yönteminden farklı bir yol altında dağıtıldıysa bu özellik, Edge Mikro Ağ Geçidi'nde yeni yolu ayarlamanıza olanak tanır. Varsayılan olarak temel yol /edgemicro-auth olur. (v2.4.x eklendi)
-t, --token (İsteğe bağlı) Kimlik doğrulama için kullanıcı adı/şifre yerine OAuth jetonu kullanmanıza olanak tanır. OAuth2 erişim jetonuyla güvenli API çağrıları başlıklı makaleyi de inceleyin. Örneğin:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (İsteğe bağlı) "default,secure" olan varsayılan sanal ana makineleri geçersiz kılar. Edge kuruluşunuz için bu varsayılanların dışında ortam için sanal ana makine belirttiyseniz bu seçeneği kullanın. Sanal ana makineler hakkında bilgi edinmek için Edge belgelerine bakın.
-d, --debug (İsteğe bağlı) Hata ayıklama bilgileri sağlar.
-h, --help Çıkış kullanım bilgileri.

Kullanım notları

Bu komut, yapılandırma bilgilerini ~/.edgemicro/org-env-config.yaml içinde depolar.

Örnek

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

Çıkış

Başarılı olduğunda, komut, Edge Mikro Ağ Geçidi'ni başlattığınızda kullanmanız gereken bir anahtar grubu döndürür.

...

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

edgemicro configuration complete!

Anahtarlar oluşturuluyor

genkeys komutu, Edge Microgateway tarafından kullanılan analiz verilerini Apigee Edge'e eşzamansız olarak gönderirken kendi kimliğini doğrulamak için kullanılan bir anahtar ve gizli anahtar çifti oluşturur.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kuruluş için bir kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında girmezseniz istenir.
-t, --token (İsteğe bağlı) Kimlik doğrulama için kullanıcı adı/şifre yerine OAuth jetonu kullanmanıza olanak tanır. OAuth2 erişim jetonuyla güvenli API çağrıları başlıklı makaleyi de inceleyin. Örneğin:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help Çıkış kullanım bilgileri.

Kullanım notları

Başarılı olduğunda komut üç öğe döndürür. Bunlardan ilki, yapılandırma dosyasına yerleştirmeniz gereken bir URL'dir. Diğer ikisi, Edge Microgateway örneğini başlattığınızda gerekli olan anahtar çiftidir.

  • bootstrap URL'si: Bu URL, Edge Microgateway örneğinin Apigee Edge'e analiz verileri göndermesini sağlayan Apigee Edge hizmetini işaret eder. Bu URL'yi Edge Microgateway yapılandırma dosyasına kopyalamanız gerekiyor: ~/.edgemicro/org-env-config.yaml.
  • anahtar: Anahtar. Bu anahtar ve gizli anahtar, Edge Microgateway örneğini başlatmak için kullanılan CLI komutuna giriş olarak gereklidir.
  • gizli: Gizli bilgi.

Örnek

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

Çıkış (Örnek)

Başarılı olduğunda, komut, Edge Mikro Ağ Geçidi'ni başlattığınızda kullanmanız gereken bir anahtar grubu döndürür.

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

Apigee Edge Private Cloud için Edge Mikro Ağ Geçidi'ni yapılandırma

Edge Microgateway'i Apigee Edge Private Cloud kurulumuyla çalışacak şekilde yapılandırır.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kuruluş için bir kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında girmezseniz istenir.
-r, --runtime-url Özel bulut örneğinizin çalışma zamanı URL'sini belirtir.
-m, --mgmt-url Özel bulut örneğinizin yönetim sunucusunun URL'si.
-v, --virtualHosts Kuruluşunuz için ortam için virgülle ayrılmış sanal ana makine listesi. Varsayılan "default,secure".
-c, --configDir (İsteğe bağlı) Edge Microgateway yapılandırma dosyasının yolunu belirtir. Yapılandırma dosyası varsayılan olarak ./config/config.yaml dizinindedir. (Sürüm 2.4.x eklendi)
-t, --token (İsteğe bağlı) Kimlik doğrulama için kullanıcı adı/şifre yerine OAuth jetonu kullanmanıza olanak tanır. OAuth2 erişim jetonuyla güvenli API çağrıları başlıklı makaleyi de inceleyin. Örneğin:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (İsteğe bağlı) Hata ayıklama bilgileri sağlar.
-h, --help Çıkış kullanım bilgileri.

Kullanım notları

Bu komut, yapılandırma bilgilerini ~/.edgemicro/org-env-config.yaml içinde depolar.

Örnek

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

Çıkış

Başarılı olduğunda, komut, Edge Mikro Ağ Geçidi'ni başlattığınızda kullanmanız gereken bir anahtar grubu döndürür.

...

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

edgemicro configuration complete!

Edge Mikro Ağ Geçidini Başlatma

Edge Mikro Ağ Geçidi'ni başlatmadan önce ilk olarak edgemicro yapılandırma (Herkese Açık Bulut) veya edgemicro özel yapılandırmayı (Private Cloud) çalıştırmanız gerekir. Yapılandır komutu, Edge Mikro Ağ Geçidi'ni başlatmak için gereken anahtar ve gizli anahtar değerlerini döndürür.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-k, --key "edgemicro configure" komutunu çalıştırdığınızda döndürülen anahtar değeri.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri.
-p, --processes (İsteğe bağlı) Başlatılacak işlem sayısı. Varsayılan: Sisteminizdeki çekirdek sayısıdır.
-d, --pluginDir (İsteğe bağlı) Eklenti dizinine giden mutlak yol.
-r, --port (İsteğe bağlı) ~/.edgemicro/org-env-config.yaml dosyasında belirtilen bağlantı noktası numarasını geçersiz kılar. Varsayılan: 8000
-c, --cluster

(İsteğe bağlı) Küme modunda Edge Mikro Ağ Geçidi'ni başlatır.

Not: 2.3.1 sürümü itibarıyla bu seçenek kaldırılmıştır. Edge 2, 2.3.1 ve sonraki sürümlerde her zaman küme modunda başlar.

-c, --configDir (İsteğe bağlı) Edge Microgateway yapılandırma dosyasının yolunu belirtir. Yapılandırma dosyası varsayılan olarak ./config/config.yaml dizinindedir. (Sürüm 2.4.x eklendi)
-u, --configUrl (İsteğe bağlı) Edge Microgateway'in yapılandırma dosyasını indireceği bir uç nokta belirtir. (Sürüm 2.5.x eklendi)
-d, --debug (İsteğe bağlı) Hata ayıklama bilgileri sağlar.
-h, --help Çıkış kullanım bilgileri.

Bağlantı noktasını ayarlama

start komutu, yapılandırma dosyasında belirtilen bağlantı noktasını geçersiz kılmak için bir bağlantı noktası numarası belirtmenize olanak tanır. PORT ortam değişkenini kullanarak da bir bağlantı noktası numarası belirtebilirsiniz. Örneğin:

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

veya

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

Bağlantı noktası kullanılıyorsa Edge Microgateway bir hata döndürür.

Kümeleme hakkında

Edge Microgateway, kümelemeyi etkinleştirmek için Node.js küme modülünü kullanır. Kümeleme, Edge Microgateway'in çok çekirdekli sistemlerden yararlanmasını sağlar. Ayrıntılar için bu Node.js dokümanlarına bakın.

Örnek

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

Örnek çıktı:

...

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

Jetonları yönetme

token komutları, imzalı OAuth2 erişim jetonları almanızı, kodunu çözmenizi ve doğrulamanızı sağlar. OAuth2 erişim jetonuyla güvenli API çağrıları başlıklı makaleyi de inceleyin.

Jetonun kodunu çözme

İmzalı ve kodlanmış bir hamiline ait jetonun kodunu düz metin JSON JWT (Java Web Token) gösterimine çözer. Jeton; uygulama adı, client_id, ürün listesi ve daha fazlası dahil olmak üzere jetonu oluşturmak için kullanılan anahtarları sağlayan Apigee Edge geliştirici uygulaması hakkında bilgi verir.

Kullanım

edgemicro token decode -f [filename]

Parametreler

Parametreler Açıklama
-f, --file Kodu çözülecek JWT jetonunu içeren dosyanın adı.
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro token decode -f token.jwt

Çıkış (Örnek)

{ 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: '' }

Jeton oluştur

İmzalanmış bir hamiline ait jeton oluşturur. Bu jeton, istemci uygulamalarının Edge Microgateway'e kimliği doğrulanmış API çağrıları yapmasına olanak tanır. Bu jeton, OAuth 2.0 uyumlu bir JSON Web Jetonu (JWT) olmalıdır. Bunun için Apigee Edge'deki kayıtlı bir geliştirici uygulamasından Tüketici Anahtarı (istemci kimliği) ve Tüketici Sırrı (istemci gizli anahtarı) değerlerinin girilmesini gerektirir. OAuth2 erişim jetonuyla güvenli API çağrıları başlıklı makaleyi de inceleyin.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-1, --key Microgateway uyumlu proxy'nizle ilişkilendirilmiş Geliştirici Uygulaması'na ait İstemci Kimliği.
-s, --secret Microgateway uyumlu proxy'nizle ilişkili, Geliştirici uygulamasından alınan İstemci Sırrı.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış (Örnek)

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

Yönetim API'sini kullanarak da JWT oluşturabilirsiniz:

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"
  }'

Burada:

  • $ORG, Edge kuruluşunuzun adıdır (kuruluş yöneticisi olmanız gerekir).
  • $ENV, kuruluşunuzdaki bir ortamdır (ör. "test" veya "prod").
  • $CLIENT_ID, daha önce oluşturduğunuz Geliştirici Uygulaması'ndaki tüketici kimliğidir.
  • $CLIENT_SECRET, daha önce oluşturduğunuz Geliştirici Uygulamasındaki Tüketici Sırrı'dır.

Jetonu doğrulama

İmzalanmış bir hamiline ait jetonu, belirtilen kuruluş ve ortam için Apigee Edge'de depolanan ortak anahtarla karşılaştırarak doğrular.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-f, --file Doğrulanacak JWT'yi içeren dosyanın adı.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Geçerli jeton için örnek çıkış

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

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Geçersiz jeton için örnek çıkış

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

Süresi dolmuş jeton için örnek çıkış

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

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

Yeni bir Edge Mikro Ağ Geçidi yapılandırmasını başlatma

Edge Microgateway'i ilk kez yükledikten sonra bu komutu bir kez çalıştırın. Yeni bir varsayılan yapılandırma dosyası oluşturur: ~/.edgemicro/default.yaml.

Kullanım

edgemicro init

Parametreler

Parametreler Açıklama
-c, --configDir (İsteğe bağlı) Edge Microgateway yapılandırma dosyasının yolunu belirtir. Yapılandırma dosyası varsayılan olarak ./config/config.yaml dizinindedir. (Sürüm 2.4.x eklendi)
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro init

Çıkış (Başarılı)

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

Edge Mikro Ağ Geçidi yapılandırmasını doğrulama

Edge Mikro Ağ Geçidi'nin düzgün şekilde yapılandırıldığını doğrular.

Kullanım

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

Parametreler

Örnek

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

Çıkış (Başarılı)

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

Mikro ağ geçidi küme durumunu kontrol etme

Edge Mikro Ağ Geçidi varsayılan olarak küme modunda başlar. Kümenin durumunu kontrol etmek için bu komutu kullanabilirsiniz.

Kullanım

edgemicro status

Parametreler

Parametreler Açıklama
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro status

Çıkış (Başarılı)

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

Mikro ağ geçidi kümesini durdurma

Edge Microgateway kümesini durdurur.

Kullanım

edgemicro stop

Parametreler

Parametreler Açıklama
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro stop

Çıkış (Başarılı)

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

Mikro ağ geçidi kümesini yeniden yükleme

Yapılandırma değişikliğinden sonra kesinti süresi olmadan yeniden başlatma sağlar. Yeni bir yapılandırma çekerek Edge Mikro Ağ Geçidi'ni yeniden yükler.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-k, --key "edgemicro configure" komutunu çalıştırdığınızda döndürülen anahtar değeri.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış (Başarılı)

...

Reload Completed Successfully

Uç mikro kimlik doğrulama proxy'sini yeni sürüme geçirme

Anahtar rotasyonunu kullanmak için Apigee Edge kuruluşunuzda dağıtılmış bir uç mikro kimlik doğrulama proxy'sine sahip olmanız gerekir. (Sürüm 2.5.x eklendi)

Not: Mevcut Edge Micro örneğinizi 2.5.2 sürümünden önce yapılandırdıysanız anahtar rotasyonunu kullanmak istiyorsanız bu proxy'yi yükseltmeniz gerekir. Bu yükseltme işlemini yalnızca bir kez yapmanız gerekir.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kuruluş için bir kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında girmezseniz istenir.
-v, --virtualhost (İsteğe bağlı) Proxy'nin sanal ana makinesi.
-b, --baseuri (İsteğe bağlı) Apigee Edge'de kuruluşunuzun temel URI'si. Apigee bulut dağıtımları için varsayılan URI, api.enterprise.Apigee.com şeklindedir. Şirket içi dağıtımlar için temel URL farklı olabilir.

Örnek

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

Çıkış (Başarılı)

Başarılı olduğunda, komut aşağıdakine benzer bir çıkış döndürür:

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

Anahtar/Değer Eşlemesi (KVM) yükseltmesi

Apigee kuruluşunuzdaki KVM'yi yükseltmek için edgemicro upgradekvm komutunu kullanın. Anahtar rotasyonu kullanmak istiyorsanız KVM'nin yeni sürüme geçirilmesi gerekir.

Kullanım

Herkese Açık Bulut İçin Edge:

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

Private Cloud için Edge:

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-k, --key "edgemicro configure" komutunu çalıştırdığınızda döndürülen anahtar değeri.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri.
-p, --proxyuri edgemicro_auth proxy'sinin URI'si

Edge Herkese Açık Bulut: İsteğe bağlı.
Edge Private Cloud: Zorunlu.

Edge Herkese Açık Bulut örneği:

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

Edge Private Cloud örneği:

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

Örnek

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

Çıkış (Başarılı)

Başarılı olduğunda, komut aşağıdakine benzer bir çıkış döndürür:

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

Anahtar rotasyonu

Edge Mikro Ağ Geçidi'nde OAuth güvenliği amacıyla kullanılan JWT jetonlarını oluşturmak için kullanılan ortak/özel anahtar çiftlerini döndürmek için edgemicro rotatekey komutunu kullanın.

Daha fazla bilgi için JWT anahtarlarını döndürme bölümüne bakın.

Kullanım

Herkese Açık Bulut İçin Edge:

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

Private Cloud için Edge:

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

Parametreler

Parametreler Açıklama
-o, --org (Zorunlu) Edge Mikro Ağ Geçidi'ni yapılandırdığınız Apigee kuruluşu.
-e, --env (Gerekli) Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-k, --key "edgemicro configure" komutunu çalıştırdığınızda döndürülen anahtar değeri.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri.
-p Apigee Edge tarafından kullanılacak özel anahtarın yolu. (Ek 3.1.6)
-c Apigee Edge tarafından kullanılacak özel sertifika yolu. (Ek 3.1.6)
-n, --nbf

Yeni bir özel anahtarın geçerlilik kazanması için gereken gecikmeyi dakika cinsinden yapılandırın. Bu gecikme, mikro ağ geçidi örneklerinin yeni ortak anahtarla yenilenmesi için zaman sağlar. Gecikmeyi varsayılan olarak 10 dakika olan config_change_poll_internal yapılandırma ayarından daha fazla olacak şekilde ayarlamak iyi bir uygulamadır. Daha fazla bilgi için "Daha önce değil" gecikmesi yapılandırma bölümüne bakın. (Ek 3.1.6)

Not: Bu seçeneği Edge Microgateway 3.1.6 ile dağıtılan sürümden daha eski edgemicro-auth sürümleriyle kullanırsanız bayrak yoksayılır.

-i, --kid (İsteğe bağlı) Belirli bir anahtarı eşleştirmek için kullanılan kimlik. Edge Microgateway, anahtar rotasyonu sırasında bir anahtar grubu arasından seçim yapmak için bu değeri kullanır. Bu parametre atlanırsa (önerilir) Edge Mikro Ağ Geçidi, zaman damgası tabanlı bir anahtar oluşturur. Daha fazla bilgi için JSON Web Anahtarı spesifikasyonunun 4.5 numaralı bölümüne bakın.
-r, --rotatekeyuri Anahtar URI'sini döndür.

Edge Herkese Açık Bulut: İsteğe bağlı.
Edge Private Cloud: Zorunlu.

Herkese açık Cloud örneği:

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

Edge Private Cloud örneği:

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

Örnek

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

Çıkış (Başarılı)

Başarılı olduğunda, komut aşağıdakine benzer bir çıkış döndürür:

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!

Rotasyondan sonra, Edge kullanıcı arayüzünde mikro ağ geçidi KVM'ye yeni anahtarların eklendiğini görebilirsiniz.

Örnek

Bu örnekte, özel anahtar/sertifika çiftinin yolunu belirtmek için -p ve -c işaretleri kullanılmaktadır. Bu seçenekler, özel bir özel anahtar ve sertifika çifti aktarmanıza olanak tanır.

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

Süresiz izleme

Uygulama çöktüğünde veya hata verdiğinde Node.js uygulamasını otomatik olarak yeniden başlatan bir Node.js aracı olan Forever işlemini yönetmek için edgemicro forever komutunu kullanın. Sonsuza kadar izleme konusuna da bakın.

Kullanım

edgemicro forever komutunu yürütmeden önce aşağıdaki ortam değişkenlerini ayarlamanız gerekir:

  • EDGEMICRO_ORG - Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
  • EDGEMICRO_ENV - Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
  • EDGEMICRO_KEY: "edgemicro configuration" komutunu çalıştırdığınızda döndürülen anahtar değeri.
  • EDGEMICRO_SECRET: "edgemicro configuration" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri.
edgemicro forever -f [forever_file] -a [start|stop]

Parametreler

ParametreAçıklama
-f, --fileforever.json dosyasının konumunu belirtir.
-a, --actionstart veya stop. Varsayılan değer, başlangıçtır.

Örnekler:

Sonsuza kadar başlatmak için:

edgemicro forever -f ~/mydir/forever.json -a start

Sonsuza kadar durdurmak için:

edgemicro forever -a stop

Anahtarları iptal etme

Edge Mikro Ağ Geçidi yapılandırmasının anahtarını ve gizli anahtar bilgilerini iptal etmek için edgemicro revokekeys komutunu kullanın.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org (Zorunlu) Edge Mikro Ağ Geçidi'ni yapılandırdığınız Apigee kuruluşu.
-e, --env (Gerekli) Edge Mikro Ağ Geçidi'ni yapılandırdığınız bir ortam.
-u, --username (-u veya -t gereklidir) Apigee kullanıcı adınız. Belirtilen kuruluş için bir kuruluş yöneticisi olmanız gerekir. Bunun yerine -t parametresini belirtirseniz bu parametre gerekli değildir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında girmezseniz istenir.
-k, --key (Gerekli) İptal edilecek anahtar.
-s, --secret (Gerekli) İptal edilecek gizli anahtar.
-t, --token (-u veya -t gereklidir) Kimlik doğrulama için kullanıcı adı/şifre yerine OAuth jetonu kullanmanıza olanak tanır. -t belirtilirse -u parametresi gerekli değildir. OAuth2 erişim jetonuyla güvenli API çağrıları başlıklı makaleyi de inceleyin. Örneğin:
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

Örnekler

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

İşlem başarılı olduğunda aşağıdaki mesajı görürsünüz:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully