Déployer des proxys à partir de la ligne de commande

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

Cet article explique comment déployer un proxy à partir de la ligne de commande. Apigee Edge propose deux options de déploiement à partir de la ligne de commande. La première consiste à utiliser un outil de déploiement Apigee Edge écrit en Python. L'autre consiste à configurer et à exécuter un script shell.

Utilisez les techniques de déploiement de ligne de commande lorsque vous travaillez directement avec des fichiers sources de proxy sur votre système. Vous pouvez avoir de nombreuses raisons de travailler hors connexion. Vous pouvez utiliser un éditeur XML de votre choix ou développer des règles nécessitant un codage Java et vous travaillez principalement dans un IDE. Les techniques décrites dans cette section vous permettent d'importer et de déployer vos fichiers sources dans l'environnement de services d'API de votre choix.

Si vous travaillez principalement dans l'interface utilisateur de gestion, consultez la section Déployer des proxys dans l'interface utilisateur.

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

Exécuter l'outil de déploiement Python Apigee Edge

L'outil de déploiement Python Apigee Edge fonctionne avec l'API de gestion Edge pour importer et déployer des proxys d'API. L'outil est disponible dans la distribution des exemples de plate-forme d'API sur GitHub. Consultez la section Utiliser les exemples de proxy d'API.

Utilisez l'outil Python Apigee Edge pour importer (importer) et déployer votre API en une seule étape.

L'outil de déploiement doit être exécuté à partir du répertoire de base de la distribution des exemples de plate-forme d'API, où le répertoire de base est le répertoire parent des répertoires setup et tools.

Dans la commande suivante, remplacez le nom du proxy, votre nom d'utilisateur et votre mot de passe Edge, l'organisation et l'environnement Edge, ainsi que le chemin d'accès au répertoire "apiproxy" du proxy d'API :

python tools/deploy.py -n proxyname -u name:passW -o org -e env -d proxypath -p /

Exemple :

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p /

Cette commande compresse vos fichiers, les envoie à votre organisation sur Apigee Edge et les déploie dans l'environnement spécifié.

L'outil de déploiement détecte automatiquement la révision actuelle de votre proxy d'API , annule le déploiement de la révision existante et déploie une révision incrémentée du proxy d'API.

Si l'opération réussit, le résultat s'affiche au format suivant :

Writing ./<proxybasedir>/apiproxy/weatherapi.xml to apiproxy/weatherapi.xml
Writing ./<proxybasedir>/apiproxy/proxies/default.xml to apiproxy/proxies/default.xml
Writing ./<proxybasedir>/apiproxy/targets/default.xml to apiproxy/targets/default.xml
Imported new proxy version 1
Environment: test
  Revision: 1 BasePath = /
  State: deployed

Par défaut, l'outil importe le proxy d'API dans https://api.enterprise.apigee.com, ce qui correspond à Edge dans le cloud. Vous pouvez également utiliser cet outil pour importer le proxy d'API dans une version sur site d'Edge en spécifiant l'indicateur -h :

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p / -h https://192.168.11.111:8080

Dans cet exemple, vous spécifiez l'adresse IP du serveur de gestion Edge. Si vous avez créé un enregistrement DNS pour le serveur de gestion, vous pouvez spécifier une URL au format suivant :

https://ms_URL:8080

Voici la liste complète des indicateurs de la commande :

  • -n : nom de votre proxy d'API.
  • -u : nom d'utilisateur et mot de passe de votre compte dans une organisation Apigee Edge.
  • -o : nom de l'organisation dans laquelle vous possédez un compte.
  • -e : environnement dans lequel le proxy d'API doit être déployé (test ou prod).
  • -d : chemin d'accès au répertoire contenant vos fichiers de proxy d'API. Vos fichiers de proxy d'API doivent être stockés dans un répertoire nommé "apiproxy". Cette valeur correspond au chemin d'accès au répertoire contenant le répertoire "apiproxy", et non au chemin d'accès au répertoire "apiproxy" lui-même.
  • -p : chemin d'accès URI utilisé comme correspondance de modèle pour acheminer les messages entrants vers ce déploiement de proxy d'API. Dans la plupart des cas, vous pouvez définir cette valeur sur '/', sauf si vous avez des exigences avancées en matière de déploiement et de routage. Le chemin d'accès principal utilisé pour le routage des proxys d'API est défini dans le fichier de configuration ProxyEndpoint du proxy d'API.
  • -h : URL Edge. Par défaut, l'URL est https://api.enterprise.apigee.com, ce qui correspond à Edge dans le cloud. Pour un déploiement sur site, utilisez l'URL du serveur de gestion Edge et le port 8080, comme dans l'exemple suivant : 
    https://ms_URL:8080

    Vous pouvez également utiliser l'adresse IP du serveur de gestion, comme dans https://192.168.11.111:8080.

Configurer et exécuter un script shell de déploiement

L'approche la plus simple consiste à exécuter le script de déploiement fourni avec l'exemple de proxy d'API. Les scripts shell encapsulent l'outil de déploiement Python Apigee Edge.

À partir du répertoire /simplyProxy, exécutez la commande suivante :

$ sh deploy.sh

Vous devriez obtenir le résultat suivant :

Enter your password for user {myname} in the Apigee Enterprise organization {org_name}, followed by [ENTER]:

Saisissez votre mot de passe, puis appuyez sur Entrée.

Vous devriez ensuite obtenir le résultat suivant :

Deploying to test on https://api.enterprise.apigee.com using {myname} on enterprise.apigee.com and {org_name} on enterprise.apigee.com

Si vous voyez le message suivant :

Enter your password for user Your USERNAME on enterprise.apigee.com in the Apigee Enterprise organization Your ORG on enterprise.apigee.com, followed by [ENTER]:

cela signifie que vous devez modifier le fichier /setup/setenv.sh dans la distribution des exemples de plate-forme. Pour obtenir des instructions, consultez le fichier Lisez-moi ou les API Apigee Edge.

Si l'opération réussit, l'outil de déploiement compresse les fichiers sous /apiproxy, importe le package dans votre organisation sur Apigee Edge, puis déploie le proxy d'API dans l'environnement "test" .

Votre proxy d'API est prêt à être appelé.