À propos des environnements et des groupes d'environnements

Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.

Cette section décrit les environnements et les groupes d'environnements.

Présentation

Un environnement est un contexte d'exécution pour les proxys d'API et les flux partagés d'une organisation. Vous devez déployer un proxy d'API dans un environnement avant de pouvoir y accéder. Vous pouvez déployer un proxy d'API dans un seul environnement ou dans plusieurs environnements.

Chaque environnement est limité à 50 proxys d'API déployés, plus les flux partagés (combinés).

Un groupe d'environnement (parfois appelé envgroup dans les API Apigee) est le mécanisme de base permettant de définir le mode de routage des requêtes vers des environnements individuels. Vous définissez des noms d'hôte sur vos groupes d'environnement (et non sur des environnements individuels) et Apigee achemine les requêtes vers les environnements au sein d'un groupe en utilisant ces définitions de noms d'hôte.

Un environnement doit être membre d'au moins un groupe d'environnement avant de pouvoir accéder aux ressources qu'il contient. En d'autres termes, vous devez attribuer un environnement à un groupe avant de pouvoir l'utiliser.

Le regroupement logique des environnements par groupe d'environnement offre les avantages suivants :

  • Gestion centralisée des noms d'hôte : les groupes d'environnements fournissent un emplacement centralisé pour gérer les noms d'hôte.
  • Insights agrégés : avec les groupes, vous pouvez analyser les erreurs en consultant les rapports d'un groupe d'environnement entier plutôt que des environnements individuels.
  • Éviter les conflits : en regroupant les environnements, vous pouvez vous assurer que les chemins de base de vos environnements n'existent pas sous le même nom d'hôte.

Nombre d'environnements que vous pouvez créer

Le nombre d'environnements que vous pouvez créer dans une région dépend du nombre d'adresses IP allouées à votre réseau VPC (la plage CIDR) :

Plage d'adresses IP allouée Taille Nombre d'environnements compatibles Description
/16 65 536 adresses IP (216) Jusqu'à 75 environnements, même si le nombre d'environnements que vous pouvez créer dépend de votre contrat. (Recommandé) Pour un scaling et une flexibilité robustes.
/20 4 096 adresses IP (212) Jusqu'à 14 environnements (peut être +/- 1, selon les conditions) Convient aux utilisateurs qui ne disposent pas d'exigences de scaling élevées (comme dans des environnements hors production) ou qui n'ont pas suffisamment d'adresses IP dans une région donnée.

Points essentiels

Le tableau suivant répertorie les points importants à retenir à propos des environnements, des organisations et des groupes d'environnements :

Élément Règles
Organisations
  • Peuvent contenir plusieurs groupes d'environnements
  • Doivent disposer d'au moins un groupe d'environnements
Environnements
  • Doivent se trouver dans au moins un groupe d'environnements
  • Peuvent appartenir à plusieurs groupes
  • Partagent les noms d'hôte avec tous les autres environnements du même groupe
Groupes d'environnements
  • Peuvent avoir plusieurs noms d'hôte
  • Contiennent un ou plusieurs environnements
  • Les noms d'hôte attribués à un groupe doivent être uniques pour ce groupe (ils ne peuvent pas être utilisés par d'autres groupes)

Pour connaître le nombre de groupes d'environnements par organisation et le nombre d'environnements par groupe dont vous pouvez disposer, consultez les limites.

Exemples

Les sections suivantes présentent des méthodes courantes dans lesquelles les environnements sont structurés au sein des groupes d'environnements.

Un groupe d'environnements et un environnement

La structure la plus simple consiste en un groupe d'environnements unique contenant un seul environnement. Cette structure est fréquente lorsque les entreprises évaluent actuellement le produit, ou n'ont pas encore configuré d'infrastructure de test ou d'analyse, ou n'ont aucun proxy déployé en production.

Un groupe d'environnements pour un environnement

Plusieurs environnements dans un même groupe

Une organisation peut contenir plusieurs groupes d'environnements. Par exemple, vous pouvez définir les groupes d'environnement dev, test et prod dans une organisation, et mapper chacun d'entre eux sur un seul nom d'hôte (ou adresse IP). Chaque groupe peut inclure un ou plusieurs environnements :

Un groupe d'environnements pour plusieurs environnements

Groupes d'environnements en fonction des accès

Comme vous pouvez attribuer le même environnement à plusieurs groupes, vous pouvez organiser vos environnements par accès. Par exemple, vous pouvez rendre vos environnements de production accessibles sur un seul groupe d'environnements interne, tout en limitant l'accès à certains de ces environnements sur un groupe public, qui serait ouvert à Internet :

Un groupe d'environnements pour les ressources internes et un pour les ressources externes

Groupes d'environnements en fonction des unités commerciales

Avec un ensemble plus grand et plus complexe de proxys actifs déployés, il est courant d'aligner les groupes d'environnements avec les unités commerciales. Par exemple, vous pouvez avoir des groupes d'environnement pour vos équipes de test, de production et de développement :

Un groupe d'environnements par unité commerciale

 

Prêt à créer un groupe ?

Ouvrez la console

 

 

Pour en savoir plus sur les environnements :

Continuer à lire

 

 

Pour en savoir plus sur les groupes d'environnements :

Continuer à lire

 

Routage et chemins de base

Dans une configuration simple, une requête adressée à un proxy d'API déployé se compose d'un nom d'hôte, d'un chemin de base et du nom d'une ressource d'API. Par exemple :

https://www.example.com/shopping/cart/addItem
        |_____________| |___________| |_____|
               |             |           |
            hostname      basepath     resource

Vous devez définir des noms d'hôte sur le groupe d'environnement pour que plusieurs environnements puissent les partager. Les chemins de base et les ressources de l'API sont définis sur le proxy d'API.

Pour en savoir plus sur les chemins de base et les ressources de l'API, commencez par Comprendre les routes. En outre, consultez la documentation de référence sur la configuration des flux et la documentation de référence sur les variables de flux pour mieux comprendre le lien entre ces éléments.

Noms d'hôte

Lorsque vous créez un groupe d'environnements, vous lui associez un ou plusieurs noms d'hôte. Par exemple, vous pouvez avoir les groupes d'environnement suivants, chacun avec ses propres noms d'hôte :

Nom du groupe d'environnements
(environnements)
prod-group

(catalog-prod
cart-prod
pymnt-prod)
dev-group

(dev-env)
test-group

(test-env)
Noms d'hôte catalog.example.com
payment.example.com
dev.example.com test.example.com

Vous définissez des chemins de base sur le proxy lorsque vous le créez.

Lorsque vous déployez un proxy dans un environnement du groupe, le nom d'hôte, ainsi que le chemin d'accès de base et le nom de ressource définissent ensemble le point de terminaison d'une requête API vers ce proxy.

Vous pouvez définir plusieurs noms d'hôte sur un groupe d'environnements. Ils peuvent tous être utilisés pour appeler n'importe quel proxy déployé dans n'importe quel environnement du groupe. Par exemple, catalog.example.com/proxy1 et payment.example.com/proxy1 appelleront tous deux la ressource proxy1 si les noms d'hôte catalog.example.com et payment.example.com sont définis sur le même groupe d'environnement.

Pour accepter plusieurs noms d'hôte sur un même groupe d'environnement partagé par plusieurs environnements, Apigee achemine les requêtes d'API vers différents proxys de différentes manières.

Exemple de routage

Exemple :

  • Le groupe d'environnement prod-group contient les environnements suivants :

    • catalog-prod
    • cart-prod
    • pymnt-prod
  • Les noms d'hôte suivants sont définis dans prod-group :

    • catalog.example.com
    • payment.example.com
  • Les proxys suivants sont déployés dans ces environnement :

    • Le proxy catalog sur catalog-prod avec le chemin de base /catalog
    • Le proxy cart sur cart-prod avec le chemin de base /catalog/cart
    • Le proxy payment sur pymnt-prod avec le chemin de base /payment

Les points de terminaison suivants sont ainsi créés :

  • catalog.example.com/catalog redirige vers le proxy catalog dans l'environnement catalog-prod.
  • catalog.example.com/catalog/cart redirige vers le proxy cart dans l'environnement cart-prod.
  • payment.example.com/payment redirige vers le proxy payment dans l'environnement pymnt-prod.

L'exemple suivant montre que les requêtes sont acheminées vers différents proxys déployés dans les environnements du groupe, en fonction du nom d'hôte et du chemin de base :

Les requêtes API sont acheminées vers différents environnements du groupe en fonction du nom d'hôte et du chemin de base.

Environnements partagés et routage

Les environnements peuvent appartenir à plusieurs groupes d'environnements. Toutefois, les noms d'hôte doivent être uniques pour un seul groupe d'environnement. Par conséquent, appartenir à plusieurs groupes fournit plusieurs adresses pour les proxys déployés dans cet environnement. Cela est utile si un client dispose de certificats génériques (comme *.example.com) pour plusieurs partenaires.

Exemple :

  • shared-env appartient à deux groupes d'environnements :
    • partner-1 avec l'alias d'hôte api.partner-1.com
    • partner-2 avec l'alias d'hôte api.partner-2.com
  • Le proxy foo est déployé sur shared-env avec le chemin de base /foo. Comme shared-env est partagé par les deux groupes d'environnement, foo comporte deux adresses :
    • partner-1.example.com/foo
    • partner-2.example.com/foo

Dans ce cas, les deux noms d'hôte redirigent vers le même environnement. Dans ce cas de figure, une entreprise expose différents noms d'hôte pour chaque partenaire, en attribuant à chacun d'eux un nom de domaine personnalisé. Pour Apigee hybrid, ce scénario peut utiliser mTLS avec un certificat différent pour chaque partenaire.

À propos du champ d'application de l'environnement

L'organisation fournit des champ d'application pour certaines fonctionnalités d'Apigee. Par exemple, les données de mappage clé-valeur (KVM) peuvent être rendues disponibles au niveau de l'organisation, ce qui signifie que les proxys d'API déployés dans n'importe quel environnement de cette organisation peuvent accéder aux mêmes données KVM.

De même, certaines fonctionnalités peuvent être limitées à des environnements ou des groupes d'environnements au sein de l'organisation. Par exemple, les données d'analyse Apigee sont partitionnées en fonction d'une combinaison d'organisation, d'environnement et (à terme) de groupe d'environnements.

Remarques

Chaque déploiement dans un environnement peut affecter le routage du trafic pour chaque groupe d'environnement auquel il est associé. Lorsque de nouveaux chemins de base sont ajoutés, ils peuvent commencer à capturer du trafic entièrement nouveau ou commencer à capturer un sous-ensemble du trafic existant déjà géré par un déploiement existant.

De même, lorsque les chemins de base sont supprimés, ils peuvent correspondre à des points de terminaison qui ne reçoivent plus aucun trafic, ou entraîner une redirection du trafic existant vers un proxy différent. Lorsque le trafic est redirigé, ce peut être vers un proxy situé dans le même environnement, ou lorsque plusieurs environnements partagent un même groupe d'environnement, ce peut être vers un proxy dans un environnement différent.

Autres ressources

Les informations suivantes décrivent comment gérer vos environnements et groupes d'environnement :