Questions fréquentes sur Edge Microgateway

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Premiers pas

Comment installer Edge Microgateway ?

Consultez la section Installer Edge Microgateway.

Comment exécuter Edge Microgateway ?

Consultez la section Configurer Edge Microgateway.

Ai-je besoin d'une base de données pour exécuter Microgateway ?

Les API transmises par proxy via Edge Microgateway peuvent interagir avec une base de données exécutée dans le cadre d'un service cible. Cependant, Edge Microgateway fonctionne indépendamment des bases de données ou des magasins de données backend.

Opération

Quels changements sur Edge nécessitent le redémarrage d'Edge Microgateway ?

Edge Microgateway recherche automatiquement les modifications apportées à Apigee Edge, telles que les modifications apportées aux proxys, aux produits ou aux applications de développement. L'intervalle d'interrogation par défaut est de 600 secondes. Vous pouvez toutefois le modifier avec le paramètre de configuration config_change_poll_interval. Consultez la section Attributs bord micro.

Si vous ne souhaitez pas attendre l'intervalle d'interrogation, utilisez la commande edgemicro reload pour récupérer les dernières modifications. Consultez la section Recharger le cluster de micro-passerelle.

Comment différencier un proxy déployé sur Edge et un proxy sur Edge Microgateway ?

Lorsque vous configurez Edge Microgateway, une liste de proxys compatibles avec les micro-passerelles déployés sur Apigee Edge est téléchargée dans la configuration locale d'Edge Microgateway. Les proxys compatibles avec Microgateway sont des proxys nommés avec le préfixe edgemicro_.

Quelles options puis-je utiliser pour la journalisation avec Edge Microgateway ?

Edge Microgateway dispose d'une fonctionnalité de journalisation intégrée. Pour en savoir plus, consultez Gérer les fichiers journaux.

Vous pouvez également écrire un plug-in personnalisé pour utiliser un service de journalisation tiers avec Edge Microgateway. En raison du fonctionnement d'Edge Microgateway, vous ne pouvez pas utiliser la règle de journalisation des messages Apigee Edge pour consigner les messages d'Edge Microgateway. Consultez également l'article de la communauté sur le plug-in Logging pour Microgateway.

Puis-je réutiliser des combinaisons clé/code secret entre les instances d'Edge Microgateway ?

Tant que l'organisation et l'environnement sont les mêmes pour les instances Microgateway, vous pouvez réutiliser la paire clé/secret générée lors de la configuration.

Comment configurer Edge Microgateway pour démarrer dans un environnement de production ?

Vous pouvez définir les variables d'environnement pour les paramètres de la commande de démarrage, tels que EDGEMICRO_KEY, EDGEMICRO_SECRET, EDGEMICRO_ORG et EDGEMICRO_ENV. Avec ces variables et d'autres, vous pouvez démarrer Edge Microgateway à l'aide de la commande unique edgemicro start. Consultez également la section Définir des variables d'environnement.

Puis-je utiliser des attributs d'application de produit ou de développement personnalisés avec Edge Microgateway ?

Non. Par défaut, Edge Microgateway n'agit que sur les attributs liés au routage et à la sécurité de base. Toutefois, pour contourner ce problème, vous disposez de l'option suivante :

1. Ajoutez des attributs personnalisés au proxy edgemicro-auth déployé par Edge Microgateway sur Apigee Edge. Ces attributs seront disponibles lors de l'utilisation de la clé API ou de la sécurité des jetons OAuth.
2. Modifiez le plug-in OAuth pour qu'il agisse sur ces attributs.

La taille de l'en-tête de requête est-elle limitée ?

Si vous mettez à niveau Node.js vers la v8.14.0 ou une version ultérieure, sachez que la taille d'en-tête maximale autorisée pour les requêtes est passée de 80 Ko à 8 Ko. Les en-têtes qui dépassent 8 Ko génèrent une erreur HTTP 431.

Une option de configuration Node.js ajoutée dans Node.js v11.6.0 vous permet de modifier la taille d'en-tête maximale par défaut. Ce paramètre, --max-http-header-size, vous permet de spécifier la taille maximale, en octets, des en-têtes HTTP.

Pour modifier la configuration par défaut, définissez la valeur de la variable d'environnement NODE_OPTIONS dans la ligne de commande, comme suit :

NODE_OPTIONS=--max-http-header-size=NUM_BYTES

Exemple :

NODE_OPTIONS=--max-http-header-size=80000

Quelles API de gestion Edge Microgateway utilise-t-elle ?

Déploiement

Puis-je déployer Edge Microgateway sur le même serveur que mon service cible ?

Oui. Edge Microgateway est un processus léger qui peut s'exécuter à proximité de votre service cible, y compris sur la même machine.

Puis-je déployer un groupe de proxys Edge existant en tant que déploiement Edge Microgateway ?

Non. Les proxys compatibles avec Edge Microgateway ont des exigences spécifiques et ne sont pas compatibles avec toutes les fonctionnalités des proxys Edge standards. Consultez la Partie 2: Créer des entités sur Apigee Edge

Puis-je activer le basculement entre le déploiement d'un groupe de proxys Edge et le déploiement d'Edge Microgateway pour le même proxy d'API ?

Non. Edge Microgateway ne connaît pas les déploiements de proxys d'API autres que des micro-passerelles sur Apigee Edge.

Quel est le modèle de déploiement à haute disponibilité d'Edge Microgateway ?

Pour en savoir plus sur l'exécution d'Edge Microgateway en utilisant NGINX comme équilibreur de charge, consultez la page Gérer les API avec Apigee Edge Microgateway et NGINX.

Quels équilibreurs de charge puis-je utiliser avec Edge Microgateway ?

Edge Microgateway peut fonctionner avec n'importe quel équilibreur de charge.

Le nombre de proxys Edge Microgateway que je peux déployer est-il limité ?

Consultez les limites de configuration du produit spécifiées pour les proxys Edge standards. Le nombre de proxys compatibles avec les micro-passerelles que vous pouvez déployer dans une organisation et un environnement Apigee Edge et appeler via Edge Microgateway doit respecter ces mêmes limites.

Puis-je associer mon déploiement Edge Microgateway à une organisation et à un environnement spécifiques ?

Lorsque vous configurez une instance Edge Microgateway, vous devez l'associer à une organisation et à un environnement Edge spécifiques.

Puis-je associer mon déploiement Edge Microgateway à une région spécifique (si je suis un client multirégional) ?

Edge Microgateway choisit automatiquement la meilleure région pour son interaction avec Apigee Edge. Vous pouvez déployer des instances Edge Microgateway dans chaque région que vous souhaitez desservir.

Administration

Dois-je être administrateur de l'entreprise pour configurer et déployer Edge Microgateway ?

Oui. Vous devez disposer d'identifiants d'administrateur de l'organisation pour configurer et déployer Edge Microgateway.

Dois-je être administrateur de l'entreprise pour exécuter Edge Microgateway ?

Non. Edge Microgateway est une application Node.js et peut être exécutée par toute personne autorisée à exécuter de telles applications sur une machine donnée.

Certains utilisateurs de mon organisation peuvent-ils utiliser Edge Microgateway ?

Vous n'avez pas besoin d'être un utilisateur de l'organisation Apigee Edge pour effectuer des appels d'API via Edge Microgateway. Toutefois, vous devez disposer d'autorisations au niveau de l'organisation pour créer ou modifier des proxys compatibles avec Edge Microgateway qui sont déployés sur Edge.

Performances

Quels sont les critères de performances à prendre en compte lors de l'utilisation d'Edge Microgateway ?

Si l'exécution d'Edge Microgateway est en colocalisation avec l'application cible, assurez-vous que le serveur dispose d'une capacité suffisante.

Quelles sont les bonnes pratiques pour exécuter Edge Microgateway à grande échelle ?

Apigee recommande d'exécuter plusieurs instances d'Edge Microgateway sur différents serveurs dotés d'équilibreurs de charge tels que NGINX. Consultez également les pages Gérer les API avec Apigee Edge Microgateway et NGINX et le scaling horizontal vertical dans la communauté Apigee.

Qu'est-ce que le TPS Edge Microgateway par défaut et la configuration matérielle requise pour une instance Microgateway ?

Edge Microgateway ne permet pas d'évaluer les exigences matérielles ni les mesures TPS. Cela dépend de votre configuration, qui combine le réglage d'Edge Microgateway, l'utilisation de plug-ins, des plug-ins personnalisés et la configuration d'autres éléments tels que TLS. Apigee vous recommande généralement de vous faire une idée de cette combinaison d'éléments et de tester les performances avec votre configuration spécifique.

Déploiement sur le cloud privé

Edge Microgateway fonctionne-t-il avec Edge for Private Cloud ?

Oui. Pour plus d'informations, consultez les étapes de configuration d'un cloud privé Apigee.

Plug-ins

Comment le quota est-il appliqué avec Edge Microgateway ?

Vous pouvez éventuellement ajouter un plug-in de quota à votre instance Edge Microgateway. Pour en savoir plus, consultez la section Utiliser le plug-in de quota.

Comment l'arrêt de Spike Arrest est-il appliqué à Edge Microgateway ?

Vous pouvez éventuellement ajouter un plug-in d'arrêt des pics à votre instance Edge Microgateway. Pour en savoir plus, consultez la section Utiliser le plug-in d'arrêt des pics.

Existe-t-il d'autres moyens d'écrire des plug-ins autres que Node.js pour Edge Microgateway ?

Non. Les plug-ins doivent être écrits en Node.js.

Que se passe-t-il lorsque Edge Microgateway ne peut pas télécharger de données Analytics vers Edge ?

Edge Microgateway comporte un tampon en mémoire. Si le tampon se remplit, les charges utiles plus anciennes sont supprimées pour permettre au trafic de l'API de circuler facilement.

Puis-je ajouter des stratégies à Edge Microgateway ?

Si vous associez des règles Apigee Edge standards à des proxys compatibles avec les micro-passerelles dans Apigee Edge, elles sont ignorées. À la place, Edge Microgateway utilise des plug-ins pour fournir des fonctionnalités semblables aux règles d'Edge, telles que les quotas, l'arrêt des pics, la sécurité des clés API et la sécurité OAuth2. Vous pouvez également écrire des plug-ins personnalisés. Consultez Utiliser des plug-ins et Développer des plug-ins personnalisés.

Les articles suivants de la communauté et les blogs Apigee traitent d'autres cas d'utilisation des plug-ins:

• Remplacer l'URL par défaut sur Edge Microgateway
• Comment faire fonctionner les quotas dans Edge Microgateway
• Ajouter un plug-in d'enregistreur à Edge Microgateway

Sécurité

Comment protéger la ressource /products ?

Présentation

Lorsque vous configurez Edge Microgateway, un proxy d'API appelé edgemicro-auth est déployé dans votre organisation:environment sur Apigee Edge. Ce proxy expose un point de terminaison /products qui renvoie une liste de produits d'API. Si vous avez installé Edge Microgateway au plus tard le 5 octobre 2018, Apigee vous recommande de prendre des mesures pour protéger ce point de terminaison, car la réponse contient l'adresse e-mail du développeur qui a créé et modifié les produits d'API dans votre organisation Apigee.

Vous pouvez protéger le point de terminaison en mettant à niveau Edge Microgateway ou en configurant l'authentification TLS mutuelle. Ces deux options sont décrites ci-dessous.

Vérifier si le point de terminaison /products est protégé

Si vous ne savez pas si le point de terminaison /products est protégé, consultez la section Vérifier que la ressource /products est protégée et suivez la procédure indiquée avant de continuer.

Option 1: Mettre à niveau Edge Microgateway

Si vous avez installé Edge Microgateway le 5 octobre 2018 ou avant cette date, Apigee vous recommande de passer à la dernière version d'Edge Microgateway. Suivez la procédure décrite dans la section Mettre à niveau Edge Microgateway si vous disposez d'une connexion Internet.

Si vous ne parvenez pas à effectuer la mise à niveau maintenant, passez à l'option 2.

Option 2: Configurer le protocole TLS mutuel

Si vous ne pouvez pas mettre à niveau Edge Microgateway pour le moment, Apigee vous recommande de protéger la communication entre Edge Microgateway et le proxy edgemicro-auth avec une authentification TLS mutuelle (également appelée TLS bidirectionnel).

1. Ouvrez le fichier $HOME/.edgemicro/org-env-config.yaml. Si vous ne pouvez pas localiser ce fichier, consultez la section Où est installé Edge Microgateway.
2. Ajoutez le bloc tlsOptions suivant au fichier org-env-config.yaml pour activer l'authentification TLS mutuelle entre Edge Microgateway et Apigee Edge :

   edge_config:
     bootstrap: >-
       https://domain/edgemicro/bootstrap/organization/org/environment/env
     jwt_public_key: 'https://domain/edgemicro-auth/publicKey'
     managementUri: 'https://api.enterprise.apigee.com'
     tlsOptions:
       agentOptions:
         requestCert: true
         cert: 'path/to/cert'
         key: 'path/to/key'
   

   Exemple :

   tlsOptions:
     agentOptions:
       requestCert: true
       cert: '/Users/jdoe/twowayssl/ssl/client.key'
       key: '/Users/jdoe/twowayssl/ssl/ca.crt'

   Vous pouvez également inclure les paramètres agentOptions facultatifs suivants:

   • ca: spécifie le chemin d'accès à l'autorité de certification.
   • pfx: à inclure si vous souhaitez utiliser un fichier p12/pfx au lieu d'un certificat et d'une clé.
   • passphrase: phrase secrète d'un fichier pfx.
   • ciphers: spécifie les algorithmes de chiffrement TLS.
3. Assurez-vous que le protocole TLS mutuel est activé sur l'hôte virtuel sur lequel le proxy edgemicro-auth est déployé. Pour plus d'informations, consultez la section Définir un hôte virtuel pour le protocole TLS bidirectionnel dans la documentation Apigee Edge.

   La capture d'écran suivante montre comment activer l'authentification TLS mutuelle sur un hôte virtuel dans l'interface utilisateur d'Apigee Edge:

   
4. Examinez le proxy d'API edgemicro-auth dans l'interface utilisateur Edge et assurez-vous que l'hôte virtuel approprié est spécifié dans la configuration du proxy. Par exemple, si vous avez créé un hôte virtuel compatible TLS appelé mutualtls, le bloc HTTPProxyConnection du proxy doit se présenter comme suit :

   <HTTPProxyConnection>
       <BasePath>/edgemicro-auth</BasePath>
       <Properties/>
       <VirtualHost>mutualtls</VirtualHost>
   </HTTPProxyConnection>
   

curl -v https://your_domain/edgemicro-auth/products

{
  "error":"unauthorized",
  "error_description": "authentication failed"
}

curl: (35) error:1408F10B:SSL routines:ssl3_get_record:wrong version number

{
   "apiProduct":[
      {
         "apiResources":[
            "/",
            "/**"
         ],
         "approvalType":"auto",
         "attributes":[

         ],
         "createdAt":1537374680948,
         "createdBy":"jdoe@foo.com",
         "description":"",
         "displayName":"mock",
         "environments":[
            "test"
         ],
         "lastModifiedAt":1537374680948,
         "lastModifiedBy":"test@test.com",
         "name":"mock",
         "proxies":[
            "edgemicro-auth",
            "edgemicro_mock"
         ],
         "quota":"null",
         "quotaInterval":"null",
         "quotaTimeUnit":"null",
         "scopes":[
            ""
         ]
      }
   ]
}

curl -v http://your_domain/edgemicro-auth/products

Tests et débogage

Comment éviter les erreurs "trop de fichiers ouverts" lors des tests de charge ?

Dans certains cas, votre système peut rencontrer un trop grand nombre de connexions de fichiers ouvertes, ce qui peut entraîner le plantage d'Edge Micro. La journalisation par défaut nécessite deux connexions HTTP pour les transactions entrantes et sortantes via Microgateway.

À des fins de test et d'analyse comparative, Apigee vous recommande de définir la commande ulimit de votre système sur illimitée: ulimit -n unlimited. Consultez également l'erreur Edge Microgateway lors des tests de charge dans la communauté Apigee.

Conseils pour accélérer le développement et le débogage

Si vous développez des plug-ins pour Edge Microgateway, vous constaterez peut-être que la prise en charge du développement rapide est limitée.

Pour l’instant, voici quelques conseils:

• Pour démarrer Edge Microgateway, vous pouvez définir les variables d'environnement EDGEMICRO_KEY et EDGEMICRO_SECRET sur la paire clé/secret requise par la commande de démarrage de Microgateway. Cela vous permet de démarrer Edge Microgateway sans saisir la clé/le code secret dans la ligne de commande. Consultez également la section Définir des variables d'environnement dans la documentation d'Edge Microgateway.
• Démarrez Edge Microgateway en mode DÉBOGAGE pour afficher un résultat supplémentaire dans le terminal de commande : DEBUG=* edgemicro start -o [org] -e [env] -k [key] -s [secret]

Activité et licences

Quelle est la relation entre les modèles de prise en charge d'Apigee-127 et d'Edge Microgateway ?

Apigee-127 est un projet de logiciel Open Source compatible avec le modèle Open Source. Autrement dit, vous pouvez signaler des problèmes dans le projet GitHub et effectuer une demande d'extraction si vous essayez de résoudre un problème. Apigee-127 ne nécessite et n'inclut aucun contrat de licence logicielle avec Apigee.

En revanche, Edge Microgateway est un produit Enterprise pris en charge par Apigee pour les clients Apigee. Autrement dit, les clients Apigee peuvent créer des demandes d'assistance, des demandes de fonctionnalités et des rapports de bug via l'assistance Apigee Edge de Google Cloud.