Documentation de référence sur la CLI pour Edge Microtation

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.

Présentation

L'interface de ligne de commande Edge Microgateway vous permet de contrôler et de gérer tous les aspects d'une instance Edge Microgateway.

Gérer les certificats

Les commandes cert vous permettent d'installer et de gérer la paire de clés publique/privée utilisée pour signer les jetons porteurs utilisés par les clients pour effectuer des appels sécurisés via Edge Microgateway. Les clés sont stockées sur Apigee Edge dans un coffre-fort sécurisé. Edge Microgateway utilise la clé publique pour valider les jetons porteurs signés. Ces clés sont générées lorsque vous exécutez la commande edgemicro configure, comme expliqué dans Configurer Edge Microgateway. Vous pouvez utiliser les commandes cert décrites ici pour régénérer et gérer ces clés si nécessaire. 

Installer un certificat

Installe les clés dans un coffre-fort à l'aide du service de stockage sécurisé Apigee Edge et renvoie la clé publique en sortie. Les paires de clés sont limitées à une organisation spécifique.

Utilisation

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

Paramètres

Exemple

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

Résultat

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

Supprimer un certificat

Supprime la paire de clés pour une organisation.

Utilisation

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

Paramètres

Exemple

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

Résultat

deleting vault
Vault deleted!

Vérifier un certificat

Vérifie qu'un certificat est installé dans votre organisation.

Utilisation

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

Paramètres

Exemple

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

Sortie (réussite)

checked cert successfully

Résultat (échec)

Si le certificat n'existe pas, une erreur est renvoyée.

Obtenir la clé publique

Renvoie la clé publique pour l'organisation spécifiée. Ne nécessitent pas d'authentification.

Utilisation

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

Paramètres

Exemple

edgemicro cert public-key -o docs -e test

Sortie (exemple)

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

Configurer Edge Microgateway pour Apigee Edge Cloud

Permet à Edge Microgateway de fonctionner avec une instance Apigee Edge Cloud. Il encapsule et exécute une séquence de commandes pour déployer un proxy d'authentification requis sur Edge, générer des jetons d'authentification et mettre à jour les fichiers de configuration. Pour obtenir un exemple fonctionnel complet, consultez Configurer Edge Microgateway.

Utilisation

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

Paramètres

Remarques sur l'utilisation

Cette commande stocke les informations de configuration dans ~/.edgemicro/org-env-config.yaml.

Exemple

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

Résultat

Si l'opération réussit, la commande renvoie un ensemble de clés que vous devez utiliser lorsque vous démarrez Edge Microgateway.

...

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

edgemicro configuration complete!

Générer des clés

La commande genkeys génère une paire clé/code secret utilisée par Edge Microgateway pour s'authentifier lors de l'envoi asynchrone de données analytiques à Apigee Edge.

Utilisation

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

Paramètres

Remarques sur l'utilisation

Si l'opération réussit, la commande renvoie trois éléments. La première est une URL que vous devez placer dans le fichier de configuration. Les deux autres sont une paire de clés requise lorsque vous démarrez une instance Edge Microgateway.

• URL d'amorçage : cette URL pointe vers un service Apigee Edge qui permet à une instance Edge Microgateway d'envoyer des données analytiques à Apigee Edge. Vous devez copier cette URL dans le fichier de configuration Edge Microgateway : ~/.edgemicro/org-env-config.yaml.
• key : clé. Cette clé et le secret sont nécessaires en tant qu'entrée de la commande CLI utilisée pour démarrer une instance d'Edge Microgateway.
• secret : code secret.

Exemple

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

Sortie (exemple)

Si l'opération réussit, la commande renvoie un ensemble de clés que vous devez utiliser lorsque vous démarrez 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

Configurer Edge Microgateway pour Apigee Edge Private Cloud

Configure Edge Microgateway pour qu'il fonctionne avec une installation Apigee Edge Private Cloud.

Utilisation

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

Paramètres

Remarques sur l'utilisation

Cette commande stocke les informations de configuration dans ~/.edgemicro/org-env-config.yaml.

Exemple

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

Résultat

Si l'opération réussit, la commande renvoie un ensemble de clés que vous devez utiliser lorsque vous démarrez Edge Microgateway.

...

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

edgemicro configuration complete!

Démarrer Edge Microgateway

Avant de démarrer Edge Microgateway, vous devez d'abord exécuter edgemicro configure (cloud public) ou edgemicro private configure (cloud privé). La commande configure renvoie les valeurs de clé et de code secret requises pour démarrer Edge Microgateway.

Utilisation

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

Paramètres

Définir le port

La commande start vous permet de spécifier un numéro de port pour remplacer celui indiqué dans le fichier de configuration. Vous pouvez également spécifier un numéro de port à l'aide de la variable d'environnement PORT. Exemple :

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

ou

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

Si le port est utilisé, Edge Microgateway renvoie une erreur.

À propos du clustering

Edge Microgateway utilise le module de cluster Node.js pour activer le clustering. Le clustering permet à Edge Microgateway de tirer parti des systèmes multicœurs. Pour en savoir plus, consultez la documentation Node.js. 

Exemple

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

Exemple de résultat :

...

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

Gérer les jetons

Les commandes token vous permettent d'obtenir, de décoder et de valider les jetons d'accès OAuth2 signés. Consultez également Sécuriser les appels d'API avec un jeton d'accès OAuth2. 

Décoder un jeton

Décode un jeton de support signé et encodé dans sa représentation JSON JWT (Java Web Token) en texte brut. Un jeton transmet des informations sur l'application pour les développeurs Apigee Edge qui a fourni les clés utilisées pour créer le jeton, y compris le nom de l'application, le client_id, la liste des produits et plus encore.

Utilisation

edgemicro token decode -f [filename]

Paramètres

Exemple

edgemicro token decode -f token.jwt

Exemple de résultat

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

Générer un jeton

Génère un jeton de support signé. Ce jeton permet aux applications clientes d'effectuer des appels d'API authentifiés vers Edge Microgateway. Le jeton est un jeton Web JSON (JWT) conforme à OAuth 2.0. Il nécessite en entrée les valeurs de clé client (ID client) et de secret client (code secret du client) d'une application de développeur enregistrée sur Apigee Edge. Consultez également Sécuriser les appels d'API avec un jeton d'accès OAuth2.

Utilisation

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

Paramètres

Exemple

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

Exemple de résultat

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

Envoyer une requête HTTP pour obtenir un jeton

Vous pouvez également envoyer une requête HTTP brute pour obtenir le jeton. Voici un exemple de curl. Il vous suffit de remplacer les noms de votre organisation et de votre environnement dans l'URL, et de remplacer les valeurs Consumer Id et Consumer Secret par les paramètres client_id et client_secret :

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

Valider un jeton

Valide un jeton du porteur signé par rapport à la clé publique stockée sur Apigee Edge pour l'organisation et l'environnement spécifiés.

Utilisation

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

Paramètres

Exemple

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

Exemple de résultat pour un jeton valide

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

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Exemple de résultat pour un jeton non valide

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

Exemple de résultat pour un jeton expiré

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

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

Obtenir directement des jetons de support

Vous pouvez préférer obtenir directement des jetons de support en envoyant une requête HTTP au point de terminaison de jeton sur Apigee Edge. Le point de terminaison du jeton réel est implémenté dans le proxy déployé avec la commande CLI deploy-edge-service.

Voici un exemple de curl. Il vous suffit de remplacer les noms de votre organisation et de votre environnement dans l'URL, et de remplacer les valeurs de l'ID client et du code secret client obtenues à partir d'une application de développeur sur Apigee Edge par les paramètres client_id et client_secret :

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

Exemple de résultat :

HTTP/1.1 200 OK

X-Powered-By: Express

Cache-Control: no-store

Pragma: no-cache

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

Content-Length: 640

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

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

Connection: keep-alive

"<long string of numbers and letters>"

Initialiser une nouvelle configuration Edge Microgateway

Exécutez cette commande une fois après avoir installé Edge Microgateway. Crée un fichier de configuration par défaut : ~/.edgemicro/default.yaml.

Utilisation

edgemicro init 

Paramètres

Exemple

edgemicro init

Sortie (réussite)

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

Vérifier la configuration d'Edge Microgateway

Vérifie qu'Edge Microgateway est correctement configuré.

Utilisation

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

Paramètres

Exemple

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

Sortie (réussite)

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

Vérifier l'état du cluster de micro-passerelles

Ajouté : v2.2.4-beta

Par défaut, Edge Microgateway démarre en mode cluster. Vous pouvez utiliser cette commande pour vérifier l'état du cluster.

Utilisation

edgemicro status

Paramètres

Exemple

edgemicro status

Sortie (réussite)

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

Arrêter le cluster de micro-passerelles

Ajouté : v2.2.4-beta

Arrête le cluster Edge Microgateway.

Utilisation

edgemicro stop

Paramètres

Exemple

edgemicro stop

Résultat (réussie)

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

Recharger le cluster de micro-passerelle

Ajouté : v2.2.4-beta

Permet un redémarrage sans temps d'arrêt après une modification de la configuration. Recharge Edge Microgateway en récupérant une nouvelle configuration.

Utilisation

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

Paramètres

Exemple

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

Sortie (réussite)

...

Reload Completed Successfully