Configurer Edge MicroGate

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

Edge Microgateway v. 3.3.x

Présentation

Une fois les étapes de ce guide de configuration terminées, vous disposerez d'une installation Edge Microgateway entièrement configurée et fonctionnelle, capable de traiter les requêtes API. Vous testerez la configuration en effectuant des appels d'API sécurisés via Edge Microgateway vers une cible de backend. Vous apprendrez également à ajouter un plug-in d'arrêt des pics au Microgateway.

Ce guide est divisé en plusieurs parties :

Prérequis : Installer Edge Microgateway

Suivez les instructions de la section Installer Edge Microgateway. Une fois l'installation terminée, vous pourrez suivre les étapes de ce tutoriel.

Partie 1 : Configurer Edge Microgateway

Dans cette partie, vous allez utiliser une commande d'interface de ligne de commande (CLI) pour configurer Edge Microgateway afin qu'il communique avec Apigee Edge.

Étapes de configuration d'Apigee Edge Cloud

Pour utiliser Edge Microgateway avec Apigee Edge Cloud, procédez comme suit :

  1. Initialisez Edge Microgateway (vous ne devez effectuer cette étape qu'une seule fois) :
    edgemicro init
  2. Un fichier de configuration nommé default.yaml a été placé dans votre répertoire d'accueil, dans un sous-répertoire appelé .edgemicro. Vérifiez maintenant que ce fichier existe : 
    ls ~/.edgemicro
default.yaml

    Remarque  : Dans la documentation Edge Microgateway, nous faisons référence au répertoire d'accueil avec le tilde (~), qui est un raccourci UNIX. Si vous utilisez Windows et que vous exécutez un shell qui ne prend pas en charge le tilde, vous devrez remplacer le tilde par la variable d'environnement appropriée dans les commandes qui font référence au répertoire d'accueil. Par exemple : %USERPROFILE%/.edgemicro.

  3. Toutes les commandes CLI disposent d'une fonction d'aide. Affichez l'aide de la commande edgemicro configure :
    edgemicro configure -h
  4. Exécutez la commande suivante pour configurer Edge Microgateway :
    edgemicro configure -o [org] -e [env] -u [username]

    Où :

    • org: Nom de votre organisation Edge (vous devez être administrateur de l'organisation).
    • env: Environnement dans votre organisation (test ou production, par exemple).
    • username:  Adresse e-mail associée à votre compte Apigee.

      Remarque : La commande "configure" autorise des paramètres supplémentaires. Pour obtenir la liste complète, consultez Configurer Edge Microgateway pour Apigee Edge Cloud.

Exemple

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

Résultat

./edgemicro configure -o docs -e test -u jdoe@apigee.com
password:
current nodejs version is v12.5.0
current edgemicro version is 3.1.0
password:
file doesn't exist, setting up
Give me a minute or two... this can take a while...
App edgemicro-auth deployed.
checking org for existing KVM
error checking for cert. Installing new cert.
creating KVM
adding private_key
adding public_key
configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1

saving configuration information to: $HOME/.edgemicro/docs-test-config.yaml

vault info:
 -----BEGIN CERTIFICATE-----
MIICpDCCAYwCCQCQ2mJZJGbPPTANBgkqhkiG9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3QwHhcNMTcwOTA3MjA0ODA4WhcNMTcwOTA4MjA0ODA4WjAUMRIwEAYD
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDw
yzmqi5CelqqtTr6IaFe1ssrMXEDnNtkBh95U6F5zHLsNQhJcyNUAO9um6FLMSqSd
fTztXfWUZzDgmbb6sfbx/9cqpvQ8TIjxyIz8xGM9H4legRQmsCQoYGkLjpPE5ZOa
wZrI5IaVm8LY6vbopPFwxgKOQ9bphx6k9Na055DmNyZAOTMD+4I0m/RdsrnZnYih
3DaFj1tXHKZI1jfAt/QOif5Nmk4+JckYwF+9HBysWUbbvj/gnBjVYF2Isb7q7oFD
lPGhwFoIebMqHMWD8lG7+9RJDO9dDV6f1g1/9waIrq1D+MoVXos9VMstNrPp0cKF
Ue+lAkct8tylH+2MosF7AgMBAAEwDQYJKoZIhvcNAQELBQADggEBAJMRdcQh3ayy
csVVT4TYwxV7MKWRfhDRz6X+MM9frB+Z7sI4+ZoZbXKOoZI2hSjmbdLpkNR/m9eJ
+1Uk0JKmpSY7Q+1rRrvcHsWNysGf4z+zDJXYECTrtSnXKBXtb9SJ8JAfoZOQD0lA
zmKuJjQMLTdiYMHOBR6ZWnaKaRvrQwGHcQrheJm4a90XgZF6jcRR8CPrBzkmsbCp
IU/Ux3E17wDGYPxjJs5otyQG8rN/88RGyaSeXK8rjKr9D4KFGJeasXBKmTG2afAr
yfBvS4h6s42FCOR/eLpmMllVoO9up71Fa3EtV+aK+FNNY9uMbgUHeLQE7z9nn06q
PTmvExZLkLQ=
-----END CERTIFICATE-----

The following credentials are required to start edge micro
  key: 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb
  secret: 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Étapes de configuration d'Apigee Private Cloud

Pour utiliser Edge Microgateway avec Apigee Private Cloud :

  1. Initialisez Edge Microgateway (vous ne devez effectuer cette étape qu'une seule fois) :
    edgemicro init
  2. Affiche des informations d'aide pour la commande edgemicro private configure. Vous pouvez afficher l'aide de cette manière pour n'importe quelle commande ou option de commande de la CLI Edge Microgateway. 
    edgemicro private configure -h
  3. Exécutez la commande ci-dessous. Il nécessite des informations standards sur votre compte Apigee Edge Private Cloud : nom de l'organisation, nom de l'environnement, nom d'utilisateur (adresse e-mail), mot de passe, adresse IP du serveur de gestion et adresse IP du routeur. Vous devez être administrateur de l'organisation Edge pour utiliser cette commande : 
    edgemicro private configure -o [org] -e [env] -u [username] -r [runtime_url] -m [mgmt_url] -v [virtual_host]

    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").
    • runtime_url est l'URL d'exécution de votre instance de cloud privé.
    • mgmt_url est l'URL du serveur de gestion de votre instance de cloud privé.
    • username est l'adresse e-mail associée à votre compte Apigee.
    • virtual_host est une liste de noms d'hôtes virtuels séparés par une virgule. Les valeurs par défaut sont default,secure.

Exemple

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.52.106:9001 -m http://192.162.52.106:8080 -v default

ou, si vous disposez d'un alias d'hôte virtuel myorg-test.mycompany.com, vous pouvez utiliser une commande comme celle-ci :

edgemicro private configure -o docs -e test -u jdoe@example.com -r myorg-test.mycompany.com -m http://192.162.52.106:8080 -v default

Résultat

delete cache config
checking for previously deployed proxies
configuring edgemicro internal proxy
deploying edgemicro internal proxy
deploying  edgemicro-auth  app
copy auth app into tmp dir
copy config into tmp deer
Give me a minute or two... this can take a while...
App edgemicro-auth added to your org. Now adding resources.

checking org for existing KVM
error checking for cert. Installing new cert.
creating KVM
adding private_key
adding public_key
configuring host http://192.168.52.106:9001 for region dc-1

saving configuration information to: $HOME/.edgemicro/jdoe-test-config.yaml
vault info: 
-----BEGIN CERTIFICATE----- 
MIICpDCCAYwCCQDpIvWlpaZJGDANBgkqhkiG9w0BAQFADAUMRIwEAYDVQQDEwls 
b2NhbGhvc3QwHhcNMTYwNDA3MTcxNTM5WhcNMTYwND4MTcxNTM5WjAUMRIwEAYD 
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAUAA4IBDwAwggEKAoIBAQD3 
OAQ+kf5FH0S0yuj05ITqUODuUJspBPberRMbqOZYHcFswhB0Yvg6JKWsKWBDP9o
Xl96dtgH7xPFRqIU0zI452jkMQ1fPz2mSaGwik245yfBku7olooXKRKTRKOUoXa 
q3Hld/RPxGSsWtiyyYtKex7tuFdq0Knm1EhowdTRGIgjNvudeYMka/XPRXuykhd 
xIDxWj4rdX+4GPx9qT2eTQC5nOAC7XHVL7ys4KqsAiv28vw10u400KstFFS8Qho 
7FaE0bOKLolKKadKyA60ha1XIw/uSTD6ZQFWQ+XM3OaRbXePWXnSZioSxXcZT7L 
hMUKbsRXw/TCvRB51LgNAgMBAAEwDQYJKoZIhvcNAQELBQADgEBAOuR1OmE/W6j 
gRAarJB5EQuTEpI/9Zpg5c5RAGjzLhkazsycn7pal+IymUjCV7D0oIxTVuTM8ZZ 
57kR5hF/C1ZypDN9i+KGP2ovX8WOCCXYtIQECgZPB/L/7/k7BDuKN4vFBvWUe3X 
s2oyjnVWy+ASqsW8gHfj8ekhe22bP240Oqkbyg9SZP9ol1tvJX6+M0thYwcTwAd 
ft929Icey/MOTQC0jB2qm0gnIx/7KInFXfS5KoFRJoGrWDeckr3RdBo2LhnPaeZ 
1gPYIqphZ3HfisF5KlBXoR8oT/Ilym/nq5COlv+3L4tMIk18F7BQZB60SRazifz 
pFkIxepyr/0= 
-----END CERTIFICATE----- 

The following credentials are required to start edge micro 
   key: a3f8f3dfe39158fc3c50b274f0af2234246e0d5f6ea4ad09389b645147151ba3
   secret: 3e9904802fb3c0e8ca408128a11119cf13546d54dac10ace944c097a726a1263

edgemicro configuration complete!

Vérifier l'installation

Exécutez cette commande pour vérifier l'installation. Si aucune erreur n'est signalée, tout est configuré correctement et vous pourrez démarrer Edge Microgateway. 

edgemicro verify -o [org] -e [env] -k [key] -s [secret]

Où :

  • org est le nom de votre organisation Edge (vous devez être administrateur de l'organisation).
  • env est un environnement dans votre organisation (tel que test ou production).
  • key est la clé renvoyée précédemment par la commande configure.
  • secret est la clé renvoyée précédemment par la commande configure.

Exemple

edgemicro verify -o docs -e test -k 93b01fd21d86331459ae52f624ae9aeb13eb94767ce40a4f621d172cdfb7e8e6 -s c8c755be97cf56c21f8b0156d7132afbd03625bbd85dc34ebfefae4f23fbcb3c

À propos de la configuration

Toute la configuration effectuée jusqu'à présent permet à Edge Microgateway de s'amorcer sur Apigee Edge. Une fois l'amorçage réussi, Edge Microgateway récupère une charge utile d'informations de configuration supplémentaires à partir d'Apigee Edge.

À quoi servent ces informations de configuration ? Comme nous le verrons dans la prochaine partie de ce tutoriel, lorsqu'Edge Microgateway démarre, il doit recevoir une liste de proxys d'API spéciaux compatibles avec Edge Microgateway depuis Apigee Edge. Dans la prochaine partie de ce tutoriel, vous allez créer un proxy compatible avec Microgateway. Edge Microgateway limite les clients à n'appeler que les API présentées par ces proxys d'API compatibles avec Microgateway. Les clients devront (par défaut) présenter un jeton de sécurité valide pour chaque appel. Pour en savoir plus sur ces proxys, consultez Ce que vous devez savoir sur les proxys compatibles avec Edge Microgateway dans Présentation d'Edge Microgateway.

En tant qu'administrateur d'organisation Edge, vous serez intéressé de savoir que les proxys compatibles avec Edge Microgateway peuvent être ajoutés aux produits Edge, comme n'importe quel autre proxy. En utilisant des produits et des applications de développement, vous pouvez générer des jetons de sécurité spécifiques aux clients pour contrôler l'accès aux API appelées via Edge Microgateway. Là encore, les schémas impliqués sont identiques à ceux utilisés pour travailler avec des produits, des applications de développeur et des proxys d'API sur Apigee Edge. Si vous souhaitez en savoir plus sur les produits, commencez par consulter Qu'est-ce qu'un produit d'API ? dans la documentation Edge.

Nous allons ensuite vous montrer comment créer des proxys compatibles avec Edge Microgateway. Après cela, nous démarrerons Edge Microgateway et testerons la configuration.

Partie 2 : Créer des entités sur Apigee Edge

Dans cette partie, vous allez créer les entités suivantes sur Edge :

  • Un proxy compatible avec les microgateways : il s'agit d'un proxy spécial qu'Edge Microgateway peut découvrir au démarrage. Les proxys compatibles avec les microgateways doivent respecter une convention de dénomination : leur nom doit commencer par edgemicro_. Par exemple, edgemicro_hello ou edgemicro_userinfo. Au démarrage, Edge Microgateway récupère auprès d'Edge une liste de proxys compatibles avec Microgateway provenant de la même organisation et du même environnement Edge que ceux que vous avez spécifiés au démarrage d'Edge Microgateway.

    Pour chaque proxy compatible avec Microgateway, Edge Microgateway récupère l'URL cible du proxy et son chemin de base. Les proxys compatibles avec Microgateway permettent également d'associer facilement les données analytiques générées par Edge Microgateway à un proxy sur la plate-forme Edge. Comme la passerelle Microgateway gère les appels d'API, elle transmet de manière asynchrone les données d'analyse à Edge. Les données Analytics s'afficheront dans l'UI Edge Analytics sous le ou les noms de proxy compatibles avec la passerelle de microservices, comme pour tout autre proxy.
  • Un produit, un développeur et une application de développement : Edge Microgateway utilise des produits, des développeurs et des applications de développement pour activer la sécurité des jetons d'accès OAuth2 ou des clés API. Au démarrage, Edge Microgateway télécharge toutes les configurations de produit de votre organisation Apigee Edge. Il utilise ces informations pour valider les appels d'API effectués via Edge Microgateway avec des clés API ou des jetons d'accès OAuth2.

1. Créer un proxy d'API compatible avec Edge Microgateway sur Edge

  1. Connectez-vous à votre organisation sur Apigee Edge.
  2. Sélectionnez Développer > Proxys d'API dans le menu de navigation latéral.
  3. Cliquez sur + Proxy. L'assistant de création de proxy est appelé.
  4. Sur la première page de l'assistant, sélectionnez Proxy inverse (le plus courant).
  5. Cliquez sur Suivant.
  6. Sur la page "Détails" de l'assistant, configurez les éléments comme suit. Veillez à remplir l'assistant exactement comme indiqué :
    • Nom du proxy : edgemicro_hello
    • Chemin de base du proxy : /hello
    • API existante : http://mocktarget.apigee.net/
  7. Cliquez sur Suivant.
  8. Sur la page "Sécurité" de l'assistant, sélectionnez Pass through (aucune).
  9. Cliquez sur Suivant.
  10. Sur la page "Hôtes virtuels" de l'assistant, acceptez les valeurs par défaut.
  11. Cliquez sur Suivant.
  12. Sur la page "Créer" de l'assistant, vérifiez vos paramètres proxy. Assurez-vous que l'environnement de test est sélectionné.
  13. Cliquez sur Build and Deploy (Compiler et déployer).

2. Créer un produit d'API

  1. Dans le menu de navigation latéral, sélectionnez Publier > Produits API.
  2. Cliquez sur + Produit API.
  3. Saisissez les informations sur le produit indiquées dans le tableau suivant :
    Champ Description
    Nom EdgeMicroTestProduct
    Nom à afficher Produit de test Edge Microgateway
    Environnement test
    Accès Public
    Type d'approbation des clés Automatique
  4. Dans la section "Ressources de l'API", ajoutez le proxy d'API que vous venez de créer et le proxy edgemicro-auth :
    • edgemicro_hello
    • edgemicro-auth
  5. Cliquez sur Enregistrer.

3. Créer un développeur

Pour les besoins de ce tutoriel, vous pouvez utiliser n'importe quel développeur existant pour l'étape suivante, qui consiste à créer une application de développeur. Toutefois, si vous le souhaitez, vous pouvez créer un développeur de test maintenant :

  1. Sélectionnez Publier > Développeurs dans le menu de navigation latéral.
  2. Cliquez sur + Développeur.
  3. Renseignez les champs de la boîte de dialogue pour créer un développeur de test.

4. Créer une application de développement

Vous allez utiliser les identifiants client de cette application pour effectuer des appels d'API sécurisés via Edge Microgateway :

  1. Sélectionnez Publier > Applications dans le menu de navigation latéral.
  2. Cliquez sur + Application. La page d'informations de l'application de développeur s'affiche.
  3. Renseignez la page "Application de développeur" comme suit :
    1. Nom : EdgeMicroTestApp
    2. Nom à afficher : EdgeMicroTestApp
    3. Développeur : si vous avez créé un développeur de test, sélectionnez-le. Vous pouvez également utiliser n'importe quel développeur existant pour ce tutoriel.
    4. Identifiants :
      1. Sélectionnez Expiration : Jamais.
      2. Cliquez sur + Produit, puis sélectionnez EdgeMicroTestProduct (le produit que vous venez de créer).
  4. Cliquez sur Enregistrer.
  5. Vous êtes redirigé vers la page de la liste des applications.
  6. Sélectionnez l'application que vous venez de créer, EdgeMicroTestApp.
  7. Cliquez sur Afficher à côté de Clé client et Secret client.

Partie 3 : Exploiter Edge Microgateway

Maintenant que vous avez configuré Edge Microgateway et au moins un proxy compatible avec Edge Microgateway sur Edge, il est temps de démarrer Edge Microgateway. Un serveur HTTP Edge Microgateway s'exécutera sur votre ordinateur local, et vous effectuerez des appels d'API directement à ce serveur.

1. Démarrer Edge Microgateway

Utilisez la commande edgemicro start pour démarrer Edge Microgateway.

  1. Assurez-vous d'avoir les clés qui ont été renvoyées précédemment lorsque vous avez exécuté la commande edgemicro configure. Le résultat ressemblait à ceci : 
    You need key and secret while starting edgemicro instance

key: da4778e7c240a5d4585fc559eaba5083328828bc9f3a7f583e8b73e
secret: 3aad7439708b4aeb38ee08e82189921ad00e6fc1ba8a8ae9f929ee2
  2. (Facultatif) Imprimez les informations d'aide pour la commande edgemicro start.
    edgemicro start -h
  3. Pour démarrer Edge Microgateway, exécutez la commande suivante : 
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    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 production).
    • key est la clé renvoyée précédemment par la commande configure.
    • secret est la clé renvoyée précédemment par la commande configure.

    Exemple

    edgemicro start -o docs -e test -k 701e70e718ce6dc1880616b3c39177d64a88754d615c7a4e1f78b6181d000723 -s 05c14356e42d136b83dd135cf8a18531ff52d7299134677e30ef4e34ab0cc824

    Résultat

    La commande de démarrage récupère de nombreuses informations de configuration à partir d'Apigee Edge (qui défilent dans la fenêtre du terminal). Dans le résultat, vous verrez la liste des produits et des proxys compatibles avec la micro-passerelle qui ont été détectés. À la fin du résultat, vous devriez voir quelque chose comme ceci :

    ...

current nodejs version is v12.5.0
current edgemicro version is 3.1.0
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
  4. Vérifiez l'état de la micro-passerelle. Dans une autre fenêtre de terminal, accédez au même répertoire que celui dans lequel vous avez démarré Edge Micro, puis saisissez la commande suivante : 
    edgemicro status
current nodejs version is v12.5.0
current edgemicro version is 3.1.0
edgemicro is running with 8 workers

Que s'est-il passé ?

Une charge utile d'informations de configuration Edge Microgateway est téléchargée depuis Apigee Edge et mise en cache localement. Voici quelques exemples :

  • La clé publique que nous avons créée et stockée précédemment dans un mappage clé-valeur (KVM) chiffré.
  • Représentation de tous les proxys compatibles avec Edge Microgateway qui existent dans l'organisation/l'environnement. Il s'agit de tous les proxys dont le nom commence par le préfixe edgemicro_.
  • Représentation de tous les produits d'API qui existent dans l'organisation/l'environnement.

Grâce à ces informations, Edge Microgateway sait quels proxys et chemins de proxy il est autorisé à traiter. Il utilise les informations produit pour appliquer la sécurité (exactement de la même manière que n'importe quel proxy d'API sur Apigee Edge, où les clés d'application de développeur sont associées à des produits). Nous allons bientôt passer en revue les étapes à suivre pour sécuriser Edge Microgateway.

2. Tester Edge Microgateway

Une fois Edge Microgateway en cours d'exécution, vous pouvez appeler le proxy. La configuration du proxy edgemicro_hello a été téléchargée depuis Edge lorsque vous avez démarré Edge Microgateway. N'oubliez pas que le chemin de base du proxy est /hello.

Pour tester Edge Microgateway, nous commençons par le chemin de base et ajoutons un chemin d'accès à la ressource /echo. Notez que tout ce qui se trouve après le chemin de base (y compris les paramètres de requête) est simplement transmis à la cible du backend :

curl -i http://localhost:8000/hello/echo
{"error":"missing_authorization","error_description":"Missing Authorization header"}

Cette erreur se produit, car vous n'avez pas envoyé de clé API ni de jeton d'accès valides avec la requête. Par défaut, Edge Microgateway exige une clé API ou un jeton d'accès pour chaque appel d'API. À l'étape suivante du tutoriel, nous sécuriserons correctement cette API et vous montrerons comment obtenir un jeton d'accès valide et l'inclure dans la requête.

4. Arrêter Edge Microgateway

  1. Dans une autre fenêtre de terminal, cd vers le même répertoire à partir duquel vous avez démarré Edge Microgateway.
  2. Saisissez la commande d'arrêt : 
    edgemicro stop

Partie 4 : Sécuriser Edge Microgateway

Vous pouvez sécuriser les appels d'API effectués via Edge Microgateway à l'aide d'une clé API ou d'un jeton d'accès.

Sécuriser les appels d'API avec un jeton d'accès OAuth2

Procédez comme suit si vous souhaitez authentifier les appels d'API avec un jeton d'accès OAuth2 :

1. Obtenir les clés requises

  1. Dans l'interface utilisateur Edge, accédez à l'application de développeur que vous avez créée précédemment. Le nom de l'application était EdgeMicroTestApp.
  2. Sur la page "Developer App" (Application de développeur), affichez la clé client et le code secret client, puis copiez-les. Ces valeurs sont requises pour obtenir un jeton d'accès à l'étape suivante.

2. Obtenir un jeton d'accès

Il existe deux façons d'obtenir un jeton d'accès. Nous allons vous présenter les deux méthodes.

Utiliser la CLI pour obtenir un jeton d'accès

La première méthode est pratique et suit le modèle que nous avons utilisé tout au long du tutoriel. La deuxième méthode est généralement plus utile aux développeurs d'applications clientes qui doivent demander des jetons. Le point de terminaison de jeton réel est implémenté dans le proxy edgemicro-auth qui a été déployé lorsque vous avez configuré Edge Microgateway.

  1. (Facultatif) Affichez l'aide de la commande token get : 
    edgemicro token get -h
  2. Générez le jeton en remplaçant les valeurs de la clé client et du secret client de l'application de développeur que vous avez créée sur Apigee Edge dans les paramètres -i et -s : 
    edgemicro token get -o [org] -e [env] -i [consumer_key] -s [consumer_secret]

    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 production).
    • consumer_id correspond au numéro client de l'application de développeur que vous avez créée précédemment.
    • consumer_secret correspond au code secret du consommateur dans l'application pour les développeurs que vous avez créée précédemment.

    Exemple

    edgemicro token get -o docs -e test -i G0IAeU864EtBo99NvUbn6Z4CBwVcS2 -s uzHTbwNWvoSmOy

    Exemple de résultat

    current nodejs version is v12.5.0
{ token: 'eyJ0eXAiOiJKV1QiLCJhbGciSUzI1NiJ9.eyJhcHBsaWNhdGl
vbl9uYW1lIjoiNWNiMGY0tOWMzOC00YmJjLWIzNzEtZGMxZTQzOGYxZGMxI
iwiY2xpZW50X2lkIjoiNVVdBWEdvSU9lbzYwYWV3OTRQN0c1TUFaRTNhSnA
iLCJzY29wZXMiOltdLCJhcGlfcHJvjdF9saXN0IjpbIsVkZ2VNaWNyb1Rlc
3RQcm9kdWN0IlmlhdCI6MTQ3ODIwODMzMiwiZXhwIjoxNDc4MjEwMTMxfQ.
v3Q8Rs0W9FO_XpERwIAMMXhjGamRmmmWgrAy1wJv0-99oajx5ASI5qjNubM
nCF14xxwlVXHcz1VfedA8Nx7Ih145zhWWuPKL9muzhXXnVBRFeBMeeLqJk4
QQ7Bhst7xH_68nJSTE20Egu95DHOCUemfrepDFH0VggY4BmzvwLkBNfz_te
E_YqwKZbpGOLMdKK1vMk0fk0x19SieIMS_aJYeOAklrzUhnFxWJFrsAWsax
NLx_BbQcZzYfK1JSDUrhRNVBuPHMnGjNA_oHw2J4qa6Hsp62PfchG-DIW_t
-0BFnYf3rYXmqyNORqFrOMdl4VxqQ' }

(Facultatif) Utiliser l'API pour obtenir un jeton

Si vous avez l'habitude d'appeler des proxys Edge à l'aide de curl ou d'un autre client HTTP, vous serez intéressé de savoir que vous pouvez appeler le point de terminaison du jeton directement, plutôt que d'utiliser la commande edgemicro token. Voici un exemple de curl. Il vous suffit de remplacer les noms de votre organisation et de votre environnement dans l'URL, et de transmettre les valeurs de la clé client et du secret client séparées par un deux-points dans un en-tête d'authentification de base :

curl -i -X POST "http://[org]-[env].apigee.net/edgemicro-auth/token" -d '{ "client_id": "your consumer key", "client_secret": "your consumer secret", "grant_type": "client_credentials" }' -H "Content-Type: application/json"

Où :

  • org est le nom de votre organisation Edge (vous devez être administrateur de l'organisation).
  • env est un environnement dans votre organisation (tel que test ou production).
  • 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.

Sortie (exemple)

La commande, que vous ayez utilisé la commande CLI edgemicro token ou appelé le point de terminaison à l'aide de curl, renvoie un jeton d'accès signé qui peut être utilisé pour effectuer des appels client. Le résultat devrait ressembler à ce qui suit :

MIICpDCCAYwCCQDpIvWlpaZJGDANBgkqhkiG9w0BAQFADAUMRIwEAYDVQQDEwls 
b2NhbGhvc3QwHhcNMTYwNDA3MTcxNTM5WhcNMTYwND4MTcxNTM5WjAUMRIwEAYD 
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAUAA4IBDwAwggEKAoIBAQD3 
OAQ+kf5FH0S0yuj05ITqUODuUJspBPberRMbqOZYHcFsnhB0Yvg6JKWxKWBDP9o
Xl96dtgH7xPFRqIU0zI452jkMQ1fPz2mSaGwik241yfBku7olooXKRKTRKOUoXa
q3Hld/RPxGSsWtiyyYtKex7tuFdq0Knm1EhowdTRGIgjNvudeYMka/XPRXuykhd 
xIDxWj4rdX+4GPx9qT2eTQC5nOAC7XHVL7ys4KqsAiv28vw10u400KstFFS8Qho 
7FaE0bOKLolKKadKyA60ha1XIw/uSTD6ZQFWQ+XM3OaRbXePWXnSZioSxXcZT7L 
hMUKbsRXw/TCvRB51LgNAgMBAAEwDQYJKoZIhvcNAQELBQADgEBAOuR1OmE/W6j 
gRAarJB5EQuTEpI/9Zpg5c5RAGjzLhkazsycn7pal+IymUjCV7D0oIxTVuTM8ZZ 
57kR5hF/C1ZypDN9i+KGP2ovX8WOCCXYtIQECgZPB/L/7/k7BDuKN4vFBvWUe3X 
s2oyjnVWy+ASqsW8gHfj8ekhe22bP240Oqkbyg9SZP9ol1tvJX6+M0thYwcTwAd 
ft929Icey/MOTQC0jB2qm0gnIx/7KInFXfS5KoFRJoGrWDeckr3RdBo2LhnPaeZ 
1gPYIqphZ3HfisF5KlBXoR8oT/Ilym/nq5COlv+3L4tMIk18F7BQZB60SRazifz 
pFkIxepyr/0=

3. Vérifier la configuration dans Edge Microgateway

  1. Ouvrez le fichier $HOME/.edgemicro/org-env-config.yaml. Consultez Où est installé Edge Microgateway ? si vous ne trouvez pas ce fichier.
  2. Assurez-vous que ces propriétés du plug-in OAuth sont définies sur false. Par défaut, la valeur est "false", mais il est recommandé de vérifier : 
    oauth:
   allowNoAuthorization: false
   allowInvalidAuthorization: false
  3. Toujours dans le fichier org-env-config.yaml, assurez-vous que le plug-in oauth est ajouté à l'élément plugins:sequence, comme ceci : 
    plugins:
   dir: ../plugins
   sequence:
   - oauth
  4. Si vous apportez des modifications au fichier, rechargez les modifications dans l'instance Edge Microgateway en cours d'exécution. Cette commande reconfigure Edge Microgateway sans temps d'arrêt : 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    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 production).
    • key est la clé renvoyée précédemment par la commande configure.
    • secret est la clé renvoyée précédemment par la commande configure.

    Exemple

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d

4. Appeler l'API de manière sécurisée

Maintenant que vous disposez d'un jeton d'accès, vous pouvez effectuer l'appel d'API de manière sécurisée. Exemple :

  curl -i -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhcHBsaWNhdGlvbl
9uYW1lIjoiYmU2YmZjYjAtMWQ0Ni00Y2IxLWFiNGQtZTMxNzRlNTAyMDZkIiwiY2xpZW50X2lkIjoiOGxTTTVIRHdyM
VhIT1ZwbmhURExhYW9FVG5STVpwWk0iLCJzY29wZXMiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIk1pY3JvZ2F0ZXdh
eVRlQcm9kdWN0Il0sImCI6MTQzNTM0NzY5MiwiZXhwIjoxNDM1MzQ5NDkxfQ.PL30Y6uK1W1f2ONPEsBDB_BT31c6
IsjWGfwpz-p6Vak8r767tAT4mQAjuBpQYv7_IU4DxSrnxXQ_q536QYCP4p4YKfBvyqbnW0Rb2CsPFziy_n8HIczsWO
s0p4czcK63SjONaUpxV9DbfGVJ_-WrSdqrqJB5syorD2YYJPSfrCcgKm-LpJc6HCylElFDW8dHuwApaWcGRSV3l5Wx
4A8Rr-WhTIxDTX7TxkrfI4THgXAo37p3au3_7DPB_Gla5dWTzV4j93xLbXPUbwTHzpaUCFzmPnVuYM44FW5KgvBrV0
64RgPmIFUxSqBWGQU7Z1w2qFmWuaDljrMDoLEreI2g" http://localhost:8000/hello/echo

L'API renvoie des en-têtes et d'autres informations du serveur fictif.

Sécuriser l'API avec une clé API

Si vous souhaitez utiliser une clé API pour l'autorisation, procédez comme suit :

1. Obtenir la clé API

  1. Dans l'interface utilisateur Edge, accédez à l'application de développeur que vous avez créée précédemment. Le nom de l'application était EdgeMicroTestApp.
  2. Sur la page de l'application de développeur, affichez la clé client et copiez-la. Cette valeur correspond à la clé API. Vous utiliserez cette clé pour effectuer des appels d'API authentifiés.

2. Vérifier la configuration dans Edge Microgateway

  1. Ouvrez le fichier $HOME/.edgemicro/org-env-config.yaml. . Consultez Où est installé Edge Microgateway ? si vous ne trouvez pas ce fichier.
  2. Assurez-vous que ces propriétés du plug-in OAuth sont définies sur false. Elles sont définies sur "false" par défaut, mais vous pouvez le vérifier si vous le souhaitez : 
    oauth:
   allowNoAuthorization: false
   allowInvalidAuthorization: false
  3. Toujours dans le fichier org-env-config.yaml, assurez-vous que le plug-in oauth est ajouté à l'élément plugins:sequence, comme ceci : 
    plugins:
   dir: ../plugins
   sequence:
   - oauth
  4. Si vous apportez des modifications au fichier, rechargez les modifications dans l'instance Edge Microgateway en cours d'exécution. Cette commande reconfigure Edge Microgateway sans temps d'arrêt : 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    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 production).
    • key est la clé renvoyée précédemment par la commande configure.
    • secret est la clé renvoyée précédemment par la commande configure.

    Exemple

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c30177d64a88754d615c74e1f78b6181d

3. Appeler l'API de manière sécurisée avec une clé API

Appelez l'API avec l'en-tête x-api-key comme suit. La valeur de la clé client que vous avez copiée à partir de l'application de développeur correspond à la clé API. Par défaut, Edge Microgateway s'attend à ce que vous transmettiez la clé dans un en-tête appelé x-api-key, comme suit :

curl -i http://localhost:8000/hello/echo -H "x-api-key: [apikey]"

Où :

  • apikey correspond à la valeur de la clé client extraite d'EdgeMicroTestApp.

Exemple :


curl -i http://localhost:8000/hello/echo -H 'x-api-key: XsU1R4zGXz2ERxd0ilYQ5szwuljr5bB'

Vous disposez désormais d'une passerelle Edge Microgateway entièrement fonctionnelle et sécurisée. Dans la prochaine partie du tutoriel, nous allons examiner les plug-ins qui ajoutent des fonctionnalités à Edge Microgateway.

Partie 5 : Ajouter un plug-in Spike Arrest

Dans cette partie, nous allons ajouter une fonctionnalité de limitation du débit appelée "spike arrest" à votre instance Edge Microgateway.

Que sont les plug-ins ?

Un plug-in est un module Node.js qui ajoute des fonctionnalités à Edge Microgateway. Les modules de plug-in suivent un modèle cohérent et sont stockés dans un emplacement connu d'Edge Microgateway, ce qui permet à la passerelle de microservices de les découvrir et de les charger automatiquement. Pour en savoir plus sur les plug-ins, consultez Utiliser des plug-ins.

Ajouter un plug-in Spike Arrest

Un plug-in SpikeArrest protège contre les pics de trafic. Il limite le nombre de requêtes traitées par une instance Edge Microgateway.

Dans Edge Microgateway, l'arrêt des pics est implémenté en tant que module de plug-in. Pour l'activer, vous devez l'ajouter au fichier de configuration Edge Microgateway.

  1. Ouvrez le fichier $HOME/.edgemicro/org-env-config.yaml.Où Edge Microgateway est-il installé ? si vous ne trouvez pas ce fichier.
  2. Ajoutez l'élément suivant. Vous pouvez l'ajouter n'importe où dans le fichier. 
       spikearrest:
      timeUnit: minute   
      allow: 10   
      buffersize: 0
  3. Ajoutez spikearrest à l'élément edgemicro:sequence, comme indiqué ci-dessous. La propriété de configuration de la séquence indique à Edge Microgateway l'ordre dans lequel les modules de plug-in sont exécutés. 
    edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
  sequence:
    - oauth
    - spikearrest
  4. Enregistrez le fichier de configuration.
  5. Rechargez Edge Microgateway avec la commande reload. Vous devez exécuter cette commande à partir du répertoire dans lequel vous avez démarré Edge Microgateway. 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    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 production).
    • key est la clé renvoyée précédemment par la commande configure.
    • secret est la clé renvoyée précédemment par la commande de configuration.

    Exemple

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d
  6. Essayez d'appeler l'API plusieurs fois de suite. Après le deuxième appel, Edge Microgateway renvoie l'erreur suivante : 
    {"message":"SpikeArrest engaged","status":503}

En effet, l'arrêt des pics permet de lisser le nombre d'appels pouvant être effectués au cours de l'unité de temps spécifiée. Dans ce cas, vous pouvez effectuer 10 appels en une minute, soit un toutes les six secondes.

Crédit supplémentaire : ajouter le plug-in de quota

En suivant le même modèle que celui utilisé pour configurer l'arrêt des pics, vous pouvez ajouter d'autres plug-ins, comme le plug-in de quota. Comme pour l'arrêt des pics, le plug-in de quota est inclus dans chaque installation d'Edge Microgateway. Un quota spécifie le nombre de messages de requête qu'une application est autorisée à envoyer à une API au cours d'un intervalle de temps spécifié (en minutes ou en heures).

Partie 6 : Afficher les données analytiques sur Apigee Edge

Nous disposons maintenant d'une instance Edge Microgateway entièrement fonctionnelle. Voyons ce qu'elle a fait. Par défaut, le module de plug-in Analytics est ajouté à Edge Micro. Ce module transmet silencieusement les données d'analyse d'Edge Micro à Apigee Edge, où elles sont utilisées par le système Edge Analytics. Voyons voir :

  1. Connectez-vous à votre organisation sur Apigee Edge.
  2. Sélectionnez Analytics > Performances du proxy.
  3. Dans le tableau de bord des performances de proxy, sélectionnez le proxy edgemicro_hello.
  4. Le graphique vous fournit des informations sur les tendances du trafic du proxy, comme le trafic total, le temps de réponse moyen, le temps de réponse cible moyen, etc.

Pour en savoir plus sur les tableaux de bord Edge Analytics, consultez la page d'accueil des tableaux de bord Analytics dans la documentation Edge. Pour en savoir plus sur les plug-ins, consultez la section Utiliser des plug-ins.