Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

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

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

Edge Microgateway v. 3.3.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 du porteur 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 mappage clé-valeur (KVM) chiffré. 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 mappage clé-valeur (KVM) chiffré 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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-u, --username`	Votre nom d'utilisateur Apigee Vous devez être un administrateur de l'organisation spécifiée.
`-p, --password`	(Facultatif) Votre mot de passe. Vous serez invité à le faire si vous ne fournissez pas ce paramètre sur la ligne de commande.
`-f, --force`	(Facultatif) Si une clé est déjà stockée dans le mappage clé-valeur chiffré, forcez son remplacement.
`-h, --help`	Afficher les informations d'utilisation.

Exemple

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

Résultat

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

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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-u, --username`	Votre nom d'utilisateur Apigee Vous devez être un administrateur de l'organisation spécifiée.
`-p, --password`	(Facultatif) Votre mot de passe. Vous serez invité à le faire si vous ne fournissez pas ce paramètre sur la ligne de commande.
`-h, --help`	Afficher les informations d'utilisation.

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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-u, --username`	Votre nom d'utilisateur Apigee Vous devez être un administrateur de l'organisation spécifiée.
`-p, --password`	(Facultatif) Votre mot de passe. Vous serez invité à le faire si vous ne fournissez pas ce paramètre sur la ligne de commande.
`-h, --help`	Afficher les informations d'utilisation.

Exemple

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

Résultat (réussite)

checked cert successfully

Sortie (É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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-h, --help`	Afficher les informations d'utilisation.

Exemple

edgemicro cert public-key -o docs -e test

Sortie (exemple)

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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-u, --username`	Votre nom d'utilisateur Apigee Vous devez être un administrateur de l'organisation spécifiée.
`-p, --password`	(Facultatif) Votre mot de passe. Vous serez invité à le faire si vous ne fournissez pas ce paramètre sur la ligne de commande.
`-r, --url`	(Facultatif) Spécifie l'alias d'hôte virtuel pour votre organisation:environnement. Consultez la documentation Edge pour en savoir plus sur les hôtes virtuels. Par défaut : `org-env.apigee.net`
`-c, --configDir`	(Facultatif) Spécifie le chemin d'accès au fichier de configuration Edge Microgateway. Par défaut, le fichier de configuration se trouve dans ./config/config.yaml. (Ajouté dans la version 2.4.x)
`-x, --proxyName`	(Facultatif) Définit le chemin de base du proxy edgemicro-auth. Si le proxy edgemicro-auth est déployé sous un chemin d'accès différent de celui par défaut, /edgemicro-auth, cette fonctionnalité vous permet de définir le nouveau chemin d'accès dans Edge Microgateway. Par défaut, le chemin de base est /edgemicro-auth. (Ajouté v2.4.x)
`-t, --token`	(Facultatif) Vous permet d'utiliser un jeton OAuth pour l'authentification au lieu d'un nom d'utilisateur et d'un mot de passe. Consultez également Sécuriser les appels d'API avec un jeton d'accès OAuth2. Exemple : `edgemicro configure -o docs -e test -t <your token>`
`-v, --virtualHosts`	(Facultatif) Remplace les hôtes virtuels par défaut, qui sont "`default,secure`". Utilisez cette option si vous avez spécifié des hôtes virtuels pour votre environnement d'organisation Edge autres que ceux par défaut. Consultez la documentation Edge pour en savoir plus sur les hôtes virtuels.
`-d, --debug`	(Facultatif) Fournit des informations de débogage.
`-h, --help`	Afficher les informations d'utilisation.

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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-u, --username`	Votre nom d'utilisateur Apigee Vous devez être un administrateur de l'organisation spécifiée.
`-p, --password`	(Facultatif) Votre mot de passe. Vous serez invité à le faire si vous ne fournissez pas ce paramètre sur la ligne de commande.
`-t, --token`	(Facultatif) Vous permet d'utiliser un jeton OAuth pour l'authentification au lieu d'un nom d'utilisateur et d'un mot de passe. Consultez également Sécuriser les appels d'API avec un jeton d'accès OAuth2. Exemple : `edgemicro genkeys -o docs -e test -t <your token>`
`-h, --help`	Afficher les informations d'utilisation.

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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-u, --username`	Votre nom d'utilisateur Apigee Vous devez être un administrateur de l'organisation spécifiée.
`-p, --password`	(Facultatif) Votre mot de passe. Vous serez invité à le faire si vous ne fournissez pas ce paramètre sur la ligne de commande.
`-r, --runtime-url`	Spécifie l'URL d'exécution de votre instance de cloud privé.
`-m, --mgmt-url`	URL du serveur de gestion de votre instance de cloud privé.
`-v, --virtualHosts`	Liste des hôtes virtuels pour votre organisation:environnement, séparés par une virgule. La valeur par défaut est "`default,secure`".
`-c, --configDir`	(Facultatif) Spécifie le chemin d'accès au fichier de configuration Edge Microgateway. Par défaut, le fichier de configuration se trouve dans ./config/config.yaml. (Ajouté dans la version 2.4.x)
`-t, --token`	(Facultatif) Vous permet d'utiliser un jeton OAuth pour l'authentification au lieu d'un nom d'utilisateur et d'un mot de passe. Consultez également Sécuriser les appels d'API avec un jeton d'accès OAuth2. Exemple : `edgemicro configure -o docs -e test -t <your token>`
`-d, --debug`	(Facultatif) Fournit des informations de débogage.
`-h, --help`	Afficher les informations d'utilisation.

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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-k, --key`	Valeur de clé renvoyée lorsque vous exécutez la commande "`edgemicro configure`".
`-s, --secret`	Valeur secrète renvoyée lorsque vous exécutez la commande "`edgemicro configure`".
`-p, --processes`	(Facultatif) Nombre de processus à démarrer. Par défaut : nombre de cœurs de votre système.
`-d, --pluginDir`	(Facultatif) Chemin d'accès absolu au répertoire du plug-in.
`-r, --port`	(Facultatif) Remplace le numéro de port spécifié dans le fichier ~`/.edgemicro/org-env-config.yaml`. Par défaut : 8000
`-c, --cluster`	(Facultatif) Démarre Edge Microgateway en mode cluster. Remarque : Cette option a été supprimée à partir de la version 2.3.1. Dans la version 2.3.1 et les versions ultérieures, Edge Micro démarre toujours en mode cluster.
`-c, --configDir`	(Facultatif) Spécifie le chemin d'accès au fichier de configuration Edge Microgateway. Par défaut, le fichier de configuration se trouve dans ./config/config.yaml. (Ajouté dans la version 2.4.x)
`-u, --configUrl`	(Facultatif) Spécifie un point de terminaison à partir duquel Edge Microgateway téléchargera son fichier de configuration. (Ajouté dans la version 2.5.x)
`-d, --debug`	(Facultatif) Fournit des informations de débogage.
`-h, --help`	Afficher les informations d'utilisation.

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

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 :

...

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

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

Paramètres	Description
`-f, --file`	Nom d'un fichier contenant le jeton JWT à décoder.
`-h, --help`	Afficher les informations d'utilisation.

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é. Le 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 la clé client (ID client) et du 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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-1, --key`	ID client de l'application de développeur associée à votre proxy compatible avec le microgateway.
`-s, --secret`	Code secret du client de l'application de développeur associée à votre proxy compatible avec Microgateway.
`-h, --help`	Afficher les informations d'utilisation.

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

Vous pouvez également générer un JWT à l'aide de l'API Management :

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

Où :

$ORG est le nom de votre organisation Edge (vous devez être administrateur de l'organisation).
$ENV est un environnement de votre organisation (par exemple, "test" ou "prod").
$CLIENT_ID correspond au numéro client de l'application de développeur que vous avez créée précédemment.
$CLIENT_SECRET est le code secret du consommateur dans l'application pour les développeurs que vous avez créée précédemment.

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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-f, --file`	Nom d'un fichier contenant le jeton JWT à valider.
`-h, --help`	Afficher les informations d'utilisation.

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

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

Paramètres	Description
`-c, --configDir`	(Facultatif) Spécifie le chemin d'accès au fichier de configuration Edge Microgateway. Par défaut, le fichier de configuration se trouve dans ./config/config.yaml. (Ajouté dans la version 2.4.x)
`-h, --help`	Afficher les informations d'utilisation.

Exemple

edgemicro init

Résultat (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

Résultat (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

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

Paramètres	Description
`-h, --help`	Afficher les informations d'utilisation.

Exemple

edgemicro status

Résultat (réussite)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
edgemicro is running with 8 workers

Arrêter le cluster de micro-passerelles

Arrête le cluster Edge Microgateway.

Utilisation

edgemicro stop

Paramètres

Paramètres	Description
`-h, --help`	Afficher les informations d'utilisation.

Exemple

edgemicro stop

Résultat (réussite)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
Stop Completed Successfully

Recharger le cluster de micro-passerelle

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

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-k, --key`	Valeur de clé renvoyée lorsque vous exécutez la commande "`edgemicro configure`".
`-s, --secret`	Valeur secrète renvoyée lorsque vous exécutez la commande "`edgemicro configure`".
`-h, --help`	Afficher les informations d'utilisation.

Exemple

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

Résultat (réussite)

...

Reload Completed Successfully

Mettre à niveau le proxy edgemicro-auth

Pour utiliser la rotation des clés, vous devez avoir déployé un proxy edgemicro-auth mis à niveau dans votre organisation Apigee Edge. (Ajouté dans la version 2.5.x)

Remarque : Si vous avez configuré votre instance Edge Micro actuelle avant la version 2.5.2, vous devez mettre à niveau ce proxy si vous souhaitez utiliser la rotation des clés. Vous n'aurez à effectuer cette mise à niveau qu'une seule fois.

Utilisation

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

Paramètres

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-u, --username`	Votre nom d'utilisateur Apigee Vous devez être un administrateur de l'organisation spécifiée.
`-p, --password`	(Facultatif) Votre mot de passe. Vous serez invité à le faire si vous ne fournissez pas ce paramètre sur la ligne de commande.
`-v, --virtualhost`	(Facultatif) Hôte virtuel du proxy.
`-b, --baseuri`	(Facultatif) URI de base de votre organisation sur Apigee Edge. L'URI de base par défaut pour les déploiements cloud Apigee est api.enterprise.apigee.com. Pour les déploiements sur site, l'URL de base peut être différente.

Exemple

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

Résultat (réussite)

Si l'opération réussit, la commande renvoie un résultat semblable à celui-ci :

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

Mise à niveau du mappage clé-valeur (KVM)

Utilisez la commande edgemicro upgradekvm pour mettre à niveau le KVM dans votre organisation Apigee. La mise à niveau de KVM est requise si vous souhaitez utiliser la rotation des clés.

Utilisation

Edge pour le cloud public :

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

Edge pour le cloud privé :

edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'

Paramètres

Paramètres	Description
`-o, --org`	Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	Environnement pour lequel vous avez configuré Edge Microgateway.
`-k, --key`	Valeur de clé renvoyée lorsque vous exécutez la commande "`edgemicro configure`".
`-s, --secret`	Valeur secrète renvoyée lorsque vous exécutez la commande "`edgemicro configure`".
`-p, --proxyuri`	URI du proxy edgemicro_auth Cloud public Edge : facultatif. Cloud privé Edge : obligatoire. Exemple de cloud public Edge : -p 'https://[org]-[env].apigee.net/edgemicro-auth' Exemple de cloud privé Edge : -p 'https://[hostname]/edgemicro-auth'

Exemple

edgemicro upgradekvm -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Résultat (réussite)

Si l'opération réussit, la commande renvoie un résultat semblable à celui-ci :

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

Rotation des clés

Utilisez la commande edgemicro rotatekey pour faire pivoter les paires de clés publique/privée qui ont été utilisées pour générer les jetons JWT utilisés pour la sécurité OAuth sur Edge Microgateway.

Pour en savoir plus, consultez Rotation des clés JWT.

Utilisation

Edge pour le cloud public :

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

Edge pour le cloud privé :

edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'

Paramètres

Paramètres	Description
`-o, --org`	(Obligatoire) Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	(Obligatoire) Environnement pour lequel vous avez configuré Edge Microgateway.
`-k, --key`	Valeur de clé renvoyée lorsque vous exécutez la commande "`edgemicro configure`".
`-s, --secret`	Valeur secrète renvoyée lorsque vous exécutez la commande "`edgemicro configure`".
`-p`	Chemin d'accès à une clé privée personnalisée à utiliser par Apigee Edge. (Ajouté dans la version 3.1.6)
`-c`	Chemin d'accès à un certificat personnalisé à utiliser par Apigee Edge. (Ajouté dans la version 3.1.6)
`-n, --nbf`	Configurez le délai en minutes avant qu'une nouvelle clé privée ne devienne effective. Ce délai permet aux instances de microgateway d'être actualisées avec la nouvelle clé publique. Il est recommandé de définir un délai supérieur au paramètre de configuration `config_change_poll_internal`, qui est de 10 minutes par défaut. Pour en savoir plus, consultez Configurer un délai "pas avant". (Ajouté dans la version 3.1.6) Remarque : Si vous utilisez cette option avec des versions de `edgemicro-auth` antérieures à celle distribuée avec Edge Microgateway 3.1.6, l'indicateur est ignoré.
`-i, --kid`	(Facultatif) ID utilisé pour faire correspondre une clé spécifique. Edge Microgateway utilise cette valeur pour choisir parmi un ensemble de clés lors de la rotation des clés. Si ce paramètre est omis (recommandé), Edge Microgateway génère une clé basée sur un code temporel. Pour en savoir plus, consultez la section 4.5 de la spécification JSON Web Key.
`-r, --rotatekeyuri`	Faites tourner l'URI de la clé. Cloud public Edge : facultatif. Cloud privé Edge : obligatoire. Exemple de cloud public : -r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey' Exemple de cloud privé Edge : -r '[hostname]/edgemicro-auth/rotateKey'

Exemple

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Résultat (réussite)

Si l'opération réussit, la commande renvoie un résultat semblable à celui-ci :

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!

Après la rotation, vous pouvez voir dans l'interface utilisateur Edge que de nouvelles clés ont été ajoutées au KVM de la passerelle de microservices.

Exemple

Cet exemple utilise les options -p et -c pour spécifier le chemin d'accès à une paire clé privée/certificat. Ces options vous permettent de transmettre une paire de clé privée et de certificat personnalisée.

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \
-p /users/home/keys.pem -c /users/home/cert.cert

Surveillance continue

Supprimée : cette fonctionnalité de la CLI a été supprimée dans la version 3.3.3 d'Edge Microgateway. Vous pouvez remplacer forever-monitor par PM2. Pour en savoir plus, consultez ce post de la communauté Apigee : Edgemicro + PM2: Starting edgemicro as a service. Consultez également les notes de version d'Edge Microgateway 3.3.3.

Révoquer des clés

Exécutez la commande edgemicro revokekeys pour révoquer les identifiants de clé et de code secret d'une configuration Edge Microgateway.

Utilisation

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

Paramètres

Paramètres	Description
`-o, --org`	(Obligatoire) Organisation Apigee pour laquelle vous avez configuré Edge Microgateway.
`-e, --env`	(Obligatoire) Environnement pour lequel vous avez configuré Edge Microgateway.
`-u, --username`	(`-u` ou `-t` est obligatoire) Votre nom d'utilisateur Apigee. Vous devez être un administrateur de l'organisation spécifiée. Ce paramètre n'est pas obligatoire si vous spécifiez le paramètre `-t`.
`-p, --password`	(Facultatif) Votre mot de passe. Vous serez invité à le faire si vous ne fournissez pas ce paramètre sur la ligne de commande.
`-k, --key`	(Obligatoire) Clé à révoquer.
`-s, --secret`	(Obligatoire) Secret à révoquer.
`-t, --token`	(`-u` ou `-t` sont obligatoires) Vous permet d'utiliser un jeton OAuth pour l'authentification au lieu d'un nom d'utilisateur/mot de passe. Si `-t` est spécifié, le paramètre `-u` n'est pas obligatoire. Consultez également Sécuriser les appels d'API avec un jeton d'accès OAuth2. Exemple : edgemicro revokekeys -o `ORG-NAME` -e `ENV-NAME` -k `KEY-TO-REVOKE` \ -s `KEY-SECRET` -t `TOKEN`

Exemples

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

Si l'opération réussit, le message suivant s'affiche :

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully