Dokumentacja interfejsu wiersza poleceń dla Edge Microgateway

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

Edge Microgateway wer. 2.5.x

Omówienie

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

Zarządzanie certyfikatami

Polecenia cert pozwalają zainstalować parę kluczy publiczny/prywatny i nią zarządzać służąca do podpisywania tokenów okaziciela używanych przez klientów do wykonywania bezpiecznych połączeń przez Edge Mikrobrama. Klucze są przechowywane w Apigee Edge w zaszyfrowanej mapie wartości kluczy (KVM). Edge Microgateway używa klucz publiczny do weryfikacji podpisanych tokenów okaziciela. Te klucze są generowane po uruchomieniu Edgemicro. zgodnie z opisem w sekcji Konfigurowanie jak skonfigurować Edge Microgateway. Możesz używać opisanych tutaj poleceń cert w celu ich ponownego wygenerowania i zarządzania nimi.

Zainstaluj certyfikat

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 organizacji w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-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

Dane wyjściowe

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
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

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 w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-h, --help Wyjściowe informacje o wykorzystaniu.

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 w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-h, --help Wyjściowe informacje o wykorzystaniu.

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

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 na potrzeby Apigee Edge Cloud

Umożliwia działanie Edge Microgateway z instancją Apigee Edge Cloud. Obejmuje i wydajnie sekwencja poleceń do wdrożenia wymaganego serwera proxy uwierzytelniania w Edge, generowania uwierzytelniania tokeny i aktualizacje plików konfiguracyjnych. Pełny przykład działania można znaleźć w sekcji Konfigurowanie jak skonfigurować 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 w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-r, --url (Opcjonalnie) Określa alias hosta wirtualnego dla organizacji:environment. Zobacz Dokumentacja brzegowa z informacjami o hostach wirtualnych. Domyślne: org-env.apigee.net
-c, --configDir (Opcjonalnie) Określa ścieżkę do pliku konfiguracji Edge Microgateway. Domyślnie plik konfiguracji znajduje się w pliku ./config/config.yaml. (Dodano wersję 2.4.x)
-x, --proxyName (Opcjonalnie) Ustawia ścieżkę podstawową serwera proxy edgemicro-auth. Jeśli Serwer proxy edgemicro-auth jest wdrożony w innej ścieżce niż domyślna, /edgemicro-auth – ta funkcja pozwala ustawić nową ścieżkę w Edge. Mikrobrama. Domyślnie ścieżka bazowa to /edgemicro-auth. (Dodane v2.4.x)
-t, --token (Opcjonalnie) Umożliwia uwierzytelnianie za pomocą tokena OAuth zamiast nazwy użytkownika i hasła. Zapoznaj się też z artykułem Bezpieczne wywołania interfejsu API za pomocą tokena dostępu OAuth2. Przykład:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (Opcjonalnie) Zastępuje domyślne hosty wirtualne, które są „default,secure”. Użyj tej opcji, jeśli dla Organizacja brzegowa:środowisko inne niż te domyślne. Zapoznaj się z dokumentacją Edge, aby dowiedzieć się, uzyskać więcej informacji o hostach wirtualnych.
-d, --debug (Opcjonalnie) Podaje dane debugowania.
-h, --help Wyjściowe informacje o wykorzystaniu.

Uwagi o wykorzystaniu

To polecenie zapisuje informacje o konfiguracji w ok. /.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 klawiszy, których musisz użyć przy uruchamianiu Edge Mikrobrama.

...

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: uwierzytelniać 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 organizacji w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-h, --help Wyjściowe informacje o wykorzystaniu.

Uwagi o wykorzystaniu

Jeśli polecenie zadziała, zwróci 3 elementy. Pierwszy to adres URL, który należy umieścić plik konfiguracji. Pozostałe 2 to para kluczy, która jest wymagana przy uruchamianiu Edge Instancja Microgateway.

  • Launchtrap URL: ten adres URL wskazuje usługę Apigee Edge, która umożliwia korzystanie z Instancja Edge Microgateway umożliwiająca wysyłanie danych analitycznych do Apigee Edge. Musisz skopiować ten 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 interfejsie wiersza poleceń używane 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 pomyślnym uruchomieniu polecenie zwróci zestaw klawiszy, których musisz użyć przy uruchamianiu Edge Mikrobrama.

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

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 w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-r, --runtime-url Określa adres URL środowiska wykonawczego instancji chmury prywatnej.
-m, --mgmt-url Adres URL serwera zarządzania instancji w chmurze prywatnej.
-v, --virtualHosts Rozdzielona przecinkami lista hostów wirtualnych w organizacji:środowisko. Domyślne „default,secure”.
-c, --configDir (Opcjonalnie) Określa ścieżkę do pliku konfiguracji Edge Microgateway. Domyślnie plik konfiguracji znajduje się w pliku ./config/config.yaml. (Dodano wersję 2.4.x)
-t, --token (Opcjonalnie) Umożliwia uwierzytelnianie za pomocą tokena OAuth zamiast nazwy użytkownika i hasła. Zapoznaj się też z artykułem Bezpieczne wywołania interfejsu API za pomocą tokena dostępu OAuth2. Przykład:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (Opcjonalnie) Podaje dane debugowania.
-h, --help Wyjściowe informacje o wykorzystaniu.

Uwagi o wykorzystaniu

To polecenie zapisuje informacje o konfiguracji w ok. /.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 klawiszy, których musisz użyć przy uruchamianiu Edge Mikrobrama.

...

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

edgemicro configuration complete!

Uruchamiam Edge Microgateway

Przed uruchomieniem Edge Microgateway musisz uruchomić edgemicro setup (Public Cloud) lub prywatna konfiguracja Edgemicro (Private Cloud). Parametr zwraca klucz i wartości 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 zwrócona po uruchomieniu funkcji „edgemicro configure” .
-s, --secret Wartość obiektu tajnego zwracana po uruchomieniu „edgemicro configure” .
-p, --processes (Opcjonalnie) Liczba procesów, które mają zostać uruchomione. Domyślnie: liczba rdzeni systemu.
-d, --pluginDir (Opcjonalnie) Ścieżka bezwzględna do katalogu wtyczki.
-r, --port (Opcjonalnie) Zastępuje numer portu określony w ~/.edgemicro/org-env-config.yaml plik. Domyślnie: 8000
-c, --cluster

(Opcjonalnie) Uruchamia Edge Microgateway w trybie klastra.

Uwaga: w wersji 2.3.1 ta opcja jest usunięta. Wersja 2.3.1 i nowszych wersjach 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 pliku ./config/config.yaml. (Dodano wersję 2.4.x)
-u, --configUrl (Opcjonalnie) Określa punkt końcowy, z którego Edge Microgateway pobierze swoją konfigurację . (Dodano v2.5.x)
-d, --debug (Opcjonalnie) Podaje dane debugowania.
-h, --help Wyjściowe informacje o wykorzystaniu.

Ustawianie portu

Polecenie start pozwala podać numer portu do zastąpienia tego numeru w pliku konfiguracji. Numer portu możesz też określić za pomocą funkcji PORT zmiennej środowiskowej. 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 wykorzystuje środowisko Node.js , aby włączyć grupowanie. Dzięki grupowaniu Edge Microgateway zalety systemów wielordzeniowych. Szczegółowe informacje znajdziesz w tej dokumentacji Node.js.

Przykład

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

Przykładowe dane wyjściowe:

...

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
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 podpisanego dostępu OAuth2 tokeny. Zobacz też . Bezpieczne wywołania interfejsu API za pomocą tokena dostępu OAuth2.

Dekodowanie tokena

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

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 (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). Wymagana należy wprowadzić wartości klucza klienta (identyfikatora klienta) i tajnego klucza klienta (tajny klucz klienta) z zarejestrowanego w Apigee Edge. Zobacz też . 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

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 programisty powiązanej z urządzeniem wykrywającym bramkę Microgateway serwera proxy.
-s, --secret Tajny klucz klienta z aplikacji dla programistów powiązanej z urządzeniem wykrywającym bramkę Microgateway serwera proxy.
-h, --help Wyjściowe informacje o wykorzystaniu.

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. Zobacz Bezpośrednie uzyskiwanie tokenów okaziciela.

Weryfikowanie tokena

Sprawdza podpisany token okaziciela w odniesieniu do klucza publicznego zapisanego w Apigee Edge dla określonego 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 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) }

Inicjowanie nowej konfiguracji Edge Microgateway

Uruchom to polecenie raz po pierwszym zainstalowaniu Edge Microgateway. Tworzy nową wartość domyślną 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 pliku ./config/config.yaml. (Dodano wersję 2.4.x)
-h, --help Wyjściowe informacje o wykorzystaniu.

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

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 Wyjściowe informacje o wykorzystaniu.

Przykład

edgemicro status

Wyniki (Udało się)

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
edgemicro is running with 8 workers

Zatrzymuję klaster microgateway

Zatrzymuje klaster Edge Microgateway.

Wykorzystanie

edgemicro stop

Parametry

Parametry Opis
-h, --help Wyjściowe informacje o wykorzystaniu.

Przykład

edgemicro stop

Wyniki (Udało się)

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
Stop Completed Successfully

Ponownie ładuję klaster microgateway

Zapewnia ponowne uruchomienie bez przestojów po zmianie konfiguracji. Wczytuje ponownie Edge Microgateway o Pobieram 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 zwrócona po uruchomieniu funkcji „edgemicro configure” .
-s, --secret Wartość obiektu tajnego zwracana po uruchomieniu „edgemicro configure” .
-h, --help Wyjściowe informacje o wykorzystaniu.

Przykład

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

Wyniki (Udało się)

...

Reload Completed Successfully

Uaktualnianie KVM

Aby użyć rotacji kluczy, musisz mieć uaktualnioną wartość klucza Mapa zainstalowana w organizacji Apigee Edge. (Dodano v2.5.x)

Uwaga: jeśli jeśli Twoja bieżąca instancja Edge Micro została skonfigurowana przed wersją 2.5.2, musisz uaktualnić KVM. aby użyć 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 w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-v, --virtualhost (Opcjonalnie) Host wirtualny serwera proxy.
-t, --token (Opcjonalnie) Umożliwia uwierzytelnianie przy użyciu tokena OAuth zamiast nazwy użytkownika i hasła. Zapoznaj się też z artykułem Bezpieczne wywołania interfejsu API za pomocą tokena dostępu OAuth2. Przykład:

edgemicro upgradekvm -o docs -e test -t <your token>
-b, --baseuri (Opcjonalnie) Podstawowy identyfikator URI organizacji w Apigee Edge. Wartością domyślną jest podstawa Identyfikator URI 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

Wyniki (Udało się)

Po zakończeniu polecenia polecenie wyświetla dane wyjściowe podobne do tych poniżej:

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
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 uwierzytelniania Edgemicro

Aby użyć rotacji kluczy, musisz mieć uaktualnione Serwer proxy uwierzytelniania Edgemicro-auth został wdrożony w organizacji Apigee Edge. (Dodano v2.5.x)

Uwaga: jeśli bieżąca instancja Edge Micro została skonfigurowana przed wersji 2.5.2, jeśli chcesz korzystać z rotacji kluczy, musisz uaktualnić ten serwer proxy. Wystarczy: wykonaj to uaktualnienie 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 w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-v, --virtualhost (Opcjonalnie) Host wirtualny serwera proxy.
-b, --baseuri (Opcjonalnie) Podstawowy identyfikator URI organizacji w Apigee Edge. Wartością domyślną jest podstawa Identyfikator URI 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

Wyniki (Udało się)

Po zakończeniu polecenia polecenie wyświetla dane wyjściowe podobne do tych poniżej:

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

Klawisze obrotowe

Użyj polecenia edgemicro rotatekey, aby wykonać rotację par kluczy publicznych i prywatnych które zostały użyte do wygenerowania tokenów JWT używanych do zabezpieczania protokołu OAuth w Edge Microgateway.

Więcej informacji można znaleźć w sekcji 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, dla którego skonfigurowano Edge Microgateway.
-u, --nazwa_użytkownika (Wymagane) Twoja nazwa użytkownika Apigee. Musisz być administratorem organizacji w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-k, --kid (Wymagane) Identyfikator używany do dopasowania do określonego klucza. Edge Microgateway używa tej wartości do: i wybrać jeden z zestawów klawiszy podczas rotacji kluczy. Więcej informacji znajdziesz w artykule 4.5 specyfikacji klucza internetowego JSON.
-b, --baseuri (Opcjonalnie) Podstawowy identyfikator URI organizacji w Apigee Edge. Wartością domyślną jest podstawa Identyfikator URI 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

Wyniki (Udało się)

Po zakończeniu polecenia polecenie wyświetla dane wyjściowe podobne do tych poniżej:

current nodejs version is v6.9.1
current edgemicro version is 2.5.7
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 obracaniu możesz zobaczyć w interfejsie Edge, że nowe klucze zostały dodane do mikrobramy KVM.

Nieprzerwane monitorowanie

Użyj polecenia edgemicro forever, aby zarządzać Na zawsze za pomocą narzędzia Node.js, które automatycznie uruchamia ponownie aplikację Node.js w przypadku awarii lub błędu. Zobacz też . Nieprzerwane monitorowanie.

Wykorzystanie

Przed wykonaniem polecenia edgemicro forever ustaw te zmienne środowiskowe:

  • EDGEMICRO_ORG – organizacja Apigee, dla której skonfigurowano Edge Microgateway.
  • EDGEMICRO_ENV – środowisko, w którym skonfigurowano Edge Microgateway.
  • EDGEMICRO_KEY – wartość klucza zwrócona podczas uruchamiania „edgemicro setup” .
  • EDGEMICRO_SECRET – wartość obiektu tajnego zwrócona podczas uruchamiania „edgemicro setup” .
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. Wartość domyślna to start.

Przykłady:

Aby zacząć bez końca:

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

Aby zatrzymać na zawsze:

edgemicro forever -a stop

Unieważnij klucze

Unieważnij klucz i tajne dane uwierzytelniające dla instancji za pomocą polecenia edgemicro revokekeys Konfiguracja 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, dla którego skonfigurowano Edge Microgateway.
-u, --username (Wymagane) Twoja nazwa użytkownika Apigee. Musisz być administratorem organizacji w określonym zakresie Twojej organizacji.
-p, --password (Opcjonalnie) Twoje hasło. Jeśli nie podasz tego parametru w w wierszu poleceń.
-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

Po pomyślnym zakończeniu zostanie wyświetlony następujący komunikat:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully