Qu'est-ce que l'émulateur Apigee ?

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

Important : Ouvrez un espace de travail avant de configurer les émulateurs. Consultez la section Gérer l'espace de travail Apigee.

L'émulateur Apigee est une image Docker personnalisée fournie publiquement aux développeurs afin qu'ils puissent déployer et tester des proxys d'API dans un environnement de développement local. Les images Docker sont publiées régulièrement en gcr.

Lorsque vous êtes prêt à déployer et à tester votre premier proxy d'API, vous devez utiliser la section des émulateurs pour afficher et gérer les versions de votre émulateur et le cycle de vie des émulateurs configurés.

Remarque : Les images et les exemples de ce guide sont fournis à titre de référence et peuvent ne pas afficher la dernière version de l'émulateur Apigee. Utilisez toujours la dernière version stable de l'émulateur Apigee qui répond à vos besoins. Pour en savoir plus, consultez la section Choisir la version de l'émulateur.

Cette section vous permet d'effectuer les opérations suivantes :

• Afficher les différentes versions des émulateurs installées et les conteneurs créés pour chaque version de l'émulateur, y compris ses informations d'exécution et Docker, ainsi que les ports de contrôle et de trafic.

• Ajoutez, supprimez, démarrez, arrêtez, réinitialisez, mettez à jour et actualisez l'affichage des conteneurs de l'émulateur Apigee, comme décrit dans la section Gérer l'émulateur Apigee.

• Affichez les applications déployées (voir Déployer des environnements).

• Consultez les ressources de test actives (consultez la page Exporter des ressources de test vers l'émulateur Apigee).

Gérer l'émulateur Apigee

Gérez l'émulateur Apigee comme décrit dans les sections suivantes.

Remarque : Docker doit être installé et exécuté sur votre système pour que l'émulateur Apigee puisse être installé et exécuté.

Choisir la version de l'émulateur

Par défaut, le dossier emulator affiche une version stable. Toutefois, vous pouvez choisir une autre version en fonction de vos besoins.

1. Affichez une liste des versions de l'émulateur Apigee à l'aide de l'une des méthodes suivantes et notez la valeur de Tag :

   • Utilisez Google Artifact Registry. (Consultez la documentation et l'interface utilisateur).

     

   • Utilisez Docker Hub.

     

2. Pour ajouter une version de l'émulateur Apigee à l'extension Cloud Code, cliquez sur Gérer > Paramètres puis recherchez apigee emulators.

3. Cliquez sur Ajouter un élément.

4. Saisissez la valeur du Tag obtenue à l'étape 1. Par exemple, 1.10.0 ou google/apigee-emulator:1.10.0.

5. Cliquez sur OK.

6. Le nouvel émulateur s'affiche dans le dossier emulator.

Installer l'émulateur Apigee

Pour installer l'émulateur Apigee, procédez comme suit :

1. Développez le dossier emulators dans votre espace de travail.

2. Placez le curseur sur la version d'Apigee Emulator à installer.

3. Cliquez sur .

   

4. Ajoutez un conteneur en suivant les instructions de la section Ajouter un conteneur pour l'émulateur Apigee.

   Emulator.

La dernière image de la version de l'émulateur Apigee sélectionnée est installée. Une fois l'installation terminée, le message Emulator installed successfully s'affiche, et l'état du conteneur de l'émulateur Apigee devient Ready (Prêt).

Ajouter un conteneur pour l'émulateur Apigee

Pour ajouter un conteneur pour l'émulateur Apigee à l'aide de l'interface utilisateur, procédez comme suit :

1. Développez le dossier emulators.

   

2. Placez le curseur sur l'émulateur Apigee pour lequel vous souhaitez ajouter un conteneur.

3. Cliquez sur le signe +.

4. Saisissez un nom unique pour le conteneur de l'émulateur Apigee et appuyez sur Entrée. Saisissez des caractères alphanumériques, des tirets (-) ou des traits de soulignement (_).

5. Saisissez la valeur numérique à utiliser comme port de contrôle pour le conteneur de l'émulateur Apigee, puis appuyez sur Entrée. Le port de contrôle doit être unique pour tous les conteneurs. Sa valeur par défaut est 8080.

   Important ! Le port de contrôle doit être unique et ne doit être utilisé par aucun autre composant.

6. Saisissez la valeur numérique à utiliser comme port de trafic pour le conteneur de l'émulateur Apigee, puis appuyez sur Entrée. Le port de trafic doit être unique pour tous les conteneurs. Sa valeur par défaut est 8998.

   Important ! Le port de trafic doit être unique et ne doit être utilisé par aucun autre composant.

Le conteneur est ajouté.

Afficher les informations d'état pour l'émulateur Apigee

Affichez les informations d'état de l'émulateur Apigee comme décrit dans les sections suivantes.

Utiliser l'UI

Pour afficher les informations d'état de l'émulateur Apigee, y compris ses informations Docker et d'exécution, développez le conteneur dans la section Émulateurs. Les informations que vous voyez correspondent à la version de l'émulateur Apigee utilisée.

Utiliser la CLI Docker

Pour afficher les informations sur l'état du conteneur pour l'émulateur Apigee et ses ports configurés, exécutez docker ps dans l'onglet Terminal. Voici un exemple de réponse. La réponse réelle dépend de la version de l'émulateur Apigee utilisée :

CONTAINER ID   IMAGE                                COMMAND       CREATED        STATUS        PORTS                                      NAMES
33756b8c5c5b   ...apigee-emulator:1.11.0   "/usr/bin…"   10 hours ago   Up 10 hours   7000-7001/tcp, 0.0.0.0:8080->8080/tcp...   apigee-emulator

Consultez également la section Personnaliser le conteneur Docker de l'environnement d'exécution Apigee.

Démarrer l'émulateur Apigee

Gérez l'émulateur Apigee comme décrit dans les sections suivantes.

Utiliser l'UI

Pour démarrer l'émulateur Apigee, placez votre curseur sur le conteneur que vous souhaitez démarrer et cliquez sur .

Utiliser la CLI Docker

Pour démarrer l'émulateur Apigee, exécutez docker start CONTAINER_NAME

dans l'onglet Terminal.

L'état est défini sur Ready :

Consultez également la section Personnaliser le conteneur Docker de l'environnement d'exécution Apigee.

Réinitialiser l'émulateur Apigee

Réinitialisez l'émulateur Apigee pour supprimer tous les déploiements et les ressources de test exportées, comme décrit dans les sections suivantes.

Utiliser l'UI

Pour réinitialiser l'émulateur Apigee, placez votre curseur sur le conteneur d'émulateur Apigee dans la section Émulateurs et cliquez sur .

L'émulateur Apigee est réinitialisé et l'état est défini sur Ready :

L'onglet Résultat affiche les informations suivantes :

Resetting the Apigee Emulator
Reset completed

Consultez également la section Personnaliser le conteneur Docker de l'environnement d'exécution Apigee.

Redémarrer l'émulateur Apigee

Pour redémarrer l'émulateur Apigee, exécutez docker restart CONTAINER_NAME dans l'onglet Terminal. Par exemple : docker restart MyContainer.

Mettre à jour l'émulateur Apigee

Si l'émulateur Apigee n'est pas synchronisé avec la dernière version, vous pouvez mettre à jour votre version installée à l'aide de l'interface utilisateur ou de la CLI Docker, comme décrit dans les sections suivantes.

Utiliser l'UI

Pour mettre à jour l'émulateur Apigee, placez votre curseur sur l'émulateur Apigee dans la section Émulateurs et cliquez sur .

Utiliser la CLI Docker

Pour mettre à jour l'émulateur Apigee, exécutez les commandes Docker suivantes dans l'onglet Terminal en utilisant la dernière version appropriée :

• Exécutez docker ps pour obtenir le nom de l'image. Exemple : gcr.io/apigee-release/hybrid/apigee-emulator:EMULATOR_VERSION

• Exécutez docker pull IMAGE_NAME pour mettre à jour l'image d'installation de l'émulateur Apigee. Exemple : docker pull gcr.io/apigee-release/hybrid/apigee-emulator:EMULATOR_VERSION

L'émulateur Apigee est mis à jour et le message suivant s'affiche : Emulator version is up to date

Consultez également la section Personnaliser le conteneur Docker de l'environnement d'exécution Apigee.

Arrêter l'émulateur Apigee

Arrêtez l'émulateur Apigee à l'aide de l'interface utilisateur ou de la CLI Docker, comme décrit dans les sections suivantes.

Utiliser l'UI

Pour arrêter l'émulateur Apigee, placez votre curseur sur le conteneur de l'émulateur Apigee dans la section Émulateurs, puis cliquez sur .

Utiliser la CLI Docker

Pour arrêter l'émulateur Apigee, exécutez docker stop CONTAINER_NAME dans l'onglet Terminal.

L'émulateur Apigee est arrêté et l'état passe à Not running :

Consultez également la section Personnaliser le conteneur Docker de l'environnement d'exécution Apigee.

Supprimer un conteneur pour l'émulateur Apigee

Supprimez un conteneur pour l'émulateur Apigee à l'aide de l'interface utilisateur ou de la CL Docker, comme décrit dans les sections suivantes.

Utiliser l'UI

Pour supprimer l'émulateur Apigee, placez votre curseur sur le conteneur de l'émulateur Apigee dans la section Émulateurs et cliquez sur .

Utiliser la CLI Docker

Pour supprimer un conteneur de l'émulateur Apigee, exécutez les commandes Docker suivantes dans l'onglet Terminal :

• Exécutez docker stop CONTAINER_NAME pour arrêter l'image d'installation de l'émulateur Apigee (si elle n'est pas déjà arrêtée). Par exemple : docker stop MyContainer

• Exécutez docker rm CONTAINER_NAME pour arrêter l'image d'installation de l'émulateur Apigee. Par exemple : docker rm MyContainer

Le conteneur est supprimé.

Consultez également la section Personnaliser le conteneur Docker de l'environnement d'exécution Apigee.

Personnaliser le conteneur Docker de l'environnement d'exécution Apigee

Vous pouvez personnaliser la ligne de commande Docker utilisée pour contrôler les instances de l'émulateur Apigee à l'aide des options suivantes.

Remarque : La personnalisation du conteneur Docker de l'environnement d'exécution Apigee n'est pas nécessaire. Si aucune valeur n'est spécifiée, les valeurs des options par défaut sont utilisées. Les modifications apportées aux options ne s'appliquent qu'aux conteneurs créés après la modification des options. Si vous souhaitez appliquer les options aux conteneurs existants, vous devez les recréer.

Option	Description
additionalArguments	Ajoute un ou plusieurs arguments. Les arguments sont ajoutés à la commande docker run exactement tels qu'ils sont fournis. La valeur par défaut est "" (aucun).
detached	Détermine si l'option --detached est utilisée lors de l'exécution du conteneur. La valeur par défaut est true.
dns	Détermine l'option -dns du service DNS, comme décrit dans la section Services DNS. La valeur par défaut est 8.8.8.8.
environmentVariables	Ajoute des variables d'environnement à la commande docker run, comme décrit dans la section Options. Les valeurs, si elles sont fournies, sont ajoutées à la commande docker run à l'aide de -e name=value. La liste par défaut inclut "XTERM": "xterm-256color".
labels	Ajoute un ou plusieurs libellés à associer au conteneur. Les libellés sont ajoutés à la commande docker run à l'aide de -l label:value. La valeur par défaut est none.
privileged	Détermine si l'option --privileged est utilisée lors de l'exécution du conteneur. La valeur par défaut est true.
volumes	Ajoute un ou plusieurs volumes à installer sur le conteneur. Les volumes sont ajoutés à la commande docker run à l'aide de -v label:value. La valeur par défaut est none.

Pour personnaliser le conteneur Docker de l'environnement d'exécution Apigee, procédez comme suit :

1. Cette fonctionnalité est disponible dans la version Insiders (v1.21.0 et versions ultérieures). Installez la version Insiders, comme décrit dans la section Installer des versions Insiders.

2. Cliquez sur Gérer > Paramètres, puis recherchez apigee docker.

3. Sous Cloudcode > Apigee : Options Docker, cliquez sur Modifier dans settings.json. Les options personnalisables sont affichées dans le fichier settings.json, comme indiqué ci-dessous :

   "cloudcode.apigee.dockerOptions": {
     "environmentVariables": {
         "XTERM": "xterm-256-color"
     },
     "dns": "8.8.8.8",
     "detached": true
     "privileged": true,
     "labels": {},
     "volumes": {},
     "additionalArguments":""
   }

4. Modifiez les options et enregistrez le fichier.

Personnaliser l'émulateur Apigee pour prendre en charge l'authentification basée sur un compte de service

Lors du test des proxys qui dépendent de l'authentification basée sur le compte de service Google Cloud, l'émulateur Apigee doit accéder à la clé de compte de service Google. Suivez les étapes pour configurer votre émulateur Apigee pour qu'il soit compatible avec l'authentification basée sur un compte de service.

Créer et télécharger la clé du compte de service

Créez un compte de service Google Cloud avec le rôle Créateur de jetons du compte de service, qui est la condition de l'émulateur Apigee pour accepter les comptes de service. Créez une clé pour le compte de service, comme décrit dans la section Créer une clé de compte de service.

Téléchargez la clé sur le système de fichiers local afin qu'elle puisse être fournie à l'émulateur Apigee.

Remarque : Les clés de compte de service constituent un risque pour la sécurité si elles ne sont pas gérées correctement. Vous êtes responsable de la sécurité de la clé privée et des autres opérations décrites dans la section Bonnes pratiques de gestion des clés de compte de service. Si vous ne parvenez pas à créer une clé de compte de service, la création de clé de compte de service peut être désactivée pour votre organisation. Pour en savoir plus, consultez la page Gérer les ressources d'organisation sécurisées par défaut.

Configurer l'émulateur Apigee

Les paramètres définis dans cette section ne s'appliquent qu'aux instances de conteneur Docker créées après l'enregistrement des paramètres.

Pour configurer les paramètres de l'émulateur Apigee, procédez comme suit :

1. Ouvrez les options Docker, comme décrit dans la section Personnaliser le conteneur Docker de l'environnement d'exécution Apigee

   .

2. Dans la section volumes des options Docker, ajoutez un volume afin que le chemin d'accès de la clé du compte de service téléchargé soit disponible dans le conteneur. En supposant que la clé a été téléchargée dans le chemin d'accès /opt/apigee/keys/apigee-sa-key.json, le paramètre suivant permet d'installer le contenu de /opt/apigee/keys dans le chemin d'accès /emulator/keys au sein du conteneur :

   "volumes": {
     "/opt/apigee/keys":"/emulator/keys"
   }

3. Dans la section environmentVariables des options Docker, ajoutez la variable GOOGLE_APPLICATION_CREDENTIALS qui pointe vers le fichier dans le chemin installé :

   "environmentVariables": {
     "GOOGLE_APPLICATION_CREDENTIALS":"/emulator/keys/apigee-sa-key.json"
   }

4. Enregistrez les paramètres et créez une instance de conteneur que vous pourrez utiliser pour les tests.

L'exemple suivant montre comment associer une clé de compte de service Google à l'émulateur Apigee.

"cloudcode.apigee.dockerOptions": {
      "environmentVariables": {
          "XTERM": "xterm-256-color",
          "GOOGLE_APPLICATION_CREDENTIALS":"/emulator/keys/apigee-sa-key.json"
      },
      "dns": "8.8.8.8",
      "detached": true
      "privileged": true,
      "labels": {},
      "volumes": {
         "/opt/apigee/keys":"/emulator/keys"
      },
      "additionalArguments":""
    }

Configurer l'émulateur Apigee pour prendre en charge le proxy de transfert HTTP

Les paramètres définis dans cette section ne s'appliquent qu'aux versions 1.11.0 et ultérieures de l'émulateur.

Souvent, les cibles de backend associées à un proxy ne sont accessibles qu'à l'aide d'un proxy de transfert HTTP. L'émulateur Apigee peut être configuré pour utiliser le proxy de transfert tout en se connectant à des cibles à l'aide d'une variable d'environnement nommée FORWARD_PROXY.

Les paramètres définis dans cette section ne s'appliquent qu'aux instances de conteneur Docker créées après l'enregistrement des paramètres.

Pour configurer les paramètres de l'émulateur Apigee, procédez comme suit :

1. Ouvrez les options Docker, comme décrit dans la section Personnaliser le conteneur Docker de l'environnement d'exécution Apigee.

2. Dans la section environmentVariables des options Docker, ajoutez la variable FORWARD_PROXY qui pointe vers l'adresse du proxy de transfert en tant qu'URL HTTP.

   "environmentVariables": {
     "FORWARD_PROXY":"http://proxy_host:proxy_port"
   }

3. Enregistrez les paramètres et créez une instance de conteneur à des fins de test.