Dokumentacja interfejsu wiersza poleceń dla Edge Microgateway

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Edge Microgateway w wersji 3.0.x

Przegląd

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

Zarządzanie certyfikatami

Polecenia cert umożliwiają instalowanie i zarządzanie parą kluczy publiczny/prywatny, która służy do podpisywania tokenów dostępu używanych przez klienty do wykonywania bezpiecznych wywołań za pomocą Edge Microgateway. Klucze są przechowywane w zaszyfrowanej mapie klucz-wartość (KVM) w Apigee Edge. Edge Microgateway używa klucza publicznego do weryfikowania podpisanych tokenów dostępu. Te klucze są generowane po uruchomieniu polecenia edgemicro configure, jak opisano w artykule Konfigurowanie i ustawianie Edge Microgateway. W razie potrzeby możesz ponownie wygenerować te klucze i nimi zarządzać za pomocą opisanych tutaj poleceń cert.

Zainstaluj certyfikat

Instaluje klucze na zaszyfrowanej mapie klucz-wartość (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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-f, --force (Opcjonalnie) Jeśli klucz jest już zapisany w zaszyfrowanym KVM, wymuś jego zastąpienie.
-h, --help Wyświetla informacje o użyciu.

Przykład

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

Dane wyjściowe

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

Usuwanie certyfikatu

Usuwa parę kluczy 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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-h, --help Wyświetla informacje o użyciu.

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

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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-h, --help Wyświetla informacje o użyciu.

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 Wyświetla informacje o użyciu.

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 Edge Microgateway działanie z instancją Apigee Edge Cloud. Zawiera i wykonuje sekwencję poleceń, aby wdrożyć wymagany serwer proxy uwierzytelniania w Edge, wygenerować tokeny uwierzytelniania i zaktualizować pliki konfiguracyjne. Pełny przykład znajdziesz w artykule Konfigurowanie 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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-r, --url (Opcjonalnie) Określa alias hosta wirtualnego dla Twojej organizacji:środowisko. Więcej informacji 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 w wersji 2.4.x)
-x, --proxyName (Opcjonalnie) Ustawia ścieżkę podstawową dla serwera proxy edgemicro-auth. Jeśli serwer proxy edgemicro-auth jest wdrożony pod inną ścieżką niż domyślna, /edgemicro-auth, ta funkcja umożliwia ustawienie nowej ścieżki w Edge Microgateway. Domyślnie ścieżka podstawowa to /edgemicro-auth. (Dodano w wersji 2.4.x)
-t, --token (Opcjonalnie) Umożliwia używanie tokena OAuth do uwierzytelniania zamiast nazwy użytkownika i hasła. Zobacz też Zabezpieczanie wywołań interfejsu API za pomocą tokena dostępu OAuth2. Na przykład:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (Opcjonalnie) Zastępuje domyślne hosty wirtualne, czyli „default,secure”. Użyj tej opcji, jeśli masz hosty wirtualne określone dla organizacji Edge:środowisko inne niż te domyślne. Więcej informacji o hostach wirtualnych znajdziesz w dokumentacji Edge.
-d, --debug (Opcjonalnie) Zawiera informacje na potrzeby debugowania.
-h, --help Wyświetla informacje o użyciu.

Uwagi dotyczące użytkowania

To polecenie zapisuje informacje o konfiguracji w katalogu ~/.edgemicro/org-env-config.yaml.

Przykład

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

Dane wyjściowe

Jeśli polecenie zadziała, zwróci 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 hasła używaną przez Edge Microgateway do uwierzytelniania się podczas asynchronicznego przesyłania danych analitycznych do 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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-t, --token (Opcjonalnie) Umożliwia używanie tokena OAuth do uwierzytelniania zamiast nazwy użytkownika i hasła. Zobacz też Zabezpieczanie wywołań interfejsu API za pomocą tokena dostępu OAuth2. Na przykład:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help Wyświetla informacje o użyciu.

Uwagi dotyczące użytkowania

Jeśli polecenie zadziała, zwróci 3 elementy. Pierwszy to adres URL, który musisz umieścić w pliku konfiguracyjnym. Pozostałe 2 to para kluczy wymagana podczas uruchamiania instancji Edge Microgateway.

  • Adres URL bootstrap: 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 klucz tajny są wymagane jako dane wejściowe polecenia interfejsu wiersza poleceń używanego do uruchamiania instancji Edge Microgateway.
  • secret: hasło.

Przykład

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

Dane wyjściowe (przykład)

Jeśli polecenie zadziała, zwróci 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 na potrzeby Apigee Edge Private Cloud

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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-r, --runtime-url Określa adres URL środowiska wykonawczego instancji chmury prywatnej.
-m, --mgmt-url Adres URL serwera zarządzającego instancją chmury prywatnej.
-v, --virtualHosts Rozdzielana przecinkami lista hostów wirtualnych w Twojej organizacji:środowisko. Domyślna wartość to „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 w wersji 2.4.x)
-t, --token (Opcjonalnie) Umożliwia używanie tokena OAuth do uwierzytelniania zamiast nazwy użytkownika i hasła. Zobacz też Zabezpieczanie wywołań interfejsu API za pomocą tokena dostępu OAuth2. Na przykład:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (Opcjonalnie) Zawiera informacje na potrzeby debugowania.
-h, --help Wyświetla informacje o użyciu.

Uwagi dotyczące użytkowania

To polecenie zapisuje informacje o konfiguracji w katalogu ~/.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

Jeśli polecenie zadziała, zwróci 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!

Uruchamianie Edge Microgateway

Zanim uruchomisz Edge Microgateway, musisz najpierw wykonać polecenie edgemicro configure (w przypadku chmury publicznej) lub edgemicro private configure (w przypadku chmury prywatnej). Polecenie configure zwraca klucz i wartości tajne 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ść tajna zwracana po uruchomieniu polecenia „edgemicro configure”.
-p, --processes (Opcjonalnie) Liczba procesów do uruchomienia. Domyślnie: liczba rdzeni w systemie.
-d, --pluginDir (Opcjonalnie) Ścieżka bezwzględna do katalogu wtyczki.
-r, --port (Opcjonalnie) Zastępuje numer portu określony w pliku ~/.edgemicro/org-env-config.yaml. Domyślnie: 8000
-c, --cluster

(Opcjonalnie) Uruchamia Edge Microgateway w trybie klastra.

Uwaga: od wersji 2.3.1 ta opcja została 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 w wersji 2.4.x)
-u, --configUrl (Opcjonalnie) Określa punkt końcowy, z którego Edge Microgateway pobierze plik konfiguracyjny. (Dodano w wersji 2.5.x)
-d, --debug (Opcjonalnie) Zawiera informacje na potrzeby debugowania.
-h, --help Wyświetla informacje o użyciu.

Ustawianie portu

Polecenie start umożliwia określenie numeru portu, który zastąpi port podany w pliku konfiguracyjnym. Możesz też określić numer portu 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 klastrowaniu

Edge Microgateway używa modułu klastra Node.js, aby włączyć klastrowanie. Klastrowanie umożliwia Edge Microgateway korzystanie 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 umożliwiają uzyskiwanie, dekodowanie i weryfikowanie podpisanych tokenów dostępu OAuth2. Zobacz też Zabezpieczanie wywołań interfejsu API za pomocą tokena dostępu OAuth2.

Dekodowanie tokena

Dekoduje podpisany, zakodowany token dostępu do jego reprezentacji w postaci zwykłego tekstu JSON JWT (Java Web Token). Token zawiera informacje o aplikacji dewelopera 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 dekodowania.
-h, --help Wyświetla informacje o użyciu.

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

Generowanie tokena

Generuje podpisany token dostępu. Token umożliwia aplikacjom klienckim wykonywanie uwierzytelnionych wywołań interfejsu API do Edge Microgateway. Token jest zgodnym z OAuth 2.0 tokenem sieciowym JSON (JWT). Wymaga on podania wartości klucza klienta (identyfikatora klienta) i tajnego klucza klienta z zarejestrowanej aplikacji deweloperskiej w Apigee Edge. Zobacz też Zabezpieczanie wywołań interfejsu API za pomocą tokena 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 dewelopera powiązanej z proxy obsługującym mikrobramę.
-s, --secret Tajny klucz klienta z aplikacji dewelopera powiązanej z proxy obsługującym mikrobramę.
-h, --help Wyświetla informacje o użyciu.

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

Weryfikowanie tokena

Weryfikuje podpisany token dostępu na podstawie klucza publicznego przechowywanego 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 zweryfikowania.
-h, --help Wyświetla informacje o użyciu.

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 dla wygasłego tokena

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

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

Inicjowanie nowej konfiguracji Edge Microgateway

Uruchom to polecenie raz po pierwszej instalacji Edge Microgateway. Tworzy nowy domyślny plik konfiguracji: ~/.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 w wersji 2.4.x)
-h, --help Wyświetla informacje o użyciu.

Przykład

edgemicro init

Dane wyjściowe (Sukces)

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

Weryfikowanie konfiguracji Edge Microgateway

Sprawdza, czy Edge Microgateway jest prawidłowo skonfigurowany.

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 mikrobrany

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

Wykorzystanie

edgemicro status

Parametry

Parametry Opis
-h, --help Wyświetla informacje o użyciu.

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

Zatrzymywanie klastra mikrobramy

Zatrzymuje klaster Edge Microgateway.

Wykorzystanie

edgemicro stop

Parametry

Parametry Opis
-h, --help Wyświetla informacje o użyciu.

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

Ponowne wczytywanie klastra mikrobrany

Zapewnia ponowne uruchomienie bez przestoju po zmianie konfiguracji. Ponownie wczytuje 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ść tajna zwracana po uruchomieniu polecenia „edgemicro configure”.
-h, --help Wyświetla informacje o użyciu.

Przykład

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

Dane wyjściowe (Sukces)

...

Reload Completed Successfully

Uaktualnianie KVM

Aby korzystać z rotacji kluczy, musisz mieć w organizacji Apigee Edge zainstalowaną uaktualnioną mapę klucz-wartość. (Dodano w wersji 2.5.x)

Uwaga: jeśli bieżącą instancję Edge Micro skonfigurowano przed wersją 2.5.2, musisz uaktualnić KVM, aby używać rotacji kluczy. Wystarczy to zrobić tylko raz.

Wykorzystanie

edgemicro upgradekvm -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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-v, --virtualhost (Opcjonalnie) Wirtualny host serwera proxy.
-t, --token (Opcjonalnie) Umożliwia używanie tokena OAuth do uwierzytelniania zamiast nazwy użytkownika i hasła. Zobacz też Zabezpieczanie wywołań interfejsu API za pomocą tokena dostępu OAuth2. Na przykład:

edgemicro upgradekvm -o docs -e test -t <your token>
-b, --baseuri (Opcjonalnie) Podstawowy identyfikator URI organizacji w Apigee Edge. Domyślny identyfikator URI dla wdrożeń w chmurze Apigee to api.enterprise.apigee.com. W przypadku wdrożeń lokalnych podstawowy adres URL może być inny.

Przykład

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

Dane wyjściowe (Sukces)

Jeśli polecenie zadziała, zwróci dane wyjściowe podobne do tych:

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
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

Uaktualnianie serwera proxy edgemicro-auth

Aby korzystać z rotacji kluczy, musisz mieć wdrożony w organizacji Apigee Edge uaktualniony serwer proxy edgemicro-auth. (Dodano w wersji 2.5.x)

Uwaga: jeśli bieżąca instancja Edge Micro została skonfigurowana przed wersją 2.5.2, musisz uaktualnić ten serwer proxy, aby móc korzystać z rotacji kluczy. 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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-v, --virtualhost (Opcjonalnie) Wirtualny host serwera proxy.
-b, --baseuri (Opcjonalnie) Podstawowy identyfikator URI organizacji w Apigee Edge. Domyślny identyfikator URI dla wdrożeń w chmurze Apigee to 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)

Jeśli polecenie zadziała, zwróci 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

Rotacja kluczy

Użyj polecenia edgemicro rotatekey, aby zmienić pary kluczy publiczny/prywatny, które zostały użyte do wygenerowania tokenów JWT używanych do zabezpieczeń OAuth w Edge Microgateway.

Więcej informacji znajdziesz w artykule Rotacja kluczy JWT.

Wykorzystanie

edgemicro rotatekey -o [organization] -e [environment] -u [username] -k [kid]

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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-k, --kid (Wymagany) Identyfikator używany do dopasowania konkretnego klucza. Edge Microgateway używa tej wartości do wybierania spośród zestawu kluczy podczas rotacji kluczy. Więcej informacji znajdziesz w sekcji 4.5 specyfikacji klucza sieciowego JSON.
-b, --baseuri (Opcjonalnie) Podstawowy identyfikator URI organizacji w Apigee Edge. Domyślny identyfikator URI dla wdrożeń w chmurze Apigee to api.enterprise.apigee.com. W przypadku wdrożeń lokalnych podstawowy adres URL może być inny.

Przykład

edgemicro rotatekey -o jdoe -e test -u jdoe@google.com -k 2

Dane wyjściowe (Sukces)

Jeśli polecenie zadziała, zwróci 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 w interfejsie Edge zobaczysz, że do KVM mikrobrany zostały dodane nowe klucze.

Stałe monitorowanie

Użyj polecenia edgemicro forever, aby zarządzać procesem Forever, narzędziem Node.js, które automatycznie ponownie uruchamia aplikację Node.js w przypadku jej awarii lub wystąpienia błędu. Zobacz też Stałe monitorowanie.

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 – zwrócona wartość klucza, która została zwrócona po uruchomieniu polecenia „edgemicro configure”.
  • EDGEMICRO_SECRET – zwrócona wartość tajna, która została zwrócona po uruchomieniu polecenia „edgemicro configure”.
edgemicro forever -f [forever_file] -a [start|stop]

Parametry

ParametrOpis
-f, --fileOkreśla lokalizację pliku forever.json.
-a, --actionMoże to być start lub stop. Domyślnie jest to start.

Przykłady:

Aby rozpocząć Forever:

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

Aby zatrzymać Forever:

edgemicro forever -a stop

Unieważnianie kluczy

Użyj polecenia edgemicro revokekeys, aby cofnąć klucz i tajne dane logowania w 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 organizacji, której dotyczy to żądanie.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w wierszu poleceń, pojawi się odpowiedni komunikat.
-k, --key (Wymagany) Klucz do wycofania.
-s, --secret (Wymagany) 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ę powiedzie, zobaczysz ten komunikat:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully