Dokumentacja interfejsu wiersza poleceń dla Edge Microgateway

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Omówienie

Interfejs wiersza poleceń Edge Microgateway umożliwia kontrolowanie wszystkich aspektów instancji Edge Microgateway i zarządzanie nimi.

Zarządzanie certyfikatami

Polecenia cert pozwalają zainstalować parę kluczy publiczny/prywatny i nią zarządzać, która jest używana do podpisywania tokenów okaziciela używanych przez klienty do wykonywania bezpiecznych wywołań przez Edge Microgateway. Klucze są przechowywane w Apigee Edge w bezpiecznym magazynie. Edge Microgateway używa klucza publicznego do weryfikowania podpisanych tokenów okaziciela. Te klucze są generowane po uruchomieniu polecenia Edge Microgateway, zgodnie z opisem w artykule Konfigurowanie i konfigurowanie Edge Microgateway. W razie potrzeby możesz użyć opisanych tu poleceń cert, aby ponownie wygenerować klucze i nimi zarządzać.

Zainstaluj certyfikat

Instaluje klucze w magazynie przy użyciu usługi bezpiecznego magazynu Apigee Edge i zwraca klucz publiczny jako dane wyjściowe. Pary kluczy są ograniczone do określonej organizacji.

Wykorzystanie

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

Parametry

Przykład

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

Dane wyjściowe

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

Usuwanie certyfikatu

Usuwa parę kluczy dla organizacji.

Wykorzystanie

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

Parametry

Przykład

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

Dane wyjściowe

deleting vault
Vault deleted!

Sprawdzanie certyfikatu

Sprawdza, czy w organizacji jest zainstalowany certyfikat.

Wykorzystanie

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

Parametry

Przykład

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

Wyniki (Udało się)

checked cert successfully

Dane wyjściowe (niepowodzenie)

Jeśli certyfikat nie istnieje, zwracany jest błąd.

Uzyskiwanie klucza publicznego

Zwraca klucz publiczny dla określonej organizacji. Nie wymaga uwierzytelniania.

Wykorzystanie

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

Parametry

Przykład

edgemicro cert public-key -o docs -e test

Dane wyjściowe (przykład)

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

Konfigurowanie Edge Microgateway na potrzeby Apigee Edge Cloud

Umożliwia działanie Edge Microgateway z instancją Apigee Edge Cloud. Opakowuje i wykonuje sekwencję poleceń w celu wdrożenia wymaganego serwera proxy uwierzytelniania w Edge, generowania tokenów uwierzytelniania i aktualizowania plików konfiguracji. Pełny przykład działania znajdziesz w artykule Konfigurowanie i konfigurowanie Edge Microgateway.

Wykorzystanie

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

Parametry

Uwagi o wykorzystaniu

To polecenie przechowuje informacje o konfiguracji w pliku ~/.edgemicro/org-env-config.yaml.

Przykład

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

Dane wyjściowe

Po pomyślnym uruchomieniu polecenie zwróci zestaw kluczy, których należy użyć do uruchomienia Edge Microgateway.

...

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

edgemicro configuration complete!

Generowanie kluczy

Polecenie genkeys generuje parę kluczy i haseł, które są używane przez Edge Microgateway do uwierzytelniania się podczas asynchronicznego publikowania danych analitycznych w Apigee Edge.

Wykorzystanie

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

Parametry

Uwagi o wykorzystaniu

Jeśli polecenie zadziała, zwróci 3 elementy. Pierwszy z nich to adres URL, który musisz umieścić w pliku konfiguracji. Pozostałe 2 to para kluczy, która jest wymagana przy uruchamianiu instancji Edge Microgateway.

• Launchtrap URL: ten adres URL wskazuje usługę Apigee Edge, która umożliwia instancji Edge Microgateway wysyłanie danych analitycznych do Apigee Edge. Musisz skopiować ten adres URL do pliku konfiguracyjnego Edge Microgateway: ~/.edgemicro/org-env-config.yaml.
• key: klucz. Ten klucz i obiekt tajny są wymagane jako dane wejściowe w poleceniu interfejsu wiersza poleceń używanym do uruchamiania instancji Edge Microgateway.
• secret: obiekt tajny.

Przykład

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

Dane wyjściowe (przykład)

Po pomyślnym uruchomieniu polecenie zwróci zestaw kluczy, których należy użyć do uruchomienia 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

Konfigurowanie Edge Microgateway na potrzeby chmury prywatnej Apigee Edge

Konfiguruje Edge Microgateway do pracy z instalacją Apigee Edge Private Cloud.

Wykorzystanie

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

Parametry

Uwagi o wykorzystaniu

To polecenie przechowuje informacje o konfiguracji w pliku ~/.edgemicro/org-env-config.yaml.

Przykład

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

Dane wyjściowe

Po pomyślnym uruchomieniu polecenie zwróci zestaw kluczy, których należy użyć do uruchomienia Edge Microgateway.

...

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

edgemicro configuration complete!

Uruchamiam Edge Microgateway

Zanim uruchomisz Edge Microgateway, musisz najpierw uruchomić edgemicro setup (Public Cloud) lub edgemicro private setup (Private Cloud). Polecenie „config” zwraca wartości klucza i obiektu tajnego, które są wymagane do uruchomienia Edge Microgateway.

Wykorzystanie

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

Parametry

Ustawianie portu

Polecenie start pozwala określić numer portu, który zastąpi port podany w pliku konfiguracji. Numer portu możesz też podać za pomocą zmiennej środowiskowej PORT. Na przykład:

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

lub

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

Jeśli port jest używany, Edge Microgateway zwraca błąd.

Informacje o grupowaniu

Edge Microgateway używa modułu klastra Node.js do włączania klastrów. Klasterowanie pozwala Edge Microgateway korzystać z systemów wielordzeniowych. Szczegółowe informacje znajdziesz w dokumentacji Node.js.

Przykład

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

Przykładowe dane wyjściowe:

...

PROCESS PID : 54709
installed plugin from analytics
installed plugin from analytics
installed plugin from oauth
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
5a86b570-a142-11e6-aa1f-6730e9065d6c edge micro listening on port 8000
5a86dc80-a142-11e6-962c-43d9cc723190 edge micro listening on port 8000
5a8751b0-a142-11e6-8241-cf1c517c91eb edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
5a924e30-a142-11e6-8740-2944162ce275 edge micro listening on port 8000

Zarządzanie tokenami

Polecenia token umożliwiają uzyskiwanie, dekodowanie i weryfikowanie podpisanych tokenów dostępu OAuth2. Zapoznaj się też z artykułem Bezpieczne wywołania interfejsu API za pomocą tokena dostępu OAuth2.

Dekodowanie tokena

Dekoduje podpisany, zakodowany token okaziciela na jego reprezentację w postaci zwykłego tekstu JSON (Java Web Token). Token przekazuje informacje o aplikacji dla deweloperów Apigee Edge, która udostępniła klucze użyte do utworzenia tokena, w tym nazwę aplikacji, identyfikator klienta, listę produktów i inne informacje.

Wykorzystanie

edgemicro token decode -f [filename]

Parametry

Przykład

edgemicro token decode -f token.jwt

Dane wyjściowe (próbka)

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

Generowanie tokena

Generuje podpisany token okaziciela. Token pozwala aplikacjom klienckim na wykonywanie uwierzytelnionych wywołań interfejsu API do Edge Microgateway. Tokenem jest zgodny z OAuth 2.0 token sieciowy JSON (JWT). Wymaga podania wartości klucza klienta (identyfikatora klienta) i tajnego klucza klienta (tajnego klucza klienta) z zarejestrowanej aplikacji dewelopera w Apigee Edge. Zapoznaj się też z artykułem Bezpieczne wywołania interfejsu API za pomocą tokena dostępu OAuth2.

Wykorzystanie

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

Parametry

Przykład

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

Dane wyjściowe (próbka)

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

Wysyłanie żądania HTTP w celu uzyskania tokena

Aby uzyskać token, możesz też wysłać nieprzetworzone żądanie HTTP. Oto przykład curl. Wystarczy podstawić w adresie URL nazwy organizacji i środowiska, a wartości identyfikator klienta i tajny klucz klienta – parametry client_id i klucza klienta –

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

Weryfikowanie tokena

Sprawdza podpisany token okaziciela względem klucza publicznego zapisanego w Apigee Edge dla określonej organizacji i środowiska.

Wykorzystanie

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

Parametry

Przykład

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

Przykładowe dane wyjściowe prawidłowego tokena

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

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Przykładowe dane wyjściowe w przypadku nieprawidłowego tokena

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

Przykładowe dane wyjściowe, które wygasły token

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

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

Bezpośrednie uzyskiwanie tokenów okaziciela

Możesz zdecydować się na bezpośrednie uzyskanie tokenów okaziciela, wysyłając żądanie HTTP do punktu końcowego tokena w Apigee Edge. Rzeczywisty punkt końcowy tokena jest zaimplementowany na serwerze proxy wdrażanym za pomocą polecenia interfejsu wiersza poleceń deploy-edge-service.

Oto przykład curl. Wystarczy zastąpić w adresie URL nazwy organizacji i środowiska oraz wartości identyfikatora klienta i tajnego klucza klienta uzyskane z aplikacji dewelopera w Apigee Edge parametrami client_id i client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

Przykładowe dane wyjściowe:

HTTP/1.1 200 OK

X-Powered-By: Express

Cache-Control: no-store

Pragma: no-cache

Content-Type: application/json; charset=utf-8

Content-Length: 640

ETag: W/"280-ze/g/k+c9taqp110vjYQ"

Date: Fri, 17 07 2015 15:49:24 GMT

Connection: keep-alive

"<long string of numbers and letters>"

Inicjowanie nowej konfiguracji Edge Microgateway

Uruchom to polecenie raz po pierwszym zainstalowaniu Edge Microgateway. Tworzy nowy domyślny plik konfiguracji: ~/.edgemicro/default.yaml.

Wykorzystanie

edgemicro init 

Parametry

Przykład

edgemicro init

Wyniki (Udało się)

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

Weryfikuję konfigurację Edge Microgateway

Sprawdza, czy Edge Microgateway jest skonfigurowana prawidłowo.

Wykorzystanie

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

Parametry

Przykład

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

Wyniki (Udało się)

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

Sprawdzanie stanu klastra microgateway

Dodano: wersja 2.2.4-beta

Domyślnie Edge Microgateway uruchamia się w trybie klastra. Za pomocą tego polecenia możesz sprawdzić stan klastra.

Wykorzystanie

edgemicro status

Parametry

Przykład

edgemicro status

Wyniki (Udało się)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
edgemicro is running with 4 workers

Zatrzymuję klaster microgateway

Dodano: wersja 2.2.4-beta

Zatrzymuje klaster Edge Microgateway.

Wykorzystanie

edgemicro stop

Parametry

Przykład

edgemicro stop

Wyniki (Udało się)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
Stop Completed Successfully

Ponownie ładuję klaster microgateway

Dodano: wersja 2.2.4-beta

Zapewnia ponowne uruchomienie bez przestojów po zmianie konfiguracji. Wczytuje ponownie Edge Microgateway przez pobranie nowej konfiguracji.

Wykorzystanie

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

Parametry

Przykład

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

Wyniki (Udało się)

...

Reload Completed Successfully