Accéder aux données de configuration

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

Consultez la documentation d' Apigee Edge.

Les développeurs de proxy d'API font généralement appel à un ou plusieurs mécanismes de persistance des données Apigee pour stocker les données de configuration afin de pouvoir y accéder ultérieurement dans un proxy d'API. Cet article explique comment choisir le mécanisme de persistance approprié en fonction de votre cas d'utilisation.

Mécanismes de persistance

Le tableau suivant décrit brièvement les mécanismes de persistance disponibles dans Apigee :
Mécanisme Utilisation
Mappages clé-valeur Les mappages clé-valeur (KVM) fournissent un magasin d'exécution général pour les données susceptibles de changer régulièrement. Par exemple, les données de session utilisateur, le panier, etc. Les entrées KVM peuvent être chiffrées. Voir aussi Utiliser des mappages clé-valeur.
Ensembles de propriétés Les ensembles de propriétés conviennent pour le stockage des données de configuration qui ne changent pas souvent. Consultez également la section Utiliser les ensembles de propriétés.
Codes secrets Kubernetes (Apigee hybride uniquement) Utilisez des codes secrets pour stocker les données sensibles, telles que les identifiants de l'utilisateur. Consultez également la section Stocker des données dans un secret Kubernetes.

Champ d'application des mécanismes de persistance

Chacun des mécanismes de persistance disponibles dispose d'un champ d'application spécifique qui détermine le moyen d'accès aux données stockées. Le tableau suivant récapitule les champs d'application disponibles pour chaque mécanisme de persistance. Pour en savoir plus sur les champs d'application, consultez les sections À propos du champ d'application de la persistance et Champs d'application des ensembles de propriétés.

Organisation Environment Proxy d'API
Mappages clé-valeur Oui Oui Oui
Ensembles de propriétés Non Oui Oui
Secrets Kubernetes Non Oui Non

Choisir le mécanisme de persistance à utiliser

Cette section décrit les cas d'utilisation de chaque mécanisme de persistance pour vous aider à choisir le mécanisme le mieux adapté au stockage de données de configuration.

Quand utiliser des mappages clé-valeur

Apigee ne fournit pas d'API pour le stockage, la mise à jour ou la suppression de données KVM. Vous devez effectuer ces tâches en utilisant la règle KeyValueMapOperations. La règle vous permet d'effectuer des opérations KVM au moment de l'exécution, lorsque le proxy est en cours d'exécution.

Envisagez d'utiliser des KVM dans les cas suivants :

  • Vous avez des milliers, des centaines de milliers, ou des millions d'entrées de mappage clé-valeur (tout nombre allant jusqu'aux limites de taille KVM documentées).
  • Certaines de vos entrées ne sont pas connues au moment de la conception.

Par exemple, utilisez les KVM pour stocker des données de session utilisateur lorsqu'un utilisateur se connecte et les supprimer lorsqu'il se déconnecte.

Quand utiliser des ensembles de propriétés ?

Nous vous conseillons d'utiliser des ensembles de propriétés dans les cas suivants :

  • Les clés et les valeurs sont connues au moment de la conception. Les valeurs d'ensemble de propriétés ne peuvent pas être modifiées par le proxy d'API lorsqu'il est en cours d'exécution. Elles sont disponibles dans le flux du proxy en tant que variables en lecture seule.
  • Vous disposez de quelques centaines de clés (<110 Ko au total). Les clés et les valeurs de l'ensemble de propriétés sont toujours stockées en mémoire pour un accès rapide.
  • Vous souhaitez pouvoir permettre aux administrateurs de modifier les ensembles de propriétés d'un environnement sans redéployer les proxys d'API.

Par exemple, les ensembles de propriétés conviennent pour le stockage des règles de routage. Les règles de routage sont des paires clé/valeur où les valeurs sont des URL de point de terminaison cibles. Ces valeurs varient généralement d'un environnement à l'autre et peuvent être partagées par plusieurs proxys d'API déployés dans un environnement. Les ensembles de propriétés peuvent également convenir pour stocker des clés et des certificats publics.

Quand utiliser les secrets Kubernetes

Cette option n'est disponible qu'avec Apigee hybrid. Elle permet à un proxy d'API d'accéder aux données stockées dans les secrets Kubernetes. Cette option est semblable aux ensembles de propriétés, où les données stockées sont disponibles en tant que variables de flux de messages dans le proxy en cours d'exécution. Toutefois, les données restent toujours dans le plan d'exécution. Elles ne sont jamais définies sur le plan de gestion dans le cloud Apigee.

Vous pouvez envisager d'utiliser des secrets Kubernetes dans les cas suivants :

  • Vous devez stocker des informations sensibles que vous ne souhaitez jamais stocker dans le plan de gestion. Par exemple, vous pouvez utiliser un secret Kubernetes pour stocker des clés privées ou des identifiants requis pour accéder à des systèmes externes.
  • Vous devez partager des données stockées avec plusieurs proxys d'API déployés dans le même environnement.