Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Edge Microgateway w wersji 3.1.5 i nowszych
Opis
Interfejs wiersza poleceń Edge Microgateway umożliwia sterowanie wszystkimi aspektami instancji Edge Microgateway i zarządzanie nimi.
Zarządzanie certyfikatami
Polecenia cert
pozwalają zainstalować parę kluczy publiczny/prywatny, która służy do podpisywania tokenów okaziciela używanych przez klientów do wykonywania bezpiecznych połączeń przez Edge Microgateway, oraz zarządzanie nią. Klucze są przechowywane w Apigee Edge w zaszyfrowanej mapie wartości klucza (KVM). Edge Microgateway używa klucza publicznego do weryfikowania podpisanych tokenów okaziciela. Te klucze są generowane po uruchomieniu polecenia konfiguracji Edgemicro zgodnie z opisem w sekcji Konfigurowanie i konfigurowanie Edge Microgateway. W razie potrzeby możesz użyć opisanych tu poleceń cert, aby ponownie wygenerować te klucze i nimi zarządzać.
Instalowanie certyfikatu
Instaluje klucze w zaszyfrowanej mapie wartości klucza (KVM) 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
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-u, --username |
Twoja nazwa użytkownika Apigee. Musisz być administratorem określonej organizacji. |
-p, --password |
(Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, zobaczysz komunikat. |
-f, --force |
(Opcjonalnie) Jeśli klucz jest już przechowywany w zaszyfrowanej maszynie wirtualnej, wymuś jego zastąpienie. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro cert install -o docs -e test -u jdoe@example.com -f
Wyjście
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
Usuń certyfikat
Usuwa parę kluczy dla organizacji.
Wykorzystanie
edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]
Parametry
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-u, --username |
Twoja nazwa użytkownika Apigee. Musisz być administratorem określonej organizacji. |
-p, --password |
(Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, zobaczysz komunikat. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro cert delete -o docs -e test -u jdoe@example.com
Wyjście
deleting vault Vault deleted!
Sprawdzanie certyfikatu
Sprawdza, czy organizacja ma zainstalowany certyfikat.
Wykorzystanie
edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]
Parametry
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-u, --username |
Twoja nazwa użytkownika Apigee. Musisz być administratorem określonej organizacji. |
-p, --password |
(Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, zobaczysz komunikat. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro cert check -o docs -e test -u jdoe@example.com
Dane wyjściowe (Sukces)
checked cert successfully
Dane wyjściowe (błąd)
Jeśli certyfikat nie istnieje, zwracany jest błąd.
Pobieranie klucza publicznego
Zwraca klucz publiczny określonej organizacji. Nie wymaga uwierzytelniania.
Wykorzystanie
edgemicro cert public-key -o [organization] -e [environment]
Parametry
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
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 dla Apigee Edge Cloud
Umożliwia Edge Microgateway działanie z instancją Apigee Edge Cloud. Opakowuje i wykonuje sekwencję poleceń, aby wdrożyć wymagany serwer proxy uwierzytelniania na serwerach brzegowych, wygenerować tokeny uwierzytelniania i zaktualizować pliki konfiguracji. Pełny przykład działania znajdziesz w artykule o konfigurowaniu i konfigurowaniu Edge Microgateway.
Wykorzystanie
edgemicro configure -o [organization] -e [environment] -u [username] -p [password]
Parametry
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-u, --username |
Twoja nazwa użytkownika Apigee. Musisz być administratorem określonej organizacji. |
-p, --password |
(Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, zobaczysz komunikat. |
-r, --url |
(Opcjonalnie) Określa alias hosta wirtualnego organizacji:środowisko. Informacje o hostach wirtualnych znajdziesz w dokumentacji Edge. Domyślnie: org-env.apigee.net |
-c, --configDir |
(Opcjonalnie) Określa ścieżkę do pliku konfiguracji Edge Microgateway. Domyślnie plik konfiguracji znajduje się w lokalizacji ./config/config.yaml. (Dodano wersję 2.4.x) |
-x, --proxyName |
(Opcjonalnie) Ustawia ścieżkę bazową serwera proxy edgemicro-auth. Jeśli serwer proxy edgemicro-auth jest wdrożony przy użyciu innej ścieżki niż domyślna (/edgemicro-auth), ta funkcja umożliwia ustawienie nowej ścieżki w Edge Microgateway. Domyślnie ścieżka bazowa to /edgemicro-auth. (Dodano wersję 2.4.x) |
-t, --token |
(Opcjonalnie) Umożliwia uwierzytelnianie przy użyciu tokena OAuth zamiast nazwy użytkownika/hasła.
Zobacz też Bezpieczne wywołania interfejsu API z tokenem dostępu OAuth2.
Przykład:edgemicro configure -o docs -e test -t <your token> |
-v, --virtualHosts |
(Opcjonalnie) Zastępuje domyślne hosty wirtualne „default,secure ”. Użyj tej opcji, jeśli dla organizacji brzegowej masz określone hosty wirtualne w organizacji:środowisko inne niż te domyślne. Informacje o hostach wirtualnych znajdziesz w dokumentacji Edge. |
-d, --debug |
(Opcjonalnie) Zawiera dane debugowania. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Uwagi na temat użytkowania
To polecenie przechowuje informacje o konfiguracji w obiekcie ~/.edgemicro/org-env-config.yaml
.
Przykład
edgemicro configure -o docs -e test -u jdoe@example.com
Wyjście
Po zakończeniu polecenia polecenie zwraca zestaw kluczy, których musisz użyć podczas uruchamiania Edge Microgateway.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Generowanie kluczy
Polecenie genkeys
generuje parę klucza i obiektu tajnego, używaną 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
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-u, --username |
Twoja nazwa użytkownika Apigee. Musisz być administratorem określonej organizacji. |
-p, --password |
(Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, zobaczysz komunikat. |
-t, --token |
(Opcjonalnie) Umożliwia uwierzytelnianie przy użyciu tokena OAuth zamiast nazwy użytkownika/hasła.
Zobacz też Bezpieczne wywołania interfejsu API z tokenem dostępu OAuth2.
Przykład:edgemicro genkeys -o docs -e test -t <your token> |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Uwagi na temat użytkowania
Po pomyślnym zakończeniu polecenie zwraca 3 elementy. Pierwszym z nich jest adres URL, który należy umieścić w pliku konfiguracji. Pozostałe 2 to para kluczy, która jest wymagana podczas uruchamiania instancji Edge Microgateway.
- bootstrap 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
. - klucz: klucz. Ten klucz i obiekt tajny są wymagane jako dane wejściowe w poleceniu interfejsu wiersza poleceń służącym do uruchomienia instancji Edge Microgateway.
- secret: obiekt tajny.
Przykład
edgemicro genkeys -o docs -e test -u jdoe@example.com
Dane wyjściowe (przykład)
Po zakończeniu polecenia polecenie zwraca zestaw kluczy, których musisz użyć podczas uruchamiania 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 dla 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
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-u, --username |
Twoja nazwa użytkownika Apigee. Musisz być administratorem określonej organizacji. |
-p, --password |
(Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, zobaczysz komunikat. |
-r, --runtime-url |
Określa adres URL środowiska wykonawczego instancji chmury prywatnej. |
-m, --mgmt-url |
Adres URL serwera zarządzania instancji chmury prywatnej. |
-v, --virtualHosts |
Lista rozdzielonych przecinkami hostów wirtualnych dla Twojej organizacji:środowisko. Domyślnie „default,secure ”. |
-c, --configDir |
(Opcjonalnie) Określa ścieżkę do pliku konfiguracji Edge Microgateway. Domyślnie plik konfiguracji znajduje się w lokalizacji ./config/config.yaml. (Dodano wersję 2.4.x) |
-t, --token |
(Opcjonalnie) Umożliwia uwierzytelnianie przy użyciu tokena OAuth zamiast nazwy użytkownika/hasła.
Zobacz też Bezpieczne wywołania interfejsu API z tokenem dostępu OAuth2.
Przykład:edgemicro configure -o docs -e test -t <your token> |
-d, --debug |
(Opcjonalnie) Zawiera dane debugowania. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Uwagi na temat użytkowania
To polecenie przechowuje informacje o konfiguracji w obiekcie ~/.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
Wyjście
Po zakończeniu polecenia polecenie zwraca zestaw kluczy, których musisz użyć podczas uruchamiania Edge Microgateway.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Uruchamiam mikrobramę Edge
Zanim uruchomisz Edge Microgateway, musisz najpierw uruchomić edgemicro configure (Public Cloud) lub edgemicro private configure (Private Cloud). Polecenie konfiguracji 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
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-k, --key |
Wartość klucza zwracana po uruchomieniu polecenia „edgemicro
configure ”. |
-s, --secret |
Wartość obiektu tajnego zwracana po uruchomieniu polecenia „edgemicro
configure ”. |
-p, --processes |
(Opcjonalnie) Liczba procesów, które mają się rozpocząć. Wartość domyślna: liczba rdzeni w systemie. |
-d, --pluginDir |
(Opcjonalnie) Ścieżka bezwzględna do katalogu wtyczek. |
-r, --port |
(Opcjonalnie) Zastępuje numer portu podany w pliku ~/.edgemicro/org-env-config.yaml . Domyślnie: 8000 |
-c, --cluster |
(Opcjonalnie) Uruchamia mikrobramę Edge w trybie klastra. Uwaga: od wersji 2.3.1 ta opcja jest usunięta. W wersji 2.3.1 i nowszych Edge Micro zawsze uruchamia się w trybie klastra. |
-c, --configDir |
(Opcjonalnie) Określa ścieżkę do pliku konfiguracji Edge Microgateway. Domyślnie plik konfiguracji znajduje się w lokalizacji ./config/config.yaml. (Dodano wersję 2.4.x) |
-u, --configUrl |
(Opcjonalnie) Określa punkt końcowy, z którego Edge Microgateway pobierze swój plik konfiguracji. (Dodano wersję 2.5.x) |
-d, --debug |
(Opcjonalnie) Zawiera dane debugowania. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Ustawianie portu
Polecenie start
pozwala podać numer portu, który ma zastąpić port określony w pliku konfiguracji. Numer portu możesz też podać w 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
Do obsługi klastrów Edge Microgateway wykorzystuje moduł klastra Node.js. Grupowanie 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:
... 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
Zarządzanie tokenami
Polecenia token
pozwalają uzyskać, zdekodować i zweryfikować podpisane tokeny dostępu OAuth2. Zobacz też
Wywołania bezpiecznego interfejsu API z tokenem dostępu OAuth2.
Dekodowanie tokena
Dekoduje podpisany, zakodowany token okaziciela do jego reprezentacji w postaci zwykłego tekstu (JWT w języku Java) w formacie JSON (Java Web Token). Token przekazuje informacje o aplikacji programisty Apigee Edge, która udostępniła klucze użyte do utworzenia tokena, w tym nazwę aplikacji, identyfikator klienta, listę produktów i inne.
Wykorzystanie
edgemicro token decode -f [filename]
Parametry
Parametry | Opis |
---|---|
-f, --file |
Nazwa pliku zawierającego token JWT do zdekodowania. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro token decode -f token.jwt
Dane wyjściowe (przykład)
{ 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: '' }
Wygeneruj token
Generuje podpisany token okaziciela. Token pozwala aplikacjom klienta na wykonywanie uwierzytelnionych wywołań interfejsu API do Edge Microgateway. Token jest zgodnym z OAuth 2.0 tokenem sieciowym JSON (JWT). Wymaga podania wartości klucza klienta (identyfikatora klienta) i tajnego klucza klienta (tajnego klucza klienta) z zarejestrowanej aplikacji dewelopera w Apigee Edge. Zobacz też Wywołania bezpiecznego interfejsu API z tokenem dostępu OAuth2.
Wykorzystanie
edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]
Parametry
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-1, --key |
Identyfikator klienta z aplikacji dla programistów powiązany z serwerem proxy obsługującym Microgateway. |
-s, --secret |
Klucz klienta z aplikacji dla programistów powiązany z serwerem proxy obsługującym Microgateway. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz
Dane wyjściowe (przykład)
{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3 EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2 VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5 f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0 TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3 2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }
Możesz też wygenerować token JWT za pomocą interfejsu API zarządzania:
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" }'
Gdzie:
- $ORG to nazwa organizacji Edge (musisz być jej administratorem).
- $ENV to środowisko w Twojej organizacji (np. „test” lub „prod”).
- $CLIENT_ID to identyfikator klienta w utworzonej wcześniej aplikacji dewelopera.
- $CLIENT_SECRET to tajny klucz klienta w utworzonej wcześniej aplikacji programisty.
Zweryfikuj token
Weryfikuje 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
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-f, --file |
Nazwa pliku zawierającego token JWT do weryfikacji. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro token get -o docs -e test -f token.jwt
Przykładowe dane wyjściowe dla 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 nieważnego tokena
{ [TokenExpiredError: jwt expired] name: 'TokenExpiredError', message: 'jwt expired', expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }
Inicjuję nową konfigurację Edge Microgateway
Uruchom to polecenie raz po pierwszej instalacji Edge Microgateway. Tworzy nowy plik konfiguracji domyślnej: ~/.edgemicro/default.yaml
.
Wykorzystanie
edgemicro init
Parametry
Parametry | Opis |
---|---|
-c, --configDir |
(Opcjonalnie) Określa ścieżkę do pliku konfiguracji Edge Microgateway. Domyślnie plik konfiguracji znajduje się w lokalizacji ./config/config.yaml. (Dodano wersję 2.4.x) |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro init
Dane wyjściowe (Sukces)
config initialized to /MyHome/.edgemicro/default.yaml
Weryfikuję konfigurację Edge Microgateway
Sprawdza, czy Edge Microgateway jest poprawnie skonfigurowana.
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
Dane wyjściowe (Sukces)
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 mikrobramy
Domyślnie Edge Microgateway uruchamia się w trybie klastra. Możesz użyć tego polecenia, aby sprawdzić stan klastra.
Wykorzystanie
edgemicro status
Parametry
Parametry | Opis |
---|---|
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro status
Dane wyjściowe (Sukces)
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 edgemicro is running with 8 workers
Zatrzymuję klaster mikrobramy
Zatrzymuje klaster Edge Microgateway.
Wykorzystanie
edgemicro stop
Parametry
Parametry | Opis |
---|---|
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro stop
Dane wyjściowe (Sukces)
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 Stop Completed Successfully
Ponownie ładuję klaster mikrobramy
Zapewnia ponowne uruchomienie bez przestojów po zmianie konfiguracji. Wczytuje ponownie Edge Microgateway, pobierając nową konfigurację.
Wykorzystanie
edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]
Parametry
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-k, --key |
Wartość klucza zwracana po uruchomieniu polecenia „edgemicro
configure ”. |
-s, --secret |
Wartość obiektu tajnego zwracana po uruchomieniu polecenia „edgemicro
configure ”. |
-h, --help |
Wyjściowe informacje o wykorzystaniu. |
Przykład
edgemicro reload -o docs -e test -k abc123 -s xyz456
Dane wyjściowe (Sukces)
... Reload Completed Successfully
Uaktualniam serwer proxy uwierzytelniania Edgemicro
Aby używać rotacji kluczy, musisz mieć uaktualniony serwer proxy uwierzytelniania Edgemicro wdrożony w organizacji Apigee Edge. (Dodano wersję 2.5.x)
Uwaga: jeśli Twoja obecna instancja Edge Micro została skonfigurowana w wersji starszej niż 2.5.2 i chcesz używać rotacji kluczy, musisz uaktualnić ten serwer proxy. Wystarczy to zrobić tylko raz.
Wykorzystanie
edgemicro upgradeauth -o [organization] -e [environment] -u [username]
Parametry
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-u, --username |
Twoja nazwa użytkownika Apigee. Musisz być administratorem określonej organizacji. |
-p, --password |
(Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, zobaczysz komunikat. |
-v, --virtualhost |
(Opcjonalnie) Host wirtualny serwera proxy. |
-b, --baseuri |
(Opcjonalnie) Podstawowy identyfikator URI organizacji w Apigee Edge. Domyślnie jest to podstawowy identyfikator URI wdrożeń Apigee w chmurze, czyli api.enterprise.apigee.com. W przypadku wdrożeń lokalnych podstawowy adres URL może być inny. |
Przykład
edgemicro upgradeauth -o docs -e test -u jdoe@example.com
Dane wyjściowe (Sukces)
Po zakończeniu polecenia polecenie wyświetli dane wyjściowe podobne do tych:
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
Uaktualnienie mapy klucz-wartość (KVM)
Aby uaktualnić KVM w organizacji Apigee, użyj polecenia edgemicro upgradekvm
. Jeśli chcesz korzystać z rotacji kluczy, musisz uaktualnić KVM.
Wykorzystanie
Edge dla chmury publicznej:
edgemicro upgradekvm -o [organization] -e [environment] -k [key] -s [secret]
Edge dla chmury prywatnej:
edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'
Parametry
Parametry | Opis |
---|---|
-o, --org |
Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
Środowisko, w którym skonfigurowano Edge Microgateway. |
-k, --key |
Wartość klucza zwracana po uruchomieniu polecenia „edgemicro
configure ”. |
-s, --secret |
Wartość obiektu tajnego zwracana po uruchomieniu polecenia „edgemicro
configure ”. |
-p, --proxyuri |
Identyfikator URI serwera proxy edgemicro_auth Edge Public Cloud: opcjonalnie. Edge Private Cloud: wymagana. Przykład chmury publicznej Edge: -p 'https://[org]-[env].apigee.net/edgemicro-auth' Przykład chmury Edge Private Cloud: -p 'https://[hostname]/edgemicro-auth' |
Przykład
edgemicro upgradekvm -o docs -e test \ -k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \ -s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47
Dane wyjściowe (Sukces)
Po zakończeniu polecenia polecenie wyświetli dane wyjściowe podobne do tych:
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
Rotacja kluczy
Za pomocą polecenia edgemicro rotatekey
wykonaj rotację par kluczy publicznych i prywatnych, które zostały użyte do generowania tokenów JWT używanych na potrzeby zabezpieczeń protokołu OAuth w Edge Microgateway.
Więcej informacji znajdziesz w opisie rotacji kluczy JWT.
Wykorzystanie
Edge dla chmury publicznej:
edgemicro rotatekey -o [organization] -e [environment] -k [key] -s [secret]
Edge dla chmury prywatnej:
edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'
Parametry
Parametry | Opis |
---|---|
-o, --org |
(Wymagane) Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
(Wymagane) Środowisko, w którym skonfigurowano Edge Microgateway. |
-k, --key |
Wartość klucza zwracana po uruchomieniu polecenia „edgemicro
configure ”. |
-s, --secret |
Wartość obiektu tajnego zwracana po uruchomieniu polecenia „edgemicro
configure ”. |
-p |
Ścieżka niestandardowego klucza prywatnego, który ma być używany przez Apigee Edge. (Dodano 3.1.6) |
-c |
Ścieżka do niestandardowego certyfikatu, który będzie używany przez Apigee Edge. (Dodano 3.1.6) |
-n, --nbf |
Skonfiguruj czas (w minutach), po którym nowy klucz prywatny zacznie obowiązywać. To opóźnienie umożliwia odświeżenie instancji mikrobramy nowym kluczem publicznym. Warto ustawić opóźnienie na wartość większą niż ustawienie konfiguracji
Uwaga: jeśli używasz tej opcji w przypadku wersji |
-i, --kid |
(Opcjonalnie) Identyfikator używany do dopasowania do określonego klucza. Edge Microgateway używa tej wartości do wyboru zestawu kluczy podczas rotacji kluczy. Jeśli ten parametr zostanie pominięty (zalecane), Edge Microgateway wygeneruje klucz na podstawie sygnatury czasowej. Więcej informacji znajdziesz w sekcji 4.5 specyfikacji klucza internetowego JSON. |
-r, --rotatekeyuri |
Wykonaj rotację klucza URI. Edge Public Cloud: opcjonalne. Edge Private Cloud: wymagana. Przykład chmury publicznej: -r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey' Przykład chmury Edge Private Cloud: -r '[hostname]/edgemicro-auth/rotateKey' |
Przykład
edgemicro rotatekey -o docs -e test \ -k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \ -s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47
Dane wyjściowe (Sukces)
Po zakończeniu polecenia polecenie wyświetli dane wyjściowe podobne do tych:
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!
Po rotacji możesz zauważyć w interfejsie użytkownika Edge, że do KVM mikrobramy zostały dodane nowe klucze.
Przykład
W tym przykładzie użyto flag -p
i -c
do określenia ścieżki do pary klucz prywatny i certyfikat. Te opcje umożliwiają przekazanie niestandardowej pary klucza prywatnego i certyfikatu.
edgemicro rotatekey -o docs -e test \ -k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \ -s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \ -p /users/home/keys.pem -c /users/home/cert.cert
Stałe monitorowanie
Użyj polecenia edgemicro forever
, aby zarządzać procesem Forever. Jest to narzędzie Node.js, które automatycznie ponownie uruchamia aplikację Node.js w przypadku jej awarii lub wystąpienia błędu.
Zobacz też
Monitorowanie bezterminowe.
Wykorzystanie
Przed wykonaniem polecenia edgemicro forever
musisz ustawić te zmienne środowiskowe:
EDGEMICRO_ORG
– organizacja Apigee, dla której skonfigurowano Edge Microgateway.EDGEMICRO_ENV
– środowisko, dla którego skonfigurowano Edge Microgateway.EDGEMICRO_KEY
– wartość klucza zwrócona podczas uruchamiania polecenia „edgemicro configure”.EDGEMICRO_SECRET
– wartość obiektu tajnego zwrócona po uruchomieniu polecenia „edgemicro configure”.
edgemicro forever -f [forever_file] -a [start|stop]
Parametry
Parametr | Opis |
---|---|
-f, --file | Określa lokalizację pliku forever.json . |
-a, --action | Może to być start lub stop . Wartość domyślna to „start”. |
Przykłady:
Aby zacząć bezterminowo:
edgemicro forever -f ~/mydir/forever.json -a start
Aby zakończyć na zawsze:
edgemicro forever -a stop
Unieważnij klucze
Za pomocą polecenia edgemicro revokekeys
możesz unieważnić dane logowania klucza i obiektu tajnego na potrzeby konfiguracji Edge Microgateway.
Wykorzystanie
edgemicro revokekeys -o [organization] -e [environment] -u [username] -k [key] -s [secret]
Parametry
Parametry | Opis |
---|---|
-o, --org |
(Wymagane) Organizacja Apigee, dla której skonfigurowano Edge Microgateway. |
-e, --env |
(Wymagane) Środowisko, w którym skonfigurowano Edge Microgateway. |
-u, --username |
(Wymagane) Twoja nazwa użytkownika Apigee. Musisz być administratorem określonej organizacji. |
-p, --password |
(Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, zobaczysz komunikat. |
-k, --key |
(Wymagane) Klucz do unieważnienia. |
-s, --secret |
(Wymagane) Obiekt tajny do unieważnienia. |
Przykłady
edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com -k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513
Jeśli operacja się uda, zostanie wyświetlony następujący komunikat:
key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully