Sie sehen die Apigee Edge-Dokumentation.
Rufen Sie die Apigee X-Dokumentation auf. weitere Informationen
Edge Microgateway Version 3.3.x
Übersicht
Mit der Edge Microgateway-Befehlszeile können Sie alle Aspekte einer Edge Microgateway-Instanz steuern und verwalten.
Zertifikate verwalten
Mit den cert
-Befehlen können Sie das öffentliche/private Schlüsselpaar installieren und verwalten, das zum Signieren von Inhabertokens verwendet wird, die von Clients für sichere Aufrufe über Edge Microgateway verwendet werden. Die Schlüssel werden in Apigee Edge in einer verschlüsselten Schlüssel/Wert-Zuordnung (KVM) gespeichert. Edge Microgateway verwendet den öffentlichen Schlüssel, um signierte Inhabertokens zu validieren. Diese Schlüssel werden generiert, wenn Sie den Edge Microgateway-Konfigurationsbefehl ausführen, wie unter Edge Microgateway einrichten und konfigurieren erläutert. Sie können die hier beschriebenen cert-Befehle verwenden, um diese Schlüssel bei Bedarf neu zu generieren und zu verwalten.
Ein Zertifikat installieren
Installiert die Schlüssel in einer verschlüsselten Schlüssel/Wert-Zuordnung (KVM) und gibt den öffentlichen Schlüssel als Ausgabe zurück. Schlüsselpaare sind auf eine bestimmte Organisation beschränkt.
Nutzung
edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-u, --username |
Ihren Apigee-Nutzernamen. Sie müssen Organisationsadministrator für die angegebene Organisation sein. |
-p, --password |
Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, erhalten Sie eine entsprechende Aufforderung. |
-f, --force |
(Optional) Wenn ein Schlüssel bereits in der verschlüsselten KVM gespeichert ist, erzwingen Sie seinen Ersatz. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro cert install -o docs -e test -u jdoe@example.com -f
Ausgabe
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
Zertifikat löschen
Löscht das Schlüsselpaar für eine Organisation.
Nutzung
edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-u, --username |
Ihren Apigee-Nutzernamen. Sie müssen Organisationsadministrator für die angegebene Organisation sein. |
-p, --password |
Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, erhalten Sie eine entsprechende Aufforderung. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro cert delete -o docs -e test -u jdoe@example.com
Ausgabe
deleting vault Vault deleted!
Zertifikat prüfen
Überprüft, ob in Ihrer Organisation ein Zertifikat installiert ist.
Nutzung
edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-u, --username |
Ihren Apigee-Nutzernamen. Sie müssen Organisationsadministrator für die angegebene Organisation sein. |
-p, --password |
Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, erhalten Sie eine entsprechende Aufforderung. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro cert check -o docs -e test -u jdoe@example.com
Ausgabe (Erfolg)
checked cert successfully
Ausgabe (Fehler)
Wenn das Zertifikat nicht vorhanden ist, wird ein Fehler zurückgegeben.
Rufen Sie den öffentlichen Schlüssel ab
Gibt den öffentlichen Schlüssel für die angegebene Organisation zurück Erfordert keine Authentifizierung.
Nutzung
edgemicro cert public-key -o [organization] -e [environment]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro cert public-key -o docs -e test
Ausgabe (Beispiel)
-----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-----
Edge Microgateway für Apigee Edge Cloud konfigurieren
Ermöglicht es Edge Microgateway, mit einer Apigee Edge Cloud-Instanz zu arbeiten. Es fasst eine Reihe von Befehlen zusammen und führt sie aus, um einen erforderlichen Authentifizierungs-Proxy in Edge bereitzustellen, Authentifizierungstokens zu generieren und Konfigurationsdateien zu aktualisieren. Ein vollständiges Arbeitsbeispiel finden Sie unter Edge Microgateway einrichten und konfigurieren.
Nutzung
edgemicro configure -o [organization] -e [environment] -u [username] -p [password]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-u, --username |
Ihren Apigee-Nutzernamen. Sie müssen Organisationsadministrator für die angegebene Organisation sein. |
-p, --password |
Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, erhalten Sie eine entsprechende Aufforderung. |
-r, --url |
(Optional) Gibt den virtuellen Host-Alias für Ihre Organisationsumgebung an. Weitere Informationen zu virtuellen Hosts finden Sie in der Edge-Dokumentation. Standardeinstellung:
org-env.apigee.net |
-c, --configDir |
(Optional) Gibt den Pfad zur Konfigurationsdatei von Edge Microgateway an. Die Konfigurationsdatei befindet sich standardmäßig in ./config/config.yaml. (Version 2.4.x hinzugefügt) |
-x, --proxyName |
(Optional) Legt den Basispfad für den edgemicro-auth-Proxy fest. Wenn der Proxy edgemicro-auth unter einem anderen Pfad als dem Standardpfad /edgemicro-auth bereitgestellt wird, können Sie mit dieser Funktion den neuen Pfad in Edge Microgateway festlegen. Standardmäßig ist der Basispfad /edgemicro-auth. (Version 2.4.x hinzugefügt) |
-t, --token |
(Optional) Ermöglicht die Verwendung eines OAuth-Tokens anstelle von Nutzername/Passwort zur Authentifizierung.
Siehe auch API-Aufrufe mit einem OAuth2-Zugriffstoken sichern.
Beispiel:edgemicro configure -o docs -e test -t <your token> |
-v, --virtualHosts |
(Optional) Überschreibt die virtuellen Standardhosts mit dem Namen „default,secure “. Verwenden Sie diese Option, wenn Sie für Ihre Edge-Organisation:umgebung andere als diese Standardeinstellungen angegebene virtuelle Hosts angegeben haben. Weitere Informationen zu virtuellen Hosts finden Sie in der Edge-Dokumentation. |
-d, --debug |
(Optional) Enthält Informationen zur Fehlerbehebung. |
-h, --help |
Nutzungsinformationen ausgeben. |
Verwendungshinweise
Mit diesem Befehl werden Konfigurationsinformationen in ~/.edgemicro/org-env-config.yaml
gespeichert.
Beispiel
edgemicro configure -o docs -e test -u jdoe@example.com
Ausgabe
Bei Erfolg gibt der Befehl eine Reihe von Schlüsseln zurück, die Sie beim Starten von Edge Microgateway verwenden müssen.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Schlüssel generieren
Der Befehl genkeys
generiert ein Key-Secret-Paar, das von Edge Microgateway verwendet wird, um sich beim asynchronen Posten von Analysedaten an Apigee Edge zu authentifizieren.
Nutzung
edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-u, --username |
Ihren Apigee-Nutzernamen. Sie müssen Organisationsadministrator für die angegebene Organisation sein. |
-p, --password |
Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, erhalten Sie eine entsprechende Aufforderung. |
-t, --token |
(Optional) Ermöglicht die Verwendung eines OAuth-Tokens anstelle von Nutzername/Passwort zur Authentifizierung.
Siehe auch API-Aufrufe mit einem OAuth2-Zugriffstoken sichern.
Beispiel:edgemicro genkeys -o docs -e test -t <your token> |
-h, --help |
Nutzungsinformationen ausgeben. |
Verwendungshinweise
Bei Erfolg gibt der Befehl drei Elemente zurück. Die erste ist eine URL, die Sie in die Konfigurationsdatei einfügen müssen. Die anderen beiden sind ein Schlüsselpaar, das beim Starten einer Edge Microgateway-Instanz erforderlich ist.
- Bootstrap-URL: Diese URL verweist auf einen Apigee Edge-Dienst, der einer Edge Microgateway-Instanz ermöglicht, Analysedaten an Apigee Edge zu senden. Sie müssen diese URL in die Edge Microgateway-Konfigurationsdatei kopieren: ~
/.edgemicro/org-env-config.yaml
. - key: Der Schlüssel. Dieser Schlüssel und das Secret sind als Eingabe für den CLI-Befehl erforderlich, der zum Starten einer Instanz von Edge Microgateway verwendet wird.
- secret: Das Secret.
Beispiel
edgemicro genkeys -o docs -e test -u jdoe@example.com
Ausgabe (Beispiel)
Bei Erfolg gibt der Befehl eine Reihe von Schlüsseln zurück, die Sie beim Starten von Edge Microgateway verwenden müssen.
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
Edge Microgateway für Apigee Edge Private Cloud konfigurieren
Konfiguriert Edge Microgateway für eine Apigee Edge Private Cloud-Installation.
Nutzung
edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-u, --username |
Ihren Apigee-Nutzernamen. Sie müssen Organisationsadministrator für die angegebene Organisation sein. |
-p, --password |
Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, erhalten Sie eine entsprechende Aufforderung. |
-r, --runtime-url |
Gibt die Laufzeit-URL für Ihre private Cloud-Instanz an. |
-m, --mgmt-url |
Die URL des Verwaltungsservers für Ihre private Cloud-Instanz. |
-v, --virtualHosts |
Durch Kommas getrennte Liste virtueller Hosts für Ihre Organisationsumgebung. Standardeinstellung: „default,secure “. |
-c, --configDir |
(Optional) Gibt den Pfad zur Konfigurationsdatei von Edge Microgateway an. Die Konfigurationsdatei befindet sich standardmäßig in ./config/config.yaml. (Version 2.4.x hinzugefügt) |
-t, --token |
(Optional) Ermöglicht die Verwendung eines OAuth-Tokens anstelle von Nutzername/Passwort zur Authentifizierung.
Siehe auch API-Aufrufe mit einem OAuth2-Zugriffstoken sichern.
Beispiel:edgemicro configure -o docs -e test -t <your token> |
-d, --debug |
(Optional) Enthält Informationen zur Fehlerbehebung. |
-h, --help |
Nutzungsinformationen ausgeben. |
Verwendungshinweise
Mit diesem Befehl werden Konfigurationsinformationen in ~/.edgemicro/org-env-config.yaml
gespeichert.
Beispiel
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
Ausgabe
Bei Erfolg gibt der Befehl eine Reihe von Schlüsseln zurück, die Sie beim Starten von Edge Microgateway verwenden müssen.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Edge Microgateway starten
Bevor Sie Edge Microgateway starten, müssen Sie zuerst edgemicro config (Public Cloud) oder edgemicro private config (Private Cloud) ausführen. Der Konfigurationsbefehl gibt die Schlüssel- und Secret-Werte zurück, die zum Starten von Edge Microgateway erforderlich sind.
Nutzung
edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-k, --key |
Der zurückgegebene Schlüsselwert, der zurückgegeben wird, wenn Sie den Befehl „edgemicro
configure “ ausführen. |
-s, --secret |
Der zurückgegebene Secret-Wert, der zurückgegeben wird, wenn Sie den Befehl „edgemicro
configure “ ausführen. |
-p, --processes |
(Optional) Die Anzahl der zu startenden Prozesse. Standardeinstellung: Die Anzahl der Kerne in Ihrem System. |
-d, --pluginDir |
(Optional) Absoluter Pfad zum Plug-in-Verzeichnis. |
-r, --port |
(Optional) Überschreibt die in der Datei ~/.edgemicro/org-env-config.yaml angegebene Portnummer. Standardeinstellung: 8.000 |
-c, --cluster |
(Optional) Startet Edge Microgateway im Clustermodus. Hinweis: In Version 2.3.1 wurde diese Option entfernt. In v2.3.1 und höher startet Edge Micro immer im Clustermodus. |
-c, --configDir |
(Optional) Gibt den Pfad zur Konfigurationsdatei von Edge Microgateway an. Die Konfigurationsdatei befindet sich standardmäßig in ./config/config.yaml. (Version 2.4.x hinzugefügt) |
-u, --configUrl |
(Optional) Gibt einen Endpunkt an, von dem Edge Microgateway seine Konfigurationsdatei herunterlädt. (Version 2.5.x hinzugefügt) |
-d, --debug |
(Optional) Enthält Informationen zur Fehlerbehebung. |
-h, --help |
Nutzungsinformationen ausgeben. |
Port festlegen
Mit dem Befehl start
können Sie eine Portnummer angeben, um den in der Konfigurationsdatei angegebenen Port zu überschreiben. Sie können auch mit der Umgebungsvariable PORT
eine Portnummer angeben. Beispiel:
edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002
oder
export PORT=8002 edgemicro start -o org -e test -k key -s secret -p 2
Wenn der Port verwendet wird, gibt Edge Microgateway einen Fehler zurück.
Clustering
Edge Microgateway verwendet das Node.js-Clustermodul, um das Clustering zu aktivieren. Durch Clustering kann Edge Microgateway Mehrkernsysteme nutzen. Weitere Informationen finden Sie in dieser Node.js-Dokumentation.
Beispiel
edgemicro start -o docs -e test -k abc123 -s xyz456
Beispielausgabe:
... 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
Tokens verwalten
Mit den token
-Befehlen können Sie signierte OAuth2-Zugriffstokens abrufen, decodieren und prüfen. Siehe auch
API-Aufrufe mit einem OAuth2-Zugriffstoken sichern.
Token decodieren
Decodiert ein signiertes, codiertes Inhabertoken in seine Darstellung im Nur-Text-JSON-JWT (Java Web Token). Ein Token überträgt Informationen über die Apigee Edge-Entwickleranwendung, die die zum Erstellen des Tokens verwendeten Schlüssel bereitgestellt hat, einschließlich Anwendungsname, Client-ID, Produktliste und mehr.
Nutzung
edgemicro token decode -f [filename]
Parameter
Parameter | Beschreibung |
---|---|
-f, --file |
Der Name einer Datei, die das zu decodierende JWT-Token enthält. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro token decode -f token.jwt
Ausgabe (Beispiel)
{ 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: '' }
Token generieren
Generiert ein signiertes Inhabertoken. Mit dem Token können Client-Apps authentifizierte API-Aufrufe an Edge Microgateway ausführen. Das Token ist ein OAuth 2.0-kompatibles JSON Web Token (JWT). Sie erfordert als Eingabe die Werte für den Consumer-Key (Client-ID) und das Consumer Secret (Clientschlüssel) aus einer registrierten Entwickler-App auf Apigee Edge. Siehe auch API-Aufrufe mit einem OAuth2-Zugriffstoken sichern.
Nutzung
edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-1, --key |
Die Client-ID aus der Entwickler-App, die Ihrem Microgateway-Aware Proxy zugeordnet ist. |
-s, --secret |
Der Clientschlüssel aus der Entwickler-App, der Ihrem Microgateway-Aware Proxy zugeordnet ist. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz
Ausgabe (Beispiel)
{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3 EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2 VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5 f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0 TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3 2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }
Sie können ein JWT auch mithilfe der Verwaltungs-API generieren:
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" }'
Wobei:
- $ORG ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator sein).
- $ENV ist eine Umgebung in Ihrer Organisation (z. B. „test“ oder „prod“).
- $CLIENT_ID ist die Nutzer-ID in der Entwickler-App, die Sie zuvor erstellt haben.
- $CLIENT_SECRET ist das Consumer Secret in der Entwickler-App, die Sie zuvor erstellt haben.
Token verifizieren
Überprüft ein signiertes Inhabertoken anhand des öffentlichen Schlüssels, der in Apigee Edge für die angegebene Organisation und Umgebung gespeichert ist.
Nutzung
edgemicro token verify -o [org] -e [env] -f [filename]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-f, --file |
Der Name einer Datei, die das zu überprüfende JWT enthält. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro token get -o docs -e test -f token.jwt
Beispielausgabe für ein gültiges Token
{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217', client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS', scopes: [], api_product_list: [ 'MicroTest' ], iat: 1436396155, exp: 1436397954 }
Beispielausgabe für ungültiges Token
{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }
Beispielausgabe für abgelaufenes Token
{ [TokenExpiredError: jwt expired] name: 'TokenExpiredError', message: 'jwt expired', expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }
Neue Edge Microgateway-Konfiguration initialisieren
Führen Sie diesen Befehl nach der ersten Installation von Edge Microgateway einmal aus. Erstellt eine neue Standardkonfigurationsdatei: ~/.edgemicro/default.yaml
.
Nutzung
edgemicro init
Parameter
Parameter | Beschreibung |
---|---|
-c, --configDir |
(Optional) Gibt den Pfad zur Konfigurationsdatei von Edge Microgateway an. Die Konfigurationsdatei befindet sich standardmäßig in ./config/config.yaml. (Version 2.4.x hinzugefügt) |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro init
Ausgabe (Erfolg)
config initialized to /MyHome/.edgemicro/default.yaml
Edge Microgateway-Konfiguration prüfen
Überprüft, ob Edge Microgateway ordnungsgemäß konfiguriert ist.
Nutzung
edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]
Parameter
Beispiel
edgemicro verify -o docs -e test -k abc123 -s xyz456
Ausgabe (Erfolg)
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
Status des Microgateway-Clusters prüfen
Edge Microgateway wird standardmäßig im Clustermodus gestartet. Mit diesem Befehl können Sie den Status des Clusters prüfen.
Nutzung
edgemicro status
Parameter
Parameter | Beschreibung |
---|---|
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro status
Ausgabe (Erfolg)
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 edgemicro is running with 8 workers
Mikrogateway-Cluster beenden
Beendet den Edge Microgateway-Cluster.
Nutzung
edgemicro stop
Parameter
Parameter | Beschreibung |
---|---|
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro stop
Ausgabe (Erfolg)
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 Stop Completed Successfully
Microgateway-Cluster aktualisieren
Bietet einen Neustart nach einer Konfigurationsänderung ohne Ausfallzeiten. Das Edge Microgateway wird durch Abrufen einer neuen Konfiguration neu geladen.
Nutzung
edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-k, --key |
Der zurückgegebene Schlüsselwert, der zurückgegeben wird, wenn Sie den Befehl „edgemicro
configure “ ausführen. |
-s, --secret |
Der zurückgegebene Secret-Wert, der zurückgegeben wird, wenn Sie den Befehl „edgemicro
configure “ ausführen. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro reload -o docs -e test -k abc123 -s xyz456
Ausgabe (Erfolg)
... Reload Completed Successfully
Edgemicro-auth-Proxy aktualisieren
Wenn Sie die Schlüsselrotation verwenden möchten, muss in Ihrer Apigee Edge-Organisation ein aktualisierter Edgemicro-Auth-Proxy bereitgestellt sein. (Version 2.5.x hinzugefügt)
Hinweis: Wenn Sie Ihre aktuelle Edge Micro-Instanz vor Version 2.5.2 konfiguriert haben, müssen Sie diesen Proxy aktualisieren, wenn Sie die Schlüsselrotation verwenden möchten. Sie müssen dieses Upgrade nur einmal ausführen.
Nutzung
edgemicro upgradeauth -o [organization] -e [environment] -u [username]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-u, --username |
Ihren Apigee-Nutzernamen. Sie müssen Organisationsadministrator für die angegebene Organisation sein. |
-p, --password |
Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, erhalten Sie eine entsprechende Aufforderung. |
-v, --virtualhost |
(Optional) Der virtuelle Host des Proxys. |
-b, --baseuri |
(Optional) Der Basis-URI für Ihre Organisation in Apigee Edge. Die Standardeinstellung ist der Basis-URI für Apigee-Cloudbereitstellungen: api.enterprise.apigee.com. Bei lokalen Bereitstellungen kann die Basis-URL anders sein. |
Beispiel
edgemicro upgradeauth -o docs -e test -u jdoe@example.com
Ausgabe (Erfolg)
Bei Erfolg gibt der Befehl eine Ausgabe wie die folgende zurück:
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
KVM-Upgrade (Key Value Map)
Verwenden Sie den Befehl edgemicro upgradekvm
, um ein Upgrade der KVM in Ihrer Apigee-Organisation durchzuführen. Wenn Sie die Schlüsselrotation verwenden möchten, ist ein KVM-Upgrade erforderlich.
Nutzung
Edge für öffentliche Cloud:
edgemicro upgradekvm -o [organization] -e [environment] -k [key] -s [secret]
Edge für Private Cloud:
edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-k, --key |
Der zurückgegebene Schlüsselwert, der zurückgegeben wird, wenn Sie den Befehl „edgemicro
configure “ ausführen. |
-s, --secret |
Der zurückgegebene Secret-Wert, der zurückgegeben wird, wenn Sie den Befehl „edgemicro
configure “ ausführen. |
-p, --proxyuri |
Der URI für den edgemicro_auth-Proxy Edge Public Cloud: optional. Edge Private Cloud: Erforderlich. Beispiel für eine Edge Public Cloud: -p 'https://[org]-[env].apigee.net/edgemicro-auth' Beispiel für eine Edge Private Cloud: -p 'https://[hostname]/edgemicro-auth' |
Beispiel
edgemicro upgradekvm -o docs -e test \ -k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \ -s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47
Ausgabe (Erfolg)
Bei Erfolg gibt der Befehl eine Ausgabe wie die folgende zurück:
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
Schlüsselrotation
Verwenden Sie den Befehl edgemicro rotatekey
, um die öffentlichen/privaten Schlüsselpaare zu rotieren, mit denen die JWT-Tokens generiert wurden, die für die OAuth-Sicherheit auf Edge Microgateway verwendet wurden.
Weitere Informationen finden Sie unter JWT-Schlüssel rotieren.
Nutzung
Edge für öffentliche Cloud:
edgemicro rotatekey -o [organization] -e [environment] -k [key] -s [secret]
Edge für Private Cloud:
edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
(Erforderlich) Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
(Erforderlich) Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-k, --key |
Der zurückgegebene Schlüsselwert, der zurückgegeben wird, wenn Sie den Befehl „edgemicro
configure “ ausführen. |
-s, --secret |
Der zurückgegebene Secret-Wert, der zurückgegeben wird, wenn Sie den Befehl „edgemicro
configure “ ausführen. |
-p |
Pfad zu einem benutzerdefinierten privaten Schlüssel, der von Apigee Edge verwendet werden soll. (Version 3.1.6 hinzugefügt) |
-c |
Pfad zu einem benutzerdefinierten Zertifikat, das von Apigee Edge verwendet werden soll. (Version 3.1.6 hinzugefügt) |
-n, --nbf |
Konfigurieren Sie die Verzögerung in Minuten, bis ein neuer privater Schlüssel wirksam wird. Durch diese Verzögerung können Mikrogateway-Instanzen mit dem neuen öffentlichen Schlüssel aktualisiert werden. Es empfiehlt sich, die Verzögerung auf einen größeren Wert als die Konfigurationseinstellung
Hinweis: Wenn Sie diese Option mit Versionen von |
-i, --kid |
(Optional) Eine ID, die einem bestimmten Schlüssel zugeordnet wird. Edge Microgateway verwendet diesen Wert, um während der Schlüsselrotation aus einem Satz von Schlüsseln auszuwählen. Wenn dieser Parameter weggelassen wird (empfohlen), generiert Edge Microgateway einen zeitstempelbasierten Schlüssel. Weitere Informationen findest du in Abschnitt 4.5 der JSON-Webschlüsselspezifikation. |
-r, --rotatekeyuri |
URI des Schlüssels rotieren Edge Public Cloud: Optional. Edge Private Cloud: Erforderlich. Beispiel für eine öffentliche Cloud: -r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey' Beispiel für eine Edge Private Cloud: -r '[hostname]/edgemicro-auth/rotateKey' |
Beispiel
edgemicro rotatekey -o docs -e test \ -k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \ -s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47
Ausgabe (Erfolg)
Bei Erfolg gibt der Befehl eine Ausgabe wie die folgende zurück:
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!
Nach der Rotation können Sie in der Edge-Benutzeroberfläche sehen, dass der Mikrogateway-KVM neue Schlüssel hinzugefügt wurden.
Beispiel
In diesem Beispiel werden die Flags -p
und -c
verwendet, um den Pfad zu einem privaten Schlüssel/Zertifikat-Paar anzugeben. Mit diesen Optionen können Sie einen benutzerdefinierten privaten Schlüssel und ein Zertifikat-Paar übergeben.
edgemicro rotatekey -o docs -e test \ -k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \ -s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \ -p /users/home/keys.pem -c /users/home/cert.cert
Dauerhaftes Monitoring
Verwenden Sie den Befehl edgemicro forever
, um die Methode Endgültig zu verwalten. Dieses Node.js-Tool startet eine Node.js-Anwendung automatisch neu, falls die Anwendung ausfällt oder ein Fehler auftritt.
Weitere Informationen finden Sie unter
Dauerhaftes Monitoring.
Nutzung
Sie müssen die folgenden Umgebungsvariablen festlegen, bevor Sie den Befehl edgemicro forever
ausführen:
EDGEMICRO_ORG
: Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.EDGEMICRO_ENV
: Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.EDGEMICRO_KEY
: Das zurückgegebene Schlüssel/Wert-Paar, das bei Ausführung des Befehls „edgemicroconfigure“ zurückgegeben wurde.EDGEMICRO_SECRET
: Der zurückgegebene Secret-Wert, der beim Ausführen des Befehls "edgemicroconfigure" zurückgegeben wurde.
edgemicro forever -f [forever_file] -a [start|stop]
Parameter
Parameter | Beschreibung |
---|---|
-f, --file | Gibt den Speicherort der Datei forever.json an. |
-a, --action | start oder stop . Die Standardeinstellung ist „start“. |
Beispiele:
So starten Sie einen dauerhaften Zugriff:
edgemicro forever -f ~/mydir/forever.json -a start
So beenden Sie die Option „Endgültig“:
edgemicro forever -a stop
Schlüssel widerrufen
Verwenden Sie den Befehl edgemicro revokekeys
, um die Schlüssel- und Secret-Anmeldedaten für eine Edge Microgateway-Konfiguration zu widerrufen.
Nutzung
edgemicro revokekeys -o [organization] -e [environment] -u [username] -k [key] -s [secret]
Parameter
Parameter | Beschreibung |
---|---|
-o, --org |
(Erforderlich) Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben. |
-e, --env |
(Erforderlich) Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben. |
-u, --username |
(Entweder -u oder -t ist erforderlich) Ihr Apigee-Nutzername. Sie müssen Organisationsadministrator für die angegebene Organisation sein. Dieser Parameter ist nicht erforderlich, wenn Sie stattdessen den Parameter -t angeben. |
-p, --password |
Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, erhalten Sie eine entsprechende Aufforderung. |
-k, --key |
(Erforderlich) Der Schlüssel, der widerrufen werden soll. |
-s, --secret |
(Erforderlich) Das zu widerrufende Secret. |
-t, --token |
(Entweder -u oder -t ist erforderlich) Damit können Sie anstelle von Nutzername/Passwort ein OAuth-Token zur Authentifizierung verwenden. Wenn -t angegeben ist, ist der Parameter -u nicht erforderlich. Siehe auch API-Aufrufe mit einem OAuth2-Zugriffstoken sichern. Beispiel:
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \ -s KEY-SECRET -t TOKEN |
Beispiele
edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com -k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513
Bei Erfolg wird die folgende Meldung angezeigt:
key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully