Questions fréquentes sur Edge Microgateway

Vous consultez la documentation d'Apigee Edge.
Accéder à la documentation sur Apigee X en savoir plus

Premiers pas

Comment installer Edge Microgateway ?

Consultez la section Installer Edge Microgateway.

Comment exécuter Edge Microgateway ?

Consultez Configurer et 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 s'exécutant dans le cadre d'un service cible. Toutefois, Edge Microgateway fonctionne indépendamment de toute base de données ou de tout magasin de données backend.

Opération

Quelles modifications sur Edge nécessitent un redémarrage d'Edge Microgateway ?

Edge Microgateway interroge automatiquement les modifications apportées à Apigee Edge, telles que les modifications apportées aux proxy, produits ou applications de développeur compatibles avec la micro-passerelle. L'intervalle de sondage par défaut est de 600 secondes. Toutefois, vous pouvez modifier cet intervalle à l'aide du paramètre de configuration config_change_poll_interval. Consultez la section Attributs edgemicro.

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 Récharger le cluster de micro passerelles.

Comment faire la différence entre un proxy déployé sur Edge et un proxy sur Edge Microgateway ?

Lorsque vous configurez Edge Microgateway, une liste de proxy compatibles avec la microgateway déployés sur Apigee Edge est téléchargée dans la configuration locale d'Edge Microgateway. Les proxys compatibles avec la micro-passerelle sont ceux qui portent le préfixe edgemicro_.

Quelles sont les options de journalisation disponibles avec Edge Microgateway ?

Edge Microgateway dispose d'une fonctionnalité de journalisation intégrée. Pour en savoir plus, consultez la section 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 d'Apigee Edge pour journaliser les messages d'Edge Microgateway. Consultez également l'article de la communauté Plugin de journalisation pour Microgateway.

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

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

Comment configurer Edge Microgateway pour qu'il démarre dans un environnement de production ?

Vous pouvez définir les variables d'environnement pour les paramètres de 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 la micro-passerelle Edge avec la seule commande edgemicro start. Consultez également Définir des variables d'environnement.

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

Non. Par défaut, Edge Microgateway n'agit que sur les attributs liés au routage de base et à la sécurité. Toutefois, vous pouvez utiliser les solutions de contournement suivantes :

1. Ajoutez des attributs personnalisés au proxy edgemicro-auth qu'Edge Microgateway déploie sur Apigee Edge. Ces attributs seront disponibles lorsque vous utiliserez la sécurité par clé API ou par jeton 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 a été réduite 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 sur 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-il ?

Déploiement

Puis-je déployer Edge Microgateway sur le serveur où s'exécute 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 prennent pas en charge 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 bundle de proxy Edge et le déploiement d'Edge Microgateway pour le même proxy d'API ?

Non. Edge Microgateway n'a pas connaissance des déploiements de proxys d'API autres que microgateway sur Apigee Edge.

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

Pour découvrir comment exécuter Edge Microgateway à l'aide de NGINX en tant qu'équilibreur de charge, consultez la section Gérer les API avec Edge Microgateway d'Apigee 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é ?

Reportez-vous aux limites de configuration du produit spécifiées pour les proxys Edge standards. Le nombre de proxys compatibles avec la micro passerelle 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 de micro passerelle Edge à une organisation et un environnement spécifiques ?

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

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

Edge Microgateway sélectionne 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'organisation pour configurer et déployer Edge Microgateway ?

Oui. Vous devez disposer d'identifiants d'administrateur de l'entreprise 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 qui peut être exécutée par toute personne autorisée à exécuter de telles applications sur une machine donnée.

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

Vous n'avez pas besoin d'être un utilisateur d'une 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 proxy compatibles avec la micro passerelle Edge déployés sur Edge.

Performances

Quelles sont les considérations de performances liées à l'utilisation d'Edge Microgateway ?

Si l'exécution d'Edge Microgateway est située au même endroit que 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 de la micro passerelle Edge sur différents serveurs gérés par des équilibreurs de charge tels que NGINX. Consultez également les sections Gérer des API avec Apigee Edge Microgateway et NGINX et Scaling horizontal vertical dans la communauté Apigee.

Quelles sont les TPS Edge Microgateway par défaut et quelle est la configuration matérielle requise pour une instance Microgateway

Les exigences matérielles et les mesures de TPS sont difficiles à évaluer avec la micro-passerelle Edge. Cela dépend de votre configuration, qui combine le réglage de la micro passerelle Edge, l'utilisation de plug-ins, les plug-ins personnalisés et la configuration d'autres éléments tels que TLS. Apigee recommande généralement de vous faire une idée de cette combinaison d'éléments et d'effectuer des tests de performances avec votre configuration spécifique.

Déploiement dans un cloud privé

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

Oui. Pour en savoir plus, consultez la section Étapes de configuration d'Apigee Private Cloud.

Plug-ins

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

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

Comment Spike Arrest est-il appliqué avec Edge Microgateway ?

Vous pouvez éventuellement ajouter un plug-in d'arrêt des pics à votre instance d'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 que Node.js pour Edge Microgateway ?

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

Que se passe-t-il si Edge Microgateway ne parvient pas à importer des données Analytics dans Edge ?

Edge Microgateway dispose d'une mémoire tampon en mémoire. Si le tampon est rempli, les charges utiles plus anciennes sont supprimées pour permettre au trafic de l'API de circuler correctement.

Puis-je ajouter des règles à Edge Microgateway ?

Si vous joignez des règles Apigee Edge standards à des proxy compatibles avec Microgateway dans Apigee Edge, elles sont ignorées. À la place, Edge Microgateway utilise des plug-ins pour fournir des fonctionnalités similaires 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 les pages Utiliser des plug-ins et Développer des plug-ins personnalisés.

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

• Comment remplacer l'URL par défaut sur Edge Microgateway
• Comment faire fonctionner les quotas dans Edge Microgateway
• Ajouter un plug-in de journalisation à 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:environnement sur Apigee Edge. Ce proxy expose un point de terminaison /products qui renvoie une liste de produits d'API. Si vous avez installé la micro passerelle Edge avant 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 le protocole TLS mutuel. Ces deux options sont décrites ci-dessous.

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

Si vous n'êtes pas sûr que 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 avant le 5 octobre 2018, 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 pour le moment, passez à l'option 2.

Option 2: Configurer l'authentification TLS mutuelle

Si vous ne pouvez pas mettre à niveau la micro-passerelle Edge pour le moment, Apigee recommande de protéger la communication entre la micro-passerelle Edge et le proxy edgemicro-auth avec le protocole TLS mutuel (également appelé TLS bidirectionnel).

1. Ouvrez le fichier $HOME/.edgemicro/org-env-config.yaml. Consultez Où est installé Edge Microgateway si vous ne parvenez pas à trouver ce fichier.
2. Ajoutez le bloc tlsOptions suivant au fichier org-env-config.yaml pour activer l'authentification TLS mutuelle entre la micro-passerelle Edge 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: incluez cette valeur si vous souhaitez utiliser un fichier p12/pfx au lieu d'un certificat et d'une clé.
   • passphrase: phrase de passe d'un fichier pfx.
   • ciphers: spécifie les algorithmes de chiffrement TLS.
3. Assurez-vous que l'authentification TLS mutuelle est activée sur l'hôte virtuel auquel le proxy edgemicro-auth est déployé. Pour plus d'informations, voir Définir un hôte virtuel pour TLS bidirectionnel dans la documentation Apigee Edge.

   La capture d'écran suivante montre comment activer le TLS mutuel 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 avec TLS appelé mutualtls, la strophe 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

Tester et déboguer

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

Dans certains cas, votre système peut rencontrer une situation où trop de connexions de fichiers sont 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 la micro passerelle.

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

Conseils pour un développement et un débogage rapides

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.

En attendant, 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. Vous pouvez ainsi démarrer Edge Microgateway sans saisir la clé/le secret à la ligne de commande. Consultez également la section Définir des variables d'environnement dans la documentation Edge Microgateway.
• Démarrez Edge Microgateway en mode DEBUG pour afficher une sortie supplémentaire dans le terminal de commande : DEBUG=* edgemicro start -o [org] -e [env] -k [key] -s [secret]

Entreprise et licences

Quelle est la relation entre les modèles de compatibilité Apigee-127 et 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 envoyer une demande d'extraction si vous essayez de corriger quelque chose. Apigee-127 ne nécessite ni n'inclut aucun contrat de licence logicielle avec Apigee.

Edge Microgateway, en revanche, est un produit Enterprise compatible avec Apigee pour les clients Apigee. Autrement dit, les clients Apigee peuvent créer des demandes d'assistance, des demandes de fonctionnalités et des signalements de bugs à l'aide de l'assistance Apigee Edge de Google Cloud.