Documentation de référence sur les propriétés de configuration

Cette section répertorie toutes les propriétés de configuration que vous pouvez utiliser pour personnaliser le plan d'exécution de votre déploiement hybride Apigee.

Filtrer cette page

Pour filtrer les propriétés affichées sur cette page, sélectionnez Propriétés de base (les plus courantes) ou Avancées (propriétés qui doivent rarement être modifiées) :

Afficher   les propriétés de configuration sur cette page.

Propriétés de niveau supérieur

Le tableau suivant décrit les propriétés de niveau supérieur dans le fichier overrides.yaml. Voici les propriétés qui n'appartiennent pas à un autre objet et s'appliquent au niveau de l'organisation ou de l'environnement :

Propriété Type Description
axHashSalt Avancé

Introduit dans la version : 1.3.0

Valeur par défaut : nom de votre organisation

Facultatif

Nom d'un secret Kubernetes contenant un salage utilisé lors du calcul de hachages pour obscurcir les données utilisateur avant leur envoi à Apigee Analytics. Si vous ne spécifiez pas de valeur de salage, iloveapis123 est utilisé par défaut. Créez le secret avec la valeur de salage en tant qu'entrée. Vous pouvez utiliser le même salage sur plusieurs clusters pour garantir des résultats de hachage cohérents entre les clusters.

Apigee utilise SHA512 pour hacher la valeur d'origine avant d'envoyer les données du plan d'exécution au plan de contrôle.

Consultez la page Obscurcir les données utilisateur pour l'analyse.

contractProvider Avancé Introduit dans la version : 1.0.0

Valeur par défaut : https://apigee.googleapis.com

Définit le chemin d'accès de toutes les API dans votre installation.

Obligatoire si votre installation hybride utilise la résidence des données au format suivant :

contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

CONTROL_PLANE_LOCATION est l'emplacement où les données du plan de contrôle, comme les bundles proxy, sont stockées. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles.

Exemple :

contractProvider: https://us-apigee.googleapis.com
gcpProjectID Avancé Deprecated: Pour la version 1.2.0 et les versions ultérieures, utilisez plutôt gcp.projectID.

Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

ID de votre projet Google Cloud. Fonctionne avec k8sClusterName (obsolète) et gcpRegion (obsolète) pour identifier le projet et déterminer où apigee-logger et apigee-metrics transfèrent leurs données.

gcpRegion Avancé Deprecated: Pour la version 1.2.0 et les versions ultérieures, utilisez plutôt gcp.region.

Introduit dans la version : 1.0.0

Valeur par défaut : us-central1

Obligatoire

Région ou zone Google Cloud la plus proche de votre cluster Kubernetes. Fonctionne avec gcpProjectID (obsolète) et k8sClusterName (obsolète) pour identifier le projet, et pour déterminer où apigee-logger et apigee-metrics transfèrent leurs données.

hub Avancé Introduit dans la version : 1.11.0

Valeur par défaut : aucune

URL d'un dépôt de conteneurs d'images privé utilisé pour extraire des images de tous les composants Apigee d'un dépôt privé.

hub fournit un chemin d'accès par défaut pour tous les composants Apigee hybrid. Si vous utilisez un dépôt privé, utilisez hub pour définir l'URL du dépôt pour tous les composants au lieu d'utiliser la propriété image.url individuelle pour chaque composant. Ne configurez des URL individuelles que si vous utilisez un dépôt distinct pour un composant spécifique.

Le chemin d'accès à l'image de chaque composant sera la valeur de hub plus le nom et le tag de l'image du composant.

Par exemple, si la valeur de hub private-docker-host.example.com, les composants individuels résolvent automatiquement le chemin d'accès de l'image :

hub: private-docker-host.example.com

comme :

## an example of internal component vs 3rd party
containers:
- name: apigee-udca
  image: private-docker-host.example.com/apigee-udca:1.13.0
  imagePullPolicy: IfNotPresent

containers:
- name: apigee-ingressgateway
  image: private-docker-host.example.com/apigee-asm-ingress:1.18.7-asm.4-distroless
  imagePullPolicy: IfNotPresent

Les autres composants suivront un schéma semblable.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt pour tous les composants.

Consultez Utiliser un dépôt d'images privé avec Apigee hybrid.

Vous pouvez remplacer l'URL de l'image pour les composants individuellement à l'aide des propriétés suivantes :

imagePullSecrets.name Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Nom du secret Kubernetes configuré comme type de registre Docker utilisé pour extraire des images d'un dépôt privé.

instanceID De base Introduit dans la version : 1.3.0

Valeur par défaut : aucune

Obligatoire

Identifiant unique de cette installation.

Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères).

k8sClusterName Avancé Deprecated: Pour les versions 1.2.0 et ultérieures, utilisez plutôt k8sCluster.name et k8sCluster.region.

Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Nom du procluster Kubernetes (K8S) dans lequel votre projet hybride est exécuté. Fonctionne avec gcpProjectID (obsolète) et gcpRegion (obsolète) pour identifier le projet, et pour déterminer où apigee-logger et apigee-metrics transfèrent leurs données.

kmsEncryptionKey Avancé Introduit dans la version : 1.0.0

Valeur par défaut : defaults.org.kmsEncryptionKey

Facultatif. Utilisez une seule des valeurs suivantes : kmsEncryptionKey, kmsEncryptionKey ou kmsEncryptionKey.

Chemin d'accès au système de fichiers local pour la clé de chiffrement des données du service de gestion des clés d'Apigee.

kmsEncryptionPath Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Facultatif. Utilisez une seule des valeurs suivantes : kmsEncryptionKey, kmsEncryptionKey ou kmsEncryptionKey.

Chemin d'accès à un fichier contenant une clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

kmsEncryptionSecret.key Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Facultatif. Utilisez une seule des valeurs suivantes : kmsEncryptionKey, kmsEncryptionKey ou kmsEncryptionKey.

Clé d'un secret Kubernetes contenant une clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

kmsEncryptionSecret.name Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Facultatif. Utilisez une seule des valeurs suivantes : kmsEncryptionKey, kmsEncryptionKey ou kmsEncryptionKey.

Nom d'un secret Kubernetes contenant une clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

kvmEncryptionKey Avancé Introduit dans la version : 1.0.0

Valeur par défaut : defaults.org.kmsEncryptionKey

Facultatif. Utilisez une seule des valeurs suivantes : kvmEncryptionKey, kvmEncryptionKey ou kvmEncryptionKey.

Chemin d'accès au système de fichiers local pour la clé de chiffrement des données du KVM d'Apigee.

kvmEncryptionPath Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Facultatif. Utilisez une seule des valeurs suivantes : kvmEncryptionKey, kvmEncryptionKey ou kvmEncryptionKey.

Chemin d'accès à un fichier contenant une clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

kvmEncryptionSecret.key Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Facultatif. Utilisez une seule des valeurs suivantes : kvmEncryptionKey, kvmEncryptionKey ou kvmEncryptionKey.

Clé d'un secret Kubernetes contenant une clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

kvmEncryptionSecret.name Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Facultatif. Utilisez une seule des valeurs suivantes : kvmEncryptionKey, kvmEncryptionKey ou kvmEncryptionKey.

Nom d'un secret Kubernetes contenant une clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

multiOrgCluster Avancé Introduit dans la version : 1.10.0

Valeur par défaut : false

Pour les clusters multi-organisation, cette propriété permet d'exporter les métriques de l'organisation vers le projet répertorié dans la propriété gcp.projectID. Appliquez ce paramètre dans le fichier de remplacement pour chaque organisation d'un cluster multi-organisation. Pour en savoir plus, consultez la section Ajouter plusieurs organisations hybrides à un cluster.

namespace De base Introduit dans la version : 1.0.0

Valeur par défaut : apigee

Espace de noms de votre cluster Kubernetes dans lequel les composants Apigee seront installés.

org De base

Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Organisation compatible hybride qui a été provisionnée par Apigee lors de l'installation hybride. Une organisation est le conteneur de niveau supérieur dans Apigee. Elle contient tous les proxys d'API et les ressources associées. Si la valeur est vide, vous devez la mettre à jour avec le nom de votre organisation après l'avoir créée.

orgScopedUDCA Avancé Introduit dans la version : 1.8.0

Valeur par défaut : true

Active le service de l'agent de collecte des données universel (UDCA, Universal Data Collection Agent) au niveau de l'organisation, qui extrait les données analytiques, de monétisation et de débogage (trace), et les envoie à la plate-forme d'analyse unifiée (UAP, Unified Analytics Platform) qui réside dans le plan de contrôle.

L'UDCA au niveau de l'organisation utilise un seul compte de service Google pour tous les environnements Apigee. Le compte de service doit disposer du rôle Apigee Analytics Agent (roles/apigee.analyticsAgent).

Spécifiez le chemin d'accès au fichier de clé de compte de service avec la propriété udca.serviceAccountPath ou fournissez la clé dans un secret Kubernetes à l'aide de la propriété udca.serviceAccountRef de votre fichier de configuration overrides.yaml.

Si vous préférez utiliser un agent UDCA distinct pour chaque environnement, définissez orgScopedUDCA: false et définissez les valeurs pour envs[].serviceAccountPaths.udca et envs[].serviceAccountSecretRefs.udca.

Voir aussi : udca.

revision Avancé Introduit dans la version : 1.0.0

Valeur par défaut : "1130" (votre version hybride Apigee sans points). Par exemple, pour la version 1.12.0, la valeur par défaut est "1120".)

Apigee hybrid est compatible avec les mises à jour progressives de Kubernetes. Elles permettent de mettre à jour les déploiements sans interruption de service grâce à une mise à jour progressive des instances de pod avec de nouvelles instances.

Lors de la mise à jour de certains remplacements YAML, qui entraînent une modification de la spécification PodTemplateSpec sous-jacente de Kubernetes, la propriété de remplacement revision doit également être modifiée dans le fichier override.yaml du client. Cette action est requise pour que le contrôleur Kubernetes ApigeeDeployment (AD) sous-jacent effectue une mise à jour progressive sécurisée de la version précédente vers la nouvelle version. Vous pouvez utiliser n'importe quelle valeur de texte en minuscules, par exemple : blue, a et 1.0.0.

Lorsque la propriété revision est modifiée et appliquée, une mise à jour progressive est effectuée pour tous les composants.

Les modifications apportées aux propriétés des objets suivants nécessitent une mise à jour de revision :

Pour en savoir plus, consultez la section Mises à jour progressives.

serviceAccountSecretProviderClass Avancé Introduit dans la version : 1.12.0

Valeur par défaut : aucune

Nom de la classe de fournisseur de secrets spécifique à l'organisation (SecretProviderClass) utilisée pour stocker les clés de compte de service dans Vault.

Consultez la section Stocker des clés de compte de service dans Hashicorp Vault.

validateOrg Avancé Introduit dans la version : 1.8.0

Valeur par défaut : true

Active la validation stricte de la liaison entre l'organisation Apigee et le projet Google Cloud, et vérifie l'existence de groupes d'environnements.

Voir également : org

validateServiceAccounts Avancé Introduit dans la version : 1.0.0

Valeur par défaut : true

Active la validation stricte des autorisations du compte de service. Ce code utilise la méthode de l'API Cloud Resource Manager testIamPermissions pour vérifier que le compte de service fourni dispose des autorisations requises. Dans le cas des comptes de service d'une organisation Apigee, la vérification de l'ID du projet est celle qui est mappée à l'organisation. Pour les propriétés Metrics et Logger, le projet vérifié est basé sur la configuration de gcpProjectID dans le fichier overrides.yaml.

Voir également : gcpProjectID

ao

Apigee Operators (AO) crée et met à jour les ressources Kubernetes et Istio de bas niveau qui sont nécessaires au déploiement et à la gestion d'un composant. Par exemple, le contrôleur effectue le lancement des processeurs de message.

Le tableau suivant décrit les propriétés de l'objet ao apigee-operators :

Propriété Type Description
ao.args.disableIstioConfigInAPIServer Avancé Introduit dans la version : 1.8.0

Valeur par défaut : true

Indique à Apigee de cesser de fournir une configuration aux instances Cloud Service Mesh installées par le client.

  • Défini sur true pour les installations hybrides utilisant la passerelle d'entrée Apigee.
  • Défini sur false pour les installations hybrides utilisant Cloud Service Mesh (Apigee hybrid versions 1.8 et antérieures).
ao.args.disableManagedClusterRoles Avancé Introduit dans la version : 1.10.0

Valeur par défaut : true

Quand cette propriété est définie sur true (valeur par défaut), Apigee hybrid ne gère pas directement les objets ClusterRole et ClursterRoleBinding de Kubernetes. Si un processus requiert de gérer ces ressources, il doit être effectué par un utilisateur disposant des autorisations appropriées.

ao.image.pullPolicy Avancé Introduit dans la version : 1.2.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

ao.image.tag Avancé Introduit dans la version : 1.2.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

ao.image.url Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

ao.resources.limits.cpu Avancé Introduit dans la version : 1.2.0

Valeur par défaut : 250m

Limite de processeur pour la ressource dans un conteneur Kubernetes, en millicores.

ao.resources.limits.memory Avancé Introduit dans la version : 1.2.0

Valeur par défaut : 256Mi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

ao.resources.requests.cpu Avancé Introduit dans la version : 1.2.0

Valeur par défaut : 250m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

ao.resources.requests.memory Avancé Introduit dans la version : 1.2.0

Valeur par défaut : 256Mi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets.

ao.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

ao.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

ao.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

ao.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

ao.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

apigeeIngressGateway

Configure la passerelle d'entrée Apigee pour Apigee hybrid. Utilisez les propriétés apigeeIngressGateway pour appliquer une configuration commune à toutes les instances de la passerelle d'entrée Apigee.

Consultez la page sur la commande ingressGateways pour configurer des instances individuelles de manière unique.

Appliquez les modifications aux propriétés apigeeIngressGateway à l'aide du graphique apigee-org.

Le tableau suivant décrit les propriétés de l'objet apigeeIngressGateway :

Propriété Type Description
apigeeIngressGateway.image.pullPolicy Avancé Introduit dans la version : 1.11.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

apigeeIngressGateway.image.tag Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 1.18.7-asm.4-distroless

Libellé de la version pour l'image Docker de ce service.

apigeeIngressGateway.image.url Avancé Introduit dans la version : 1.11.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

apigeeIngressGateway.nodeSelector.key Avancé Introduit dans la version : 1.11.0

Valeur par défaut : aucune

Obligatoire

Clé de libellé de sélecteur de nœud utilisée pour cibler des nœuds Kubernetes dédiés pour les services de passerelle d'entrée.

Consultez la page Configurer des pools de nœuds dédiés.

apigeeIngressGateway.nodeSelector.value Avancé Introduit dans la version : 1.11.0

Valeur par défaut : aucune

Valeur de libellé de sélecteur de nœud facultative utilisée pour cibler des nœuds Kubernetes dédiés pour les services de passerelle d'entrée et remplacer les paramètres nodeSelector.apigeeData.

Consultez la section nodeSelector.

apigeeIngressGateway.replicaCountMax De base Introduit dans la version : 1.11.0

Valeur par défaut : 4

Nombre maximal de pods que l'installation hybride peut ajouter automatiquement pour la passerelle d'entrée disponible pour l'autoscaling.

apigeeIngressGateway.replicaCountMin De base Introduit dans la version : 1.11.0

Valeur par défaut : 2

Nombre minimal de pods pour la passerelle d'entrée disponible pour l'autoscaling.

apigeeIngressGateway.targetCPUUtilizationPercentage Avancé Introduit dans la version : 1.10.5, 1.11.2, 1.12.1

Valeur par défaut : 75

Seuil d'utilisation du processeur pour le scaling du nombre de pods dans ReplicaSet, sous forme de pourcentage du total des ressources processeur disponibles.

Lorsque l'utilisation du processeur dépasse cette valeur, hybrid augmente progressivement le nombre de pods, jusqu'à apigeeIngressGateway.replicaCountMax.

Pour plus d'informations sur le scaling dans Kubernetes, consultez la section Autoscaling horizontal des pods dans la documentation de Kubernetes.

apigeeIngressGateway.tolerations.effect Avancé Introduit dans la version : 1.11.0

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

apigeeIngressGateway.tolerations.key Avancé Introduit dans la version : 1.11.0

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

apigeeIngressGateway.tolerations.operator Avancé Introduit dans la version : 1.11.0

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

apigeeIngressGateway.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.11.0

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

apigeeIngressGateway.tolerations.value Avancé Introduit dans la version : 1.11.0

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

cassandra

Définit le service hybride qui gère le dépôt de données d'exécution. Ce dépôt stocke les configurations d'application, les compteurs de quotas distribués, les clés API et les jetons OAuth pour les applications exécutées sur la passerelle.

Pour en savoir plus, consultez la page Configuration de StorageClass.

Le tableau suivant décrit les propriétés de l'objet cassandra :

Propriété Type Description
cassandra.annotations Avancé Introduit dans la version : 1.5.0

Valeur par défaut : aucune

Mappage clé/valeur facultatif utilisé pour annoter les pods. Pour en savoir plus, consultez la section Annotations personnalisées.

cassandra.auth.admin.password De base Introduit dans la version : 1.0.0

Valeur par défaut : iloveapis123

Obligatoire

Mot de passe de l'administrateur Cassandra. Le rôle d'administrateur est utilisé pour toutes les activités d'administration effectuées sur le cluster Cassandra, telles que la sauvegarde et la restauration.

cassandra.auth.ddl.password De base Introduit dans la version : 1.0.0

Valeur par défaut : iloveapis123

Obligatoire

Mot de passe de l'utilisateur Cassandra LDD (langage de définition de données) Utilisé par MART pour toutes les tâches de définition de données telles que la création, la mise à jour et la suppression d'espaces de clés.

cassandra.auth.default.password De base Introduit dans la version : 1.0.0

Valeur par défaut : iloveapis123

Obligatoire

Mot de passe de l'utilisateur Cassandra par défaut créé lorsque l'Authentification est activée. Ce mot de passe doit être réinitialisé lors de la configuration de l'authentification Cassandra. Consultez la section Configurer TLS pour Cassandra.

cassandra.auth.dml.password De base Introduit dans la version : 1.0.0

Valeur par défaut : iloveapis123

Obligatoire

Mot de passe de l'utilisateur Cassandra LMD (langage de manipulation de données). L'utilisateur LMD est utilisé par la communication du client pour lire et écrire des données dans Cassandra.

cassandra.auth.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

cassandra.auth.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

cassandra.auth.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

cassandra.auth.jmx.password De base Introduit dans la version : 1.4.0

Valeur par défaut : iloveapis123

Obligatoire

Mot de passe de l'utilisateur d'opérations Cassandra JMX. Permet l'authentification et la communication avec l'interface Cassandra JMX.

cassandra.auth.jmx.username De base Introduit dans la version : 1.4.0

Valeur par défaut : jmxuser

Obligatoire

Nom de l'utilisateur d'opérations Cassandra JMX. Permet l'authentification et la communication avec l'interface Cassandra JMX.

cassandra.auth.jolokia.password De base Introduit dans la version : 1.4.0

Valeur par défaut : iloveapis123

Obligatoire

Mot de passe de l'utilisateur d'opérations Cassandra Jolokia JMX. Permet l'authentification et la communication avec l'API Cassandra JMX.

cassandra.auth.jolokia.username De base Introduit dans la version : 1.4.0

Valeur par défaut : apigee

Obligatoire

Nom de l'utilisateur d'opérations Cassandra Jolokia JMX. Permet l'authentification et la communication avec l'API Cassandra JMX.

cassandra.auth.secret De base Introduit dans la version : 1.3.3

Valeur par défaut : aucune

Nom du fichier stocké dans un secret Kubernetes contenant les utilisateurs et les mots de passe Cassandra. Vous pouvez créer le secret en suivant les instructions suivantes : Créer le secret.

Voir également :

cassandra.auth.secretProviderClass Avancé Introduit dans la version : 1.10.3

Valeur par défaut : aucune

Règle de stockage de secrets Cassandra. Lorsqu'elle est définie, elle doit correspondre à la valeur SecretProviderClass qui fait référence au fournisseur de secrets externes, tel que Hashicorp Vault. Lorsqu'elle n'est pas définie, Apigee hybrid utilise les noms d'utilisateur et les mots de passe stockés dans :

ou le secret Kubernetes stocké dans :

Pour savoir comment créer la règle, consultez la section Stocker des secrets Cassandra dans Hashicorp Vault.

cassandra.backup.cloudProvider Avancé Introduit dans la version : 1.0.0

Valeur par défaut : GCP

Nom d'un fournisseur de secours. Valeurs acceptées : GCP, HYBRID et CSI. Définissez la valeur sur :

  • GCP pour stocker des archives de sauvegarde sur Google Cloud Storage.
  • HYBRID pour stocker les archives de sauvegarde sur un serveur SSH distant.
  • CSI (recommandé) pour utiliser les instantanés de volume Kubernetes CSI pour la sauvegarde. Pour plus d'informations sur la sauvegarde et la restauration de CSI pour les plates-formes cloud telles que Google Cloud, AWS et Azure, consultez la page Sauvegarde et restauration de CSI.
cassandra.backup.dbStorageBucket Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire si la sauvegarde est activée et que cassandra.backup.cloudProvider est défini sur GCP.

Nom d'un bucket Google Cloud Storage existant qui sera utilisé pour stocker les archives de sauvegarde. Si vous devez en créer un, consultez la page Créer des buckets.

cassandra.backup.enabled Avancé Introduit dans la version : 1.0.0

Valeur par défaut : false

La sauvegarde des données n'est pas activée par défaut. Pour l'activer, définissez ce paramètre sur true.

Consultez la section Sauvegarde et récupération Cassandra.

cassandra.backup.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

cassandra.backup.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

cassandra.backup.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

cassandra.backup.schedule Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 0 2 * * *

Planification pour la job Cron.

Consultez la section Sauvegarde et récupération Cassandra.

cassandra.backup.serviceAccountPath Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Chemin d'accès à un fichier de clé de compte de service Google doté du rôle Administrateur des objets de l'espace de stockage (roles/storage.objectAdmin). Ce compte de service Google sera utilisé pour importer des archives de sauvegarde dans un cassandra.backup.dbStorageBucket spécifié.

Si la sauvegarde est activée et que cassandra.backup.cloudProvider est défini sur GCP, l'une des conditions suivantes est requise pour garantir qu'Apigee hybrid peut accéder au bucket Google Cloud Storage pour importer des archives de sauvegarde :

cassandra.backup.serviceAccountRef Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Nom d'un secret Kubernetes existant qui stocke le contenu d'un fichier de clé de compte de service Google doté du rôle d'administrateur des objets de l'espace de stockage (roles/storage.objectAdmin) . Ce compte de service Google sera utilisé pour importer des archives de sauvegarde dans un cassandra.backup.dbStorageBucket spécifié.

Si la sauvegarde est activée et que cassandra.backup.cloudProvider est défini sur GCP, l'une des conditions suivantes est requise pour garantir qu'Apigee hybrid peut accéder au bucket Google Cloud Storage pour importer des archives de sauvegarde :

cassandra.clusterName De base Introduit dans la version : 1.0.0

Valeur par défaut : apigeecluster

Spécifie le nom du cluster Cassandra.

cassandra.datacenter De base Introduit dans la version : 1.0.0

Valeur par défaut : dc-1

Spécifie le centre de données du nœud Cassandra.

cassandra.dnsPolicy De base Introduit dans la version : 1.1.1

Valeur par défaut : aucune

Lorsque vous définissez hostNetwork sur "true", la règle DNS est définie sur ClusterFirstWithHostNet pour vous.

cassandra.externalSeedHost De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Nom d'hôte ou adresse IP d'un nœud de cluster Cassandra. S'il n'est pas défini, le service local Kubernetes est utilisé.

cassandra.heapNewSize De base Introduit dans la version : 1.0.0

Valeur par défaut : 100M

Quantité de mémoire système JVM allouée aux objets plus récents, en mégaoctets.

cassandra.hostNetwork De base Introduit dans la version : 1.1.1

Valeur par défaut : false

Active la fonctionnalité hostNetwork de Kubernetes. Apigee utilise cette fonctionnalité dans les installations multirégionales pour communiquer entre les pods si l'espace de noms réseau du pod n'a pas de connectivité entre les clusters (les clusters s'exécutent en mode "réseau en îlots"), ce qui est le cas par défaut dans les installations autres que GKE, y compris Google Distributed Cloud sur VMware ou Bare Metal, GKE sur AWS, AKS, EKS et OpenShift.

Définissez cassandra.hostNetwork sur false pour les installations régionales et multirégionales avec une connectivité entre les pods dans différents clusters, par exemple pour les installations GKE.

Définissez cassandra.hostNetwork sur true pour les installations multirégionales sans communication entre les pods dans différents clusters, par exemple Google Distributed Cloud sur VMware ou Bare Metal, GKE sur AWS, AKS, EKS et OpenShift. Consultez la section Déploiement multirégional : prérequis.

Lorsque true, la règle DNS est automatiquement définie sur ClusterFirstWithHostNet.

cassandra.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

cassandra.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

cassandra.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

cassandra.maxHeapSize Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 512M

Limite supérieure de mémoire système JVM disponible pour les opérations Cassandra, en mégaoctets.

cassandra.multiRegionSeedHost De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Adresse IP d'un cluster Cassandra existant utilisé pour étendre le cluster existant à une nouvelle région. Consultez la section Configurer l'hôte source multirégional.

cassandra.nodeSelector.key Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Clé d'étiquette de sélecteur de nœud utilisée pour cibler des nœuds Kubernetes dédiés pour les services de données cassandra.

Consultez la page Configurer des pools de nœuds dédiés.

cassandra.nodeSelector.value Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Valeur facultative du libellé de sélecteur de nœud permettant de cibler des nœuds Kubernetes dédiés aux services de données cassandra et de remplacer les paramètres nodeSelector.apigeeData.

Consultez la section nodeSelector.

cassandra.port Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 9042

Numéro de port utilisé pour se connecter à cassandra.

cassandra.rack De base Introduit dans la version : 1.0.0

Valeur par défaut : ra-1

Spécifie le rack du nœud Cassandra.

cassandra.readinessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 2

Nombre de fois où Kubernetes vérifie que les vérifications d'aptitude ont échoué avant de marquer le pod comme non prêt. La valeur minimale est 1.

cassandra.readinessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 0

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'aptitude.

cassandra.readinessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 10

Détermine la fréquence à laquelle effectuer une vérification d'aptitude, en secondes. La valeur minimale est 1.

cassandra.readinessProbe.successThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre minimal de succès consécutifs requis pour qu'une vérification d'aptitude soit considérée comme réussie après un échec. La valeur minimale est 1.

cassandra.readinessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

cassandra.replicaCount De base Introduit dans la version : 1.0.0

Valeur par défaut : 1

Cassandra est une base de données répliquée. Cette propriété spécifie le nombre de nœuds Cassandra utilisés comme StatefulSet.

cassandra.resources.requests.cpu Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

cassandra.resources.requests.memory Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1Gi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets.

cassandra.restore.cloudProvider Avancé Introduit dans la version : 1.0.0

Valeur par défaut : GCP

Nom d'un fournisseur de restauration. Valeurs acceptées : GCP, HYBRID et CSI. Définissez la valeur sur :

  • GCP pour restaurer les données à partir d'une sauvegarde stockée sur Google Cloud Storage.
  • HYBRID pour restaurer les données à partir d'une sauvegarde stockée sur un serveur SSH distant.
  • CSI (recommandé) pour utiliser les instantanés de volume Kubernetes CSI pour la restauration. Pour plus d'informations sur la sauvegarde et la restauration de CSI pour les plates-formes cloud telles que Google Cloud, AWS et Azure, consultez la page Sauvegarde et restauration de CSI.
cassandra.restore.dbStorageBucket Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire si la restauration est activée et que cassandra.restore.cloudProvider est défini sur GCP.

Nom d'un bucket Google Cloud Storage qui stocke des archives de sauvegarde à utiliser pour la restauration des données.

cassandra.restore.enabled Avancé Introduit dans la version : 1.0.0

Valeur par défaut : false

La restauration des données n'est pas activée par défaut. Pour l'activer, définissez ce paramètre sur true.

Consultez la section Sauvegarde et récupération Cassandra.

cassandra.restore.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

cassandra.restore.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

cassandra.restore.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

cassandra.restore.serviceAccountPath Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Chemin d'accès à un fichier de clé de compte de service Google disposant du rôle Administrateur des objets de l'espace de stockage (roles/storage.objectAdmin). Ce compte de service Google sera utilisé pour télécharger des archives de sauvegarde à partir d'un cassandra.restore.dbStorageBucket spécifié.

Si la restauration est activée et que cassandra.restore.cloudProvider est défini sur GCP, l'une des conditions suivantes est requise pour garantir qu'Apigee hybrid peut accéder au bucket Google Cloud Storage pour télécharger des archives de sauvegarde à restaurer :

cassandra.restore.serviceAccountRef Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Nom d'un secret Kubernetes existant qui stocke le contenu d'un fichier de clé de compte de service Google doté du rôle d'administrateur des objets de l'espace de stockage (roles/storage.objectAdmin) . Ce compte de service Google sera utilisé pour télécharger les archives de sauvegarde à partir d'un cassandra.restore.dbStorageBucket spécifié.

Si la restauration est activée et que cassandra.restore.cloudProvider est défini sur GCP, l'une des conditions suivantes est requise pour garantir qu'Apigee hybrid peut accéder au bucket Google Cloud Storage pour télécharger des archives de sauvegarde à restaurer :

cassandra.restore.snapshotTimestamp Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire si la restauration est activée.

Horodatage de la sauvegarde qui doit être restaurée.

cassandra.sslCertPath De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Chemin d'accès de votre système à un fichier de certificat TLS.

cassandra.sslKeyPath De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Chemin d'accès de votre système au fichier de clé privée TLS.

cassandra.sslRootCAPath De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Chaîne de certificats vers l'autorité de certification racine.

cassandra.storage.capacity De base Introduit dans la version : 1.0.0

Valeur par défaut : 10Gi

Obligatoire si storage.storageclass est spécifié

Spécifie la taille de disque requise, en mébioctets (Mi) ou gibioctets (Gi).

cassandra.storage.storageclass De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Spécifie la classe de stockage sur site utilisée.

cassandra.terminationGracePeriodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 300

Délai entre l'envoi d'une requête de suppression du pod et le moment où le pod est supprimé, en secondes. Pendant cette période, tous les hooks d'arrêt sont exécutés et tous les processus en cours doivent s'arrêter normalement.

cassandra.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

cassandra.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

cassandra.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

cassandra.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

cassandra.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

certManager

Apigee utilise cert-manager pour la validation du certificat.

Le tableau suivant décrit les propriétés de l'objet certManager :

Propriété Type Description
certManager.namespace Avancé Introduit dans la version : 1.9.0

Valeur par défaut : cert-manager

Espace de noms de cert-manager.

Consultez la page Exécuter cert-manager dans un espace de noms personnalisé.

connectAgent

Apigee Connect permet au plan de gestion d'Apigee hybrid de se connecter en toute sécurité au service MART dans le plan d'exécution sans avoir à exposer le point de terminaison MART sur Internet.

Le tableau suivant décrit les propriétés de l'objet connectAgent :

Propriété Type Description
connectAgent.annotations Avancé Introduit dans la version : 1.5.0

Valeur par défaut : aucune

Mappage clé/valeur facultatif utilisé pour annoter les pods. Pour en savoir plus, consultez la section Annotations personnalisées.

connectAgent.gsa Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service IAM Google (GSA) pour que connectAgent soit associé au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm. Définissez ce paramètre lorsque vous avez défini gcp.workloadIdentity.enabled sur true.

Les adresses e-mail GSA ont généralement le format suivant :

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemple :

apigee-mart@my-hybrid-project.iam.gserviceaccount.com

Consultez la section Activer Workload Identity sur GKE ou Activer la fédération d'identité de charge de travail sur AKS et EKS.

connectAgent.logLevel Avancé Introduit dans la version : 1.2.0

Valeur par défaut : INFO

Niveau de création de rapports de journaux. Vous pouvez utiliser les valeurs suivantes :

  • INFO : messages d'information en plus des messages d'avertissement, d'erreur et d'erreur fatale. Particulièrement utile pour le débogage.
  • WARNING : avertissements non fatals en plus des messages d'erreur et d'erreur fatale.
  • ERROR : erreurs internes et erreurs non renvoyées à l'utilisateur en plus des messages d'erreur fatale.
  • FATAL : erreurs irrécupérables et événements qui provoquent le plantage d'Apigee Connect.
connectAgent.image.pullPolicy Avancé Introduit dans la version : 1.2.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

connectAgent.image.tag Avancé Introduit dans la version : 1.2.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

connectAgent.image.url Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

connectAgent.replicaCountMax De base Introduit dans la version : 1.2.0

Valeur par défaut : 5

Nombre maximal d'instances dupliquées disponibles pour l'autoscaling.

connectAgent.replicaCountMin De base Introduit dans la version : 1.2.0

Valeur par défaut : 1

Nombre minimal d'instances dupliquées disponibles pour l'autoscaling.

En production, vous pouvez décider de définir la valeur replicaCountMin sur 1 afin d'obtenir un plus grand nombre de connexions dans le plan de contrôle à des fins de fiabilité et d'évolutivité.

connectAgent.resources.limits.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 512m

Limite de processeur pour la ressource dans un conteneur Kubernetes, en millicores.

connectAgent.resources.limits.memory Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 512Mi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

connectAgent.resources.requests.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 100m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

connectAgent.resources.requests.memory Avancé Introduit dans la version : 1.2.0

Valeur par défaut : 30Mi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets.

connectAgent.server Avancé Introduit dans la version : 1.2.0

Valeur par défaut : apigeeconnect.googleapis.com:443

Emplacement du serveur et port pour ce service.

connectAgent.serviceAccountPath De base Introduit dans la version : 1.1.1

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

Chemin d'accès au fichier de clé de compte de service Google pour le compte de service apigee-mart.

Dans la plupart des installations, la valeur de connectAgent.serviceAccountPath doit correspondre à la valeur de mart.serviceAccountPath.

connectAgent.serviceAccountRef De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

Dans la plupart des installations, la valeur de connectAgent.serviceAccountRef doit correspondre à la valeur de mart.serviceAccountRef.

connectAgent.targetCPUUtilizationPercentage Avancé Introduit dans la version : 1.2.0

Valeur par défaut : 75

Utilisation du processeur cible pour l'agent Apigee Connect sur le pod. La valeur de ce champ permet à Apigee Connect de procéder à un autoscaling lorsque l'utilisation du processeur atteint cette valeur, jusqu'à replicaCountMax.

connectAgent.terminationGracePeriodSeconds Avancé Introduit dans la version : 1.2.0

Valeur par défaut : 600

Délai entre l'envoi d'une requête de suppression du pod et le moment où le pod est supprimé, en secondes. Pendant cette période, tous les hooks d'arrêt sont exécutés et tous les processus en cours doivent s'arrêter normalement.

connectAgent.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

connectAgent.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

connectAgent.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

connectAgent.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

connectAgent.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

defaults

Clés de chiffrement par défaut pour l'installation d'Apigee hybrid.

Le tableau suivant décrit les propriétés de l'objet defaults :

Propriété Type Description
defaults.org.kmsEncryptionKey De base Introduit dans la version : 1.0.0

Valeur par défaut : aWxvdmVhcGlzMTIzNDU2Nw==

Clé de chiffrement par défaut pour l'organisation dans le service de gestion des clés.

defaults.org.kvmEncryptionKey De base Introduit dans la version : 1.0.0

Valeur par défaut : aWxvdmVhcGlzMTIzNDU2Nw==

Clé de chiffrement par défaut pour l'organisation dans KVM.

defaults.env.kmsEncryptionKey De base Introduit dans la version : 1.0.0

Valeur par défaut : aWxvdmVhcGlzMTIzNDU2Nw==

Clé de chiffrement par défaut pour l'environnement (env) dans le service de gestion des clés.

defaults.env.kvmEncryptionKey De base Introduit dans la version : 1.0.0

Valeur par défaut : aWxvdmVhcGlzMTIzNDU2Nw==

Clé de chiffrement par défaut pour l'environnement (env) dans KVM.

defaults.env.cacheEncryptionKey De base Introduit dans la version : 1.0.0

Valeur par défaut : aWxvdmVhcGlzMTIzNDU2Nw==

Clé de chiffrement du cache par défaut pour l'environnement (env).

diagnostic

Paramètres de l'outil collecteur de diagnostics.

Consultez la page Utiliser le collecteur de diagnostics.

Le tableau suivant décrit les propriétés de l'objet diagnostic :

Propriété Type Description
diagnostic.bucket De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Obligatoire

Nom du bucket de stockage Google Cloud dans lequel vos données de diagnostic seront consignées.

Consultez la page Créer des buckets de stockage.

diagnostic.container De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Obligatoire

Cela spécifie le type de pod à partir duquel vous capturez des données. Les valeurs peuvent être les suivantes :

  • "apigee-cassandra" capture les données concernant la base de données Cassandra. Les pods istio-cassandra s'exécutent dans l'espace de noms Apigee.
  • "apigee-mart-server" capture les données concernant MART. Les pods apigee-mart-server s'exécutent dans l'espace de noms Apigee.
  • "apigee-runtime" capture les données concernant le processeur de messages. Les pods apigee-runtime s'exécutent dans l'espace de noms Apigee.
  • "apigee-synchronizer" capture les données concernant le synchronisateur. Les pods apigee-synchronizer s'exécutent dans l'espace de noms Apigee.
  • "apigee-udca" capture les données concernant UDCA. Les pods apigee-udca s'exécutent dans l'espace de noms Apigee.
  • "apigee-watcher" capture les données concernant Watcher. Les pods apigee-watcher s'exécutent dans l'espace de noms Apigee.
  • "istio-proxy" capture les données sur la passerelle d'entrée Istio. Les pods istio-proxy s'exécutent dans l'espace de noms istio-system.
diagnostic.loggingDetails.logDuration De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Obligatoire si l'opération de collecte de diagnostics est "LOGGING" (définie avec operation: "LOGGING")

Durée en millisecondes des données de journalisation collectées. Une valeur type est 30000.

Consultez diagnostic.operation

diagnostic.loggingDetails.loggerNames[] De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Obligatoire si l'opération de collecte de diagnostics est "LOGGING" (définie avec operation: "LOGGING")

Spécifie le nom des enregistreurs à partir desquels collecter les données. Pour Apigee hybrid version 1.6.0, la seule valeur acceptée est ALL, ce qui signifie tous les enregistreurs. Exemple :

diagnostic:
 loggingDetails:
   loggerNames:
   - ALL
diagnostic.loggingDetails.logLevel De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Obligatoire si l'opération de collecte de diagnostics est "LOGGING" (définie avec operation: "LOGGING")

Indique la précision des données de journalisation à collecter. Dans Apigee hybrid 1.6, seule la valeur FINE est compatible.

diagnostic.namespace De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Obligatoire

Espace de noms Kubernetes dans lequel se trouvent les pods à partir desquels vous collectez les données. L'espace de noms doit être correct pour le conteneur que vous spécifiez avec diagnostic.container :

apigee pour

  • apigee-runtime
  • apigee-synchronizer
  • apigee-udca
  • apigee-watcher
  • apigee-cassandra
  • apigee-mart-server

istio-system pour

  • istio-proxy
diagnostic.operation De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Obligatoire

Permet de spécifier si vous souhaitez collecter toutes les statistiques ou seulement les journaux.

Les valeurs sont les suivantes :

diagnostic.podNames[] De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Obligatoire

Noms des pods Kubernetes pour lesquels vous collectez des données. Exemple :

diagnostic:
 podNames:
 - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
 - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
diagnostic.serviceAccountPath De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Obligatoire

Chemin d'accès à un fichier de clé de compte de service (.json) pour le compte de service doté du rôle "Administrateur de l'espace de stockage" (roles/storage.admin). Dans la plupart des installations Apigee hybrid, il s'agit du compte de service apigee-cassandra.

Consultez la section À propos des comptes de service.

diagnostic.tcpDumpDetails.maxMsgs De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

L'un des éléments suivants : diagnostic.tcpDumpDetails.maxMsgs oudiagnostic.tcpDumpDetails.timeoutInSeconds est obligatoire si vous utilisez diagnostic.tcpDumpDetails.

Définit le nombre maximal de messages tcpDump à collecter. Apigee recommande une valeur maximale ne dépassant pas 1000.

diagnostic.tcpDumpDetails.timeoutInSeconds De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

L'un des éléments suivants : diagnostic.tcpDumpDetails.maxMsgs oudiagnostic.tcpDumpDetails.timeoutInSeconds est obligatoire si vous utilisez diagnostic.tcpDumpDetails.

Définit le délai d'attente en secondes au terme duquel tcpDump renvoie des messages.

diagnostic.threadDumpDetails.delayInSeconds De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

diagnostic.threadDumpDetails.delayInSeconds et diagnostic.threadDumpDetails.iterations sont obligatoires si vous utilisez diagnostic.threadDumpDetails.

Délai en secondes entre la collecte de chaque vidage de thread.

diagnostic.threadDumpDetails.iterations De base Introduit dans la version : 1.6.0

Valeur par défaut : aucune

diagnostic.threadDumpDetails.delayInSeconds et diagnostic.threadDumpDetails.iterations sont obligatoires si vous utilisez diagnostic.threadDumpDetails.

Nombre d'itérations de vidage de thread jstack à collecter.

envs

Définit un éventail d'environnements dans lesquels vous pouvez déployer vos proxys d'API. Chaque environnement fournit un contexte isolé ou un bac à sable pour l'exécution de proxys d'API.

Votre organisation compatible hybride doit disposer d'au moins un environnement.

Pour plus d'informations, consultez la page À propos des environnements.

Le tableau suivant décrit les propriétés de l'objet envs :

Propriété Type Description
envs[].cacheEncryptionKey De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : cacheEncryptionKey, cacheEncryptionPath ou cacheEncryptionSecret.

Clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

envs[].cacheEncryptionPath De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : cacheEncryptionKey, cacheEncryptionPath ou cacheEncryptionSecret.

Chemin d'accès à un fichier contenant une clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

envs[].cacheEncryptionSecret.key De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : cacheEncryptionKey, cacheEncryptionPath ou cacheEncryptionSecret.

Clé d'un secret Kubernetes contenant une clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

envs[].cacheEncryptionSecret.name De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : cacheEncryptionKey, cacheEncryptionPath ou cacheEncryptionSecret.

Nom d'un secret Kubernetes contenant une clé de chiffrement encodée en base64. Consultez la page Chiffrement des données.

envs[].components.runtime.replicaCountMax De base Introduit dans la version : 1.9.3

Valeur par défaut : 4

Nombre maximal d'instances dupliquées pour l'autoscaling. Si elle est spécifiée, remplace la propriété runtime.replicaCountMax.

envs[].components.runtime.replicaCountMin De base Introduit dans la version : 1.9.3

Valeur par défaut : 1

Nombre minimal d'instances dupliquées pour l'autoscaling. Si elle est spécifiée, remplace la propriété runtime.replicaCountMin.

envs[].components.synchronizer.replicaCountMax De base Introduit dans la version : 1.9.3

Valeur par défaut : 4

Nombre maximal d'instances dupliquées pour l'autoscaling. Si elle est spécifiée, remplace la propriété synchronizer.replicaCountMax.

envs[].components.synchronizer.replicaCountMin De base Introduit dans la version : 1.9.3

Valeur par défaut : 1

Nombre minimal d'instances dupliquées pour l'autoscaling. Si elle est spécifiée, remplace la propriété synchronizer.replicaCountMin.

envs[].components.udca.replicaCountMax De base Introduit dans la version : 1.9.3

Valeur par défaut : 4

Nombre maximal d'instances dupliquées pour l'autoscaling. Si elle est spécifiée, remplace la propriété udca.replicaCountMax.

envs[].components.udca.replicaCountMin De base Introduit dans la version : 1.9.3

Valeur par défaut : 1

Nombre minimal d'instances dupliquées pour l'autoscaling. Si elle est spécifiée, remplace la propriété udca.replicaCountMin.

envs.gsa.runtime Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service Google IAM d'exécution à associer au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm.

Consultez la section Activer Workload Identity sur GKE ou Activer la fédération d'identité de charge de travail sur AKS et EKS.

envs.gsa.synchronizer Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service Google IAM de synchronisation à associer au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm.

Consultez la section Activer Workload Identity sur GKE ou Activer la fédération d'identité de charge de travail sur AKS et EKS.

envs.gsa.udca Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service udca Google IAM pour l'udca à l'échelle de l'environnement à associer au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm.

Consultez la section Activer Workload Identity sur GKE ou Activer la fédération d'identité de charge de travail sur AKS et EKS.

envs[].hostAliases[] De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Deprecated : à compter de la version hybride 1.4, le plan d'exécution reçoit cette information du plan de gestion. Consultez la page À propos des environnements et des groupes d'environnement.

envs[].httpProxy.host De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Indique le nom d'hôte ou l'adresse IP sur lequel le proxy HTTP est exécuté.

Répertoriez les propriétés httpProxy dans l'ordre scheme, host, port. Exemple :

envs:
  - name: test
    httpProxy:
      scheme: HTTP
      host: 10.12.0.47
      port: 3128
      ...

Voir aussi : Configurer le proxy de transfert pour les proxys d'API.

envs[].httpProxy.port De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Indique le port sur lequel le proxy HTTP est exécuté. Si cette propriété est omise, elle utilise par défaut le port 80 pour HTTP et le port 443 pour HTTPS.

envs[].httpProxy.scheme De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Indique le type de proxy HTTP en tant que HTTP ou HTTPS. Par défaut, "HTTP" est utilisé.

envs[].httpProxy.username De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Si le proxy HTTP nécessite une authentification de base, utilisez cette propriété pour fournir un nom d'utilisateur.

envs[].httpProxy.password De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Si le proxy HTTP nécessite une authentification de base, utilisez cette propriété pour fournir un mot de passe.

envs[].name De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Nom de l'environnement Apigee à synchroniser.

envs[].pollInterval Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Intervalle utilisé pour interroger les changements d'organisation et de synchronisation de l'environnement, en secondes.

envs[].port Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Numéro de port TCP pour le trafic HTTPS.

envs[].serviceAccountPaths.runtime De base Introduit dans la version : 1.4.0

Valeur par défaut : aucune

Sur le système local, chemin d'accès à une clé de compte de service Google possédant le rôle Agent Cloud Trace, généralement le compte de service apigee-runtime. Consultez la section À propos des comptes de service pour connaître les noms par défaut des comptes de service et les rôles qui leur sont attribués.

envs[].serviceAccountPaths.synchronizer De base Introduit dans la version : 1.0

Valeur par défaut : aucune

Chemin d'accès au fichier sur le système local vers une clé de compte de service Google avec le rôle Gestionnaire de synchronisateur Apigee.

envs[].serviceAccountPaths.udca De base Introduit dans la version : 1.0

Valeur par défaut : aucune

Chemin d'accès au fichier sur le système local vers une clé de compte de service Google avec le rôle Agent analytique Apigee.

Ne définissez cette propriété que si orgScopedUDCA est défini sur false.

envs[].serviceAccountSecretProviderClass Avancé Introduit dans la version : 1.12.0

Valeur par défaut : aucune

Nom de la classe du fournisseur de secrets spécifique à l'environnement (SecretProviderClass) utilisée pour stocker les clés de compte de service dans Vault.

Consultez la section Stocker des clés de compte de service dans Hashicorp Vault.

envs[].serviceAccountSecretRefs.runtime De base Introduit dans la version : 1.4.0

Valeur par défaut : aucune

Nom d'un secret Kubernetes. Vous devez créer le secret en utilisant une clé de compte de service Google dotée du rôle Agent Cloud Trace comme entrée.

envs[].serviceAccountSecretRefs.synchronizer De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Nom d'un secret Kubernetes. Vous devez créer le secret en utilisant une clé de compte de service Google dotée du rôle Gestionnaire de synchronisateur Apigee comme entrée.

envs[].serviceAccountSecretRefs.udca De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Nom d'un secret Kubernetes. Vous devez créer le secret en utilisant une clé de compte de service Google dotée du rôle Agent d'analyses Apigee comme entrée.

Ne définissez cette propriété que si orgScopedUDCA est défini sur false.

envs[].sslCertPath De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Soit sslCertPath/sslKeyPath, soit sslSecret est requis.

Chemin d'accès de votre système à un fichier de certificat TLS.

envs[].sslKeyPath De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Soit sslCertPath/sslKeyPath, soit sslSecret est requis.

Chemin d'accès de votre système au fichier de clé privée TLS.

envs[].sslSecret De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Soit sslCertPath/sslKeyPath, soit sslSecret est requis.

Nom d'un fichier stocké dans un secret Kubernetes contenant le certificat TLS et la clé privée. Vous devez créer le secret en utilisant le certificat TLS et des données de clé comme entrée.

Voir également :

gcp

Identifie l'ID du projet Google Cloud et la région dans laquelle apigee-logger et apigee-metrics transfèrent leurs données.

Le tableau suivant décrit les propriétés de l'objet gcp :

Propriété Type Description
gcp.federatedWorkloadIdentity.audience De base Introduit dans la version : 1.12.0

Valeur par défaut : aucune

Audience autorisée du fournisseur d'identité de charge de travail sur les plates-formes non-GKE.

Consultez la section Activer la fédération d'identité de charge de travail sur AKS et EKS.

gcp.federatedWorkloadIdentity.credentialSourceFile De base Introduit dans la version : 1.12.0

Valeur par défaut : aucune

Nom de fichier et chemin d'accès au fichier source d'identifiants utilisé par la fédération d'identité de charge de travail pour obtenir les identifiants des comptes de service. Il s'agit de la valeur que vous fournissez pour credential-source-file lorsque vous configurez la fédération d'identité de charge de travail avec la commande create-cred-config.

Consultez la section Activer la fédération d'identité de charge de travail sur AKS et EKS.

gcp.federatedWorkloadIdentity.enabled De base Introduit dans la version : 1.12.0

Valeur par défaut : false

Active la fédération d'identité de charge de travail sur les plates-formes non-GKE. Ne doit pas être défini sur true si gcp.workloadIdentity.enabled est défini sur true dans le même cluster.

Consultez la section Activer la fédération d'identité de charge de travail sur AKS et EKS.

gcp.projectID De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Obligatoire

Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics transfèrent leurs données.

gcp.projectIDRuntime De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Identifie le projet de cluster Kubernetes d'exécution.

La propriété projectIDRuntime est facultative. Si elle n'est pas utilisée, nous supposons que la valeur projectID est utilisée pour le projet Google Cloud de l'organisation Apigee et pour le projet du cluster K8S d'exécution.

gcp.region De base Introduit dans la version : 1.2.0

Valeur par défaut : us-central1

Obligatoire

Identifie la région Google Cloud dans laquelle apigee-logger et apigee-metrics transfèrent leurs données.

gcp.workloadIdentity.enabled De base Introduit dans la version : 1.10.0

Valeur par défaut : false

Helm uniquement : permet d'utiliser Workload Identity sur GKE. Workload Identity permet aux charges de travail de vos clusters GKE d'emprunter l'identité des comptes de service Identity and Access Management (IAM) pour accéder aux services Google Cloud.

Ne doit pas être défini sur true si gcp.federatedWorkloadIdentity.enabled est défini sur true dans le même cluster.

Lorsque enabled est défini sur false, par défaut, Apigee utilise les comptes de service IAM pour chaque composant Apigee hybrid. Consultez la section À propos des comptes de service.

Lorsque workloadIdentityEnabled a la valeur true, Apigee utilise des comptes de service Kubernetes et les mappe aux comptes de service IAM appropriés pour chaque composant. Spécifiez les comptes de service IAM à mapper aux comptes de service Kubernetes avec :

gcp.workloadIdentity.gsa Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service Google IAM (GSA) pour tous les composants à associer au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm. Définissez ce paramètre lorsque vous avez défini gcp.workloadIdentity.enabled sur true.

gcp.workloadIdentity.gsa s'applique à tous les composants hybrides. Si vous spécifiez une valeur pour gcp.workloadIdentity.gsa, vous n'avez pas besoin de fournir un GSA pour les composants hybrides individuels. Si vous fournissez un GSA pour un composant individuel, le GSA de ce composant remplace gcp.workloadIdentity.gsa pour ce composant uniquement.

Les adresses e-mail GSA ont généralement le format suivant :

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemple :

apigee-non-prod@my-hybrid-project.iam.gserviceaccount.com

Consultez Enabling Workload Identity on GKE.

gcp.workloadIdentityEnabled De base Introduit dans la version : 1.4.0

Valeur par défaut : false

apigeectl uniquement : active l'utilisation de Workload Identity. Workload Identity permet aux charges de travail de vos clusters GKE d'emprunter l'identité des comptes de service Identity and Access Management (IAM) pour accéder aux services Google Cloud.

Lorsque workloadIdentityEnabled est défini sur false, par défaut, Apigee utilise les comptes de service IAM pour chaque composant Apigee hybrid. Consultez la section À propos des comptes de service.

Lorsque workloadIdentityEnabled a la valeur true, Apigee utilise des comptes de service Kubernetes au lieu des comptes de service IAM et ignore les propriétés de configuration suivantes :

httpProxy

httpProxy fournit des paramètres de configuration pour un serveur proxy de transfert HTTP. Lorsqu'il est configuré dans le fichier overrides.yaml, toutes les communications Internet pour les composants Logger, MART, Métriques, Synchronisateur et UDCA passent par le serveur proxy.

Voir aussi : Logger, MART, Métriques, Synchronisateur et UDCA.

Le tableau suivant décrit les propriétés de l'objet httpProxy :

Propriété Type Description
httpProxy.host De base Introduit dans la version : 1.1.1

Valeur par défaut : aucune

Nom d'hôte du proxy HTTP.

httpProxy.port De base Introduit dans la version : 1.1.1

Valeur par défaut : aucune

Port du proxy HTTP.

httpProxy.scheme De base Introduit dans la version : 1.1.1

Valeur par défaut : HTTPS

Schéma utilisé par le proxy. Les valeurs peuvent être HTTP ou HTTPS. Les valeurs ne doivent contenir que des majuscules.

httpProxy.username De base Introduit dans la version : 1.1.1

Valeur par défaut : aucune

Si le proxy HTTP nécessite une authentification de base, utilisez cette propriété pour fournir un nom d'utilisateur.

httpProxy.password De base Introduit dans la version : 1.1.1

Valeur par défaut : aucune

Si le proxy HTTP nécessite une authentification de base, utilisez cette propriété pour fournir un mot de passe.

ingressGateways

Configure chaque instance individuelle de la passerelle d'entrée Apigee. Utilisez ces propriétés si vous souhaitez gérer des ressources individuelles séparément par ingressGateways[].name.

Consultez la page apigeeIngressGateway pour appliquer une configuration commune à toutes les instances de la passerelle d'entrée Apigee.

Appliquez les modifications aux propriétés ingressGateways à l'aide du graphique apigee-org.

Le tableau suivant décrit les propriétés de l'objet ingressGateways :

Propriété Type Description
ingressGateways[].name De base Introduit dans la version : 1.8.0

Valeur par défaut : aucune

Obligatoire

Nom de la passerelle d'entrée. D'autres services utiliseront ce nom pour adresser le trafic vers la passerelle. Le nom doit répondre aux exigences suivantes :

  • Ne pas comporter plus de 17 caractères ;
  • ne contenir que des caractères alphanumériques en minuscules et des caractères '-' ou '.' ;
  • commencer par un caractère alphanumérique ;
  • se terminer par un caractère alphanumérique.

Pour en savoir plus, consultez la section Noms des sous-domaines DNS dans la documentation de Kubernetes.

ingressGateways[].resources.limits.cpu Avancé Introduit dans la version : 1.8.0

Valeur par défaut : 2000m

Limite de processeur pour la ressource, en millcores.

ingressGateways[].resources.limits.memory Avancé Introduit dans la version : 1.8.0

Valeur par défaut : 1Gi

Limite de mémoire pour la ressource, en mébioctets.

ingressGateways[].resources.requests.cpu Avancé Introduit dans la version : 1.8.0

Valeur par défaut : 300m

Processeur requis pour le fonctionnement normal de la ressource, en millicores.

ingressGateways[].resources.requests.memory Avancé Introduit dans la version : 1.8.0

Valeur par défaut : 128Mi

Mémoire requise pour le fonctionnement normal de la ressource, en mébioctets.

ingressGateways[].replicaCountMax De base Introduit dans la version : 1.8.0

Valeur par défaut : 10

Nombre maximal de pods que l'installation hybride peut ajouter automatiquement pour la passerelle d'entrée disponible pour l'autoscaling.

ingressGateways[].replicaCountMin De base Introduit dans la version : 1.8.0

Valeur par défaut : 2

Nombre minimal de pods pour la passerelle d'entrée disponible pour l'autoscaling.

ingressGateways[].svcAnnotations De base Introduit dans la version : 1.8.0

Valeur par défaut : aucune

Mappage clé-valeur facultatif utilisé pour annoter la passerelle d'entrée sur les plates-formes compatibles avec les annotations. Exemple :

ingressGateways:
  svcAnnotations:
    networking.gke.io/load-balancer-type: "Internal"
ingressGateways[].svcLoadBalancerIP De base Introduit dans la version : 1.8.0

Valeur par défaut : aucune

Sur les plates-formes compatibles avec la spécification de l'adresse IP de l'équilibreur de charge, celui-ci est créé avec cette adresse IP. Sur les plates-formes qui ne permettent pas de spécifier l'adresse IP de l'équilibreur de charge, cette propriété est ignorée.

ingressGateways[].svcType De base Introduit dans la version : 1.8.1

Valeur par défaut : LoadBalancer

Permet de modifier le type du service k8s par défaut pour le déploiement d'entrée. Définissez la valeur sur ClusterIP si vous souhaitez désactiver la création de l'équilibreur de charge par défaut. Valeurs possibles :

  • ClusterIP
  • LoadBalancer
ingressGateways[].targetCPUUtilizationPercentage Avancé Introduit dans la version : 1.10.5, 1.11.2, 1.12.1

Valeur par défaut : 75

Seuil d'utilisation du processeur pour le scaling du nombre de pods dans ReplicaSet, sous forme de pourcentage du total des ressources processeur disponibles.

Lorsque l'utilisation du processeur dépasse cette valeur, hybrid augmente progressivement le nombre de pods, jusqu'à ingressGateways[].replicaCountMax.

Pour plus d'informations sur le scaling dans Kubernetes, consultez la section Autoscaling horizontal des pods dans la documentation de Kubernetes.

ingressGateways[].tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

ingressGateways[].tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

ingressGateways[].tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

ingressGateways[].tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

ingressGateways[].tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

istiod

Configure l'entrée Apigee.

Le tableau suivant décrit les propriétés de l'objet istiod :

Propriété Type Description
istiod.accessLogFile Avancé Introduit dans la version : 1.8.0

Valeur par défaut : /dev/stdout

Adresse du fichier pour le journal d'accès à l'entrée, par exemple /dev/stdout.

Si vous ne définissez pas cette valeur, la journalisation des accès est désactivée.

istiod.accessLogFormat Avancé Introduit dans la version : 1.8.0

Format du journal d'accès à l'entrée.

Si vous ne définissez pas cette valeur, le format utilisé est le format de journal d'accès par défaut du proxy.

Format de journal d'accès par défaut :

'{"start_time":"%START_TIME%","remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%","user_agent":"%REQ(USER-AGENT)%","host":"%REQ(:AUTHORITY)%","request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%","request_time":"%DURATION%","status":"%RESPONSE_CODE%","status_details":"%RESPONSE_CODE_DETAILS%","bytes_received":"%BYTES_RECEIVED%","bytes_sent":"%BYTES_SENT%","upstream_address":"%UPSTREAM_HOST%","upstream_response_flags":"%RESPONSE_FLAGS%","upstream_response_time":"%RESPONSE_DURATION%","upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%","upstream_cluster":"%UPSTREAM_CLUSTER%","x_forwarded_for":"%REQ(X-FORWARDED-FOR)%","request_method":"%REQ(:METHOD)%","request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%","request_protocol":"%PROTOCOL%","tls_protocol":"%DOWNSTREAM_TLS_VERSION%","request_id":"%REQ(X-REQUEST-ID)%","sni_host":"%REQUESTED_SERVER_NAME%","apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}'

Voici une copie du format de journal d'accès par défaut, dans lequel des sauts de ligne ont été ajoutés pour plus de lisibilité.

'{"start_time":"%START_TIME%",
  "remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%",
  "user_agent":"%REQ(USER-AGENT)%",
  "host":"%REQ(:AUTHORITY)%",
  "request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%",
  "request_time":"%DURATION%",
  "status":"%RESPONSE_CODE%",
  "status_details":"%RESPONSE_CODE_DETAILS%",
  "bytes_received":"%BYTES_RECEIVED%",
  "bytes_sent":"%BYTES_SENT%",
  "upstream_address":"%UPSTREAM_HOST%",
  "upstream_response_flags":"%RESPONSE_FLAGS%",
  "upstream_response_time":"%RESPONSE_DURATION%",
  "upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%",
  "upstream_cluster":"%UPSTREAM_CLUSTER%",
  "x_forwarded_for":"%REQ(X-FORWARDED-FOR)%",
  "request_method":"%REQ(:METHOD)%",
  "request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%",
  "request_protocol":"%PROTOCOL%",
  "tls_protocol":"%DOWNSTREAM_TLS_VERSION%",
  "request_id":"%REQ(X-REQUEST-ID)%",
  "sni_host":"%REQUESTED_SERVER_NAME%",
  "apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}'
istiod.forwardClientCertDetails Avancé Introduit dans la version : 1.9.2

Valeur par défaut : SANITIZE_SET

Détermine comment le proxy Envoy (pour la passerelle d'entrée Apigee) gère l'en-tête HTTP x-forwarded-client-cert (XFCC).

Les valeurs possibles sont les suivantes :

  • SANITIZE_SET (valeur par défaut) Lorsque la connexion client est définie sur mTLS, réinitialisez l'en-tête XFCC avec les informations du certificat client et envoyez-le au prochain saut.
  • FORWARD_ONLY Lorsque la connexion client est définie sur mTLS (authentification TLS mutuelle), transférez l'en-tête XFCC dans la requête uniquement.
  • APPEND_FORWARD Lorsque la connexion client est définie sur mTLS, ajoutez les informations de certificat client à l'en-tête XFCC de la requête et transférez-les.
  • SANITIZE Ne transférez pas l'en-tête XFCC.
  • ALWAYS_FORWARD_ONLY Transférez toujours l'en-tête XFCC dans la requête, que la connexion client soit ou non définie sur mTLS.

Pour en savoir plus sur ces valeurs, consultez la documentation Envoy pour Enum extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.ForwardClientCertDetails.

Si vous modifiez ce paramètre après avoir installé l'environnement hybride, appliquez-le avec apigeectl init, puis redémarrez vos pods de passerelle d'entrée Apigee.

istiod.healthCheckUserAgents Avancé Introduit dans la version : 1.12.0

Valeurs par défaut

- "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring)"
- "Edge Health Probe"

Permet aux équilibreurs de charge autres que Google Cloud de vérifier les points de terminaison de vérification d'état de la passerelle d'entrée (/healthz/ingress et /healthz) en remplaçant la liste d'autorisation des user-agents par défaut dans l'environnement hybride.

Pour remplacer les user-agents par défaut spécifiés, utilisez la syntaxe suivante, en insérant les user-agents personnalisés :

istiod:
  healthCheckUserAgents: 
  - "CUSTOM_USER_AGENT_1"
  - "CUSTOM_USER_AGENT_2"

Pour supprimer l'exigence user-agent, utilisez ce qui suit :

istiod:
  healthCheckUserAgents: []

istiod.image.pullPolicy Avancé Introduit dans la version : 1.8.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

istiod.image.tag Avancé Introduit dans la version : 1.8.0

Valeur par défaut : 1.18.7-asm.4-distroless

Libellé de la version pour l'image Docker de ce service.

istiod.image.url Avancé Introduit dans la version : 1.8.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

istiod.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

istiod.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

istiod.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

istiod.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

istiod.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

k8sCluster

Identifie le cluster Kubernetes dans lequel l'environnement d'exécution Apigee hybrid est installé.

Le tableau suivant décrit les propriétés de l'objet k8sCluster :

Propriété Type Description
k8sCluster.name De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Nom du cluster Kubernetes dans lequel l'environnement d'exécution Apigee hybrid est installé.

k8sCluster.region De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Identifie la région Google Cloud dans laquelle votre cluster Kubernetes a été créé.

kubeRBACProxy

Identifie l'emplacement dans lequel Apigee doit rechercher des contrôles d'accès basés sur les rôles Kubernetes.

Le tableau suivant décrit les propriétés de l'objet kubeRBACProxy :

Propriété Type Description
kubeRBACProxy.image.pullPolicy Avancé Introduit dans la version : 1.2.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

kubeRBACProxy.image.tag Avancé Introduit dans la version : 1.2.0

Valeur par défaut : v0.14.2

Libellé de la version pour l'image Docker de ce service.

kubeRBACProxy.image.url Avancé Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

kubeRBACProxy.resources.limits.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 500m

Limite de processeur pour la ressource dans un conteneur Kubernetes, en millicores.

kubeRBACProxy.resources.limits.memory Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 128Mi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

kubeRBACProxy.resources.requests.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 5m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

kubeRBACProxy.resources.requests.memory Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 64Mi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets.

logger

Définit le service qui gère les journaux opérationnels. Tous les services Apigee hybrid qui s'exécutent dans votre cluster Kubernetes génèrent ces informations.

Pour en savoir plus, consultez la page Présentation de Logging.

Le tableau suivant décrit les propriétés de l'objet logger :

Propriété Type Description
logger.annotations Avancé Introduit dans la version : 1.5.0

Valeur par défaut : aucune

Mappage clé/valeur facultatif utilisé pour annoter les pods. Pour en savoir plus, consultez la section Annotations personnalisées.

logger.bufferChunkSize Avancé Introduit dans la version : 1.12.0

Valeur par défaut: 256 000

Taille initiale de la mémoire tampon pour lire les fichiers journaux.

logger.bufferMaxSize Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 104857600

Limite de taille de la mémoire tampon par fichier surveillé. Les fichiers dépassant cette limite sont supprimés de la liste des fichiers surveillés.

logger.bufferMemoryLimit Avancé Introduit dans la version : 1.12.0

Valeur par défaut: 150 Mo

Limite de mémoire que l'enregistreur peut utiliser. S'il est atteint, l'enregistreur met temporairement en pause la lecture d'autres données jusqu'à ce que les données existantes soient vidées en mémoire.

logger.enabled De base Introduit dans la version : 1.0.0

Valeur par défaut : false

Active ou désactive la journalisation sur le cluster. Pour les clusters non GKE, défini sur true, pour les clusters GKE sur Google Cloud ou Google Distributed Cloud, défini sur false.

logger.envVars De base Introduit dans la version : 1.8.5

Valeur par défaut : aucune

Permet d'inclure la variable d'environnement Fluent Bit NO_PROXY, qui spécifie les URL pour lesquelles le trafic n'est pas acheminé via le proxy HTTP. La variable NO_PROXY doit être définie comme une chaîne de noms d'hôte séparés par une virgule, au format suivant :

logger:
  ...
  envVars:
    NO_PROXY: '<comma-separated-values>'

par exemple :

  envVars:
    NO_PROXY: 'kubernetes.default.svc,oauth2.googleapis.com,logging.googleapis.com'

Utilisez envVars: NO_PROXY si vous avez activé le proxy de transfert HTTP.

Consultez la section NO_PROXY dans la documentation Fluent Bit.

logger.flushInterval Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 1

Intervalle d'attente avant d'appeler le prochain vidage de mémoire tampon, en secondes.

logger.gsa Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service Google IAM apigee-logger (GSA) à associer au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm. Définissez ce paramètre lorsque vous avez défini gcp.workloadIdentity.enabled sur true.

Les adresses e-mail GSA ont généralement le format suivant :

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemple :

apigee-logger@my-hybrid-project.iam.gserviceaccount.com

Consultez la section Activer Workload Identity sur GKE ou Activer la fédération d'identité de charge de travail sur AKS et EKS.

logger.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

logger.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.9.9

Libellé de la version pour l'image Docker de ce service.

logger.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

logger.livenessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 3

Nombre de fois où Kubernetes va vérifier que les vérifications d'activité ont échoué avant de redémarrer le conteneur. La valeur minimale est 1.

logger.livenessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 0

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'activité.

logger.livenessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 60

Détermine la fréquence à laquelle effectuer une vérification d'activité, en secondes. La valeur minimale est 1.

logger.livenessProbe.successThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre minimal de succès consécutifs requis pour qu'une vérification d'activité soit considérée comme réussie après un échec. La valeur minimale est 1.

logger.livenessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

logger.nodeSelector.key De base Introduit dans la version : 1.0.0

Valeur par défaut : apigee.com/apigee-logger-enabled

Obligatoire

Clé d'étiquette de sélecteur de nœud utilisée pour cibler des nœuds Kubernetes dédiés pour les services d'exécution logger.

Consultez la page Configurer des pools de nœuds dédiés.

logger.nodeSelector.value De base Introduit dans la version : 1.0.0

Valeur par défaut : true

Obligatoire

Valeur de libellé de sélecteur de nœud utilisée pour cibler des nœuds Kubernetes dédiés pour les services d'exécution logger.

Consultez la page Configurer des pools de nœuds dédiés.

logger.resources.limits.cpu Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 200m

Limite de processeur pour la ressource dans un conteneur Kubernetes, en millicores.

logger.resources.limits.memory Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 500Mi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

logger.resources.requests.cpu Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 100m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

logger.resources.requests.memory Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 250Mi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets.

logger.serviceAccountPath De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

Chemin d'accès au fichier de clé de compte de service Google doté du rôle Rédacteur de journaux.

logger.serviceAccountRef De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

logger.storageMaxChunks Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 128

Nombre maximal de fragments en mémoire. Les fragments dépassant la limite seront enregistrés dans le système de fichiers.

logger.terminationGracePeriodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 30

Délai entre l'envoi d'une requête de suppression du pod et le moment où le pod est supprimé, en secondes. Pendant cette période, tous les hooks d'arrêt sont exécutés et tous les processus en cours doivent s'arrêter normalement.

logger.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

logger.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

logger.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

logger.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

logger.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mart

Définit le service MART (API Management pour les données d'exécution), qui agit en tant que fournisseur d'API pour les API Apigee publiques afin que vous puissiez accéder et gérer les entités de données d'exécution telles que le service de gestion des clés (clés API et jetons OAuth), KVM, les Quotas et les produits d'API.

Le tableau suivant décrit les propriétés de l'objet mart :

Propriété Type Description
mart.annotations Avancé Introduit dans la version : 1.5.0

Valeur par défaut : aucune

Mappage clé/valeur facultatif utilisé pour annoter les pods. Pour en savoir plus, consultez la section Annotations personnalisées.

mart.gsa Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service Google IAM apigee-mart (GSA) à associer au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm. Définissez ce paramètre lorsque vous avez défini gcp.workloadIdentity.enabled sur true.

Les adresses e-mail GSA ont généralement le format suivant :

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemple :

apigee-mart@my-hybrid-project.iam.gserviceaccount.com

Consultez la section Activer Workload Identity sur GKE ou Activer la fédération d'identité de charge de travail sur AKS et EKS.

mart.hostAlias De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Alias d'hôte pointant vers l'objet MART. Vous pouvez définir cette propriété sur * ou un nom de domaine complet.

mart.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

mart.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

mart.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

mart.initCheckCF.resources.requests.cpu Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 10m

Quantité de ressources de processeur allouées à la vérification d'initialisation du processus Cloud Foundry.

mart.livenessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 12

Nombre de fois où Kubernetes va vérifier que les vérifications d'activité ont échoué avant de redémarrer le conteneur. La valeur minimale est 1.

mart.livenessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 15

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'activité.

mart.livenessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Détermine la fréquence à laquelle effectuer une vérification d'activité, en secondes. La valeur minimale est 1.

mart.livenessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

mart.metricsURL De base Introduit dans la version : 1.0.0

Valeur par défaut : /v1/server/metrics

mart.nodeSelector.key De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Clé d'étiquette de sélecteur de nœud facultative pour le ciblage des nœuds Kubernetes pour les services d'exécution mart. Si vous ne spécifiez pas de clé pour mart.nodeselector, votre environnement d'exécution utilise le nœud spécifié dans l'objet nodeSelector.

Consultez la page Configurer des pools de nœuds dédiés.

mart.nodeSelector.value De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Valeur de libellé de sélecteur de nœud facultative pour le ciblage des nœuds Kubernetes pour les services d'exécution mart. Voir également l'objet nodeSelector.

Consultez la page Configurer des pools de nœuds dédiés.

mart.readinessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 2

Nombre de fois où Kubernetes vérifie que les vérifications d'aptitude ont échoué avant de marquer le pod comme non prêt. La valeur minimale est 1.

mart.readinessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 15

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'aptitude.

mart.readinessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Détermine la fréquence à laquelle effectuer une vérification d'aptitude, en secondes. La valeur minimale est 1.

mart.readinessProbe.successThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre minimal de succès consécutifs requis pour qu'une vérification d'aptitude soit considérée comme réussie après un échec. La valeur minimale est 1.

mart.readinessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

mart.replicaCountMax De base Introduit dans la version : 1.0.0

Valeur par défaut : 5

Nombre maximal d'instances dupliquées disponibles pour l'autoscaling.

mart.replicaCountMin De base Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre minimal d'instances dupliquées disponibles pour l'autoscaling.

mart.resources.limits.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 2000m

Limite de processeur pour la ressource dans un conteneur Kubernetes, en millicores.

mart.resources.limits.memory Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 5Gi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

mart.resources.requests.cpu Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

mart.resources.requests.memory Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 512Mi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets.

mart.serviceAccountPath De base Introduit dans la version : 1.1.1

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

Chemin d'accès au fichier de clé de compte de service Google sans aucun rôle.

mart.serviceAccountRef De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

mart.sslCertPath De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Soit sslCertPath/sslKeyPath, soit sslSecret est requis.

Chemin d'accès au système de fichiers local pour charger et encoder le certificat SSL dans un fichier Secret.

mart.sslKeyPath De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Soit sslCertPath/sslKeyPath, soit sslSecret est requis.

Chemin d'accès au système de fichiers local pour charger et encoder la clé SSL dans un fichier Secret.

mart.sslSecret De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Soit sslCertPath/sslKeyPath, soit sslSecret est requis.

Nom d'un fichier stocké dans un secret Kubernetes contenant le certificat TLS et la clé privée. Vous devez créer le secret en utilisant le certificat TLS et des données de clé comme entrée.

Voir également :

mart.targetCPUUtilizationPercentage Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 75

Utilisation du processeur cible pour le processus MART sur le pod. La valeur de ce champ permet à MART de procéder à un autoscaling lorsque l'utilisation du processeur atteint cette valeur, jusqu'à replicaCountMax.

mart.terminationGracePeriodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 30

Délai entre l'envoi d'une requête de suppression du pod et le moment où le pod est supprimé, en secondes. Pendant cette période, tous les hooks d'arrêt sont exécutés et tous les processus en cours doivent s'arrêter normalement.

mart.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mart.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mart.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mart.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mart.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

metrics

Définit le service qui collecte les métriques d'opérations. Vous pouvez utiliser ces données pour surveiller l'état des services hybrides, configurer des alertes, etc.

Pour en savoir plus, consultez la section Présentation de la collecte de métriques.

Le tableau suivant décrit les propriétés de l'objet metrics :

Propriété Type Description
metrics.adapter.image.pullPolicy Avancé Introduit dans la version : 1.8.1

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

metrics.adapter.image.tag Avancé Introduit dans la version : 1.8.1

Valeur par défaut : v0.11.0

Libellé de la version pour l'image Docker de ce service.

metrics.adapter.image.url Avancé Introduit dans la version : 1.8.1

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

metrics.aggregator.resources.requests.cpu Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal de l'agrégateur dans un conteneur Kubernetes, en millicores.

metrics.aggregator.resources.requests.memory Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 512Mi

Mémoire requise pour le fonctionnement normal de l'agrégateur dans un conteneur Kubernetes, en mébioctets.

metrics.aggregator.resources.limits.cpu Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 500m

Limite de processeur pour l'agrégateur dans un conteneur Kubernetes, en millicores.

metrics.aggregator.resources.limits.memory Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 3Gi

La limite de mémoire de la ressource d'agrégateur dans un conteneur Kubernetes, en gibioctets.

metrics.annotations Avancé Introduit dans la version : 1.5.0

Valeur par défaut : aucune

Mappage clé/valeur facultatif utilisé pour annoter les pods. Pour en savoir plus, consultez la section Annotations personnalisées.

metrics.app.resources.requests.cpu Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal de l'application dans un conteneur Kubernetes, en millicores.

metrics.app.resources.requests.memory Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 512Mi

Mémoire requise pour le fonctionnement normal de l'application dans un conteneur Kubernetes, en mébioctets.

metrics.app.resources.limits.cpu Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 500m

Limite de processeur pour l'application dans un conteneur Kubernetes, en millicores.

metrics.app.resources.limits.memory Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 1Gi

La limite de mémoire pour la ressource d'application dans un conteneur Kubernetes, en gibioctets.

metrics.appStackdriverExporter.resources.requests.cpu Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 128m

Processeur requis pour le fonctionnement normal de stackdriverExporter dans un conteneur Kubernetes, en millicores.

metrics.appStackdriverExporter.resources.requests.memory Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 512Mi

Mémoire requise pour le fonctionnement normal de stackdriverExporter dans un conteneur Kubernetes, en mébioctets.

metrics.appStackdriverExporter.resources.limits.cpu Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 500m

Limite de processeur pour stackdriverExporter dans un conteneur Kubernetes, en millicores.

metrics.appStackdriverExporter.resources.limits.memory Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 1Gi

La limite de mémoire pour la ressource stackdriverExporter dans un conteneur Kubernetes, en gibioctets.

metrics.collector.envVars De base Introduit dans la version : 1.13

Valeur par défaut : aucune

Permet de transmettre et de remplacer des variables d'environnement dans OpenTelemetry. Par exemple, vous pouvez définir HTTP_PROXY, HTTPS_PROXY ou NO_PROXY pour que ses requêtes passent par le serveur proxy.

La variable HTTP_PROXY peut être définie comme une chaîne contenant le nom d'hôte, au format suivant :

metrics:
...
  EnvVars:
    HTTP_PROXY: '<host-name>'

par exemple :

  EnvVars:
    HTTP_PROXY: 'http://1.1.1.1:80'

La variable HTTPS_PROXY peut être définie comme une chaîne contenant le nom d'hôte, au format suivant :

metrics:
...
  EnvVars:
    HTTPS_PROXY: '<host-name>'

par exemple :

  EnvVars:
    HTTPS_PROXY: 'https://1.1.1.1:80'

La variable NO_PROXY doit être définie comme une chaîne de noms d'hôte séparés par une virgule, au format suivant :

metrics:
...
envVars:
  NO_PROXY: '<comma-separated-values>'

par exemple :

envVars:
  NO_PROXY: 'https://1.1.1.1:80, https://1.1.1.1:81'

Utilisez envVars: HTTP_PROXY, envVars: HTTPS_PROXY ou envVars: NO_PROXY si vous avez activé le proxy de transfert HTTP.

Consultez la section Assistance de proxy dans la documentation OpenTelemetry.

metrics.collector.imagePullPolicy Avancé Introduit dans la version : 1.12.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la page Utiliser un dépôt d'images privé avec Apigee hybrid .

metrics.collector.image.tag De base Introduit dans la version : 1.12.0

Valeur par défaut : v0.93.0

Libellé de la version pour l'image Docker de ce service.

metrics.collector.image.url De base Introduit dans la version : 1.12.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

metrics.collector.resources.requests.cpu Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal de l'application dans un conteneur Kubernetes, en millicores.

metrics.collector.resources.requests.memory Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 512Mi

Mémoire requise pour le fonctionnement normal de l'application dans un conteneur Kubernetes, en mébioctets.

metrics.collector.resources.limits.cpu Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 500m

Limite de processeur pour l'application dans un conteneur Kubernetes, en millicores.

metrics.collector.resources.limits.memory Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 1Gi

La limite de mémoire pour la ressource d'application dans un conteneur Kubernetes, en gibioctets.

metrics.collector.livenessProbe.failureThreshold Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 5

Nombre de fois où Kubernetes va vérifier que les vérifications d'activité ont échoué avant de redémarrer le conteneur. La valeur minimale est 1.

metrics.collector.livenessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 30

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'activité.

metrics.collector.livenessProbe.periodSeconds Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 10

Détermine la fréquence à laquelle effectuer une vérification d'activité, en secondes. La valeur minimale est 1.

metrics.collector.livenessProbe.successThreshold Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 1

Nombre minimal de succès consécutifs requis pour qu'une vérification d'activité soit considérée comme réussie après un échec. La valeur minimale est 1.

metrics.collector.livenessProbe.timeoutSeconds Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 5

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

metrics.collector.readinessProbe.failureThreshold Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 3

Nombre de fois où Kubernetes vérifie que les vérifications d'aptitude ont échoué avant de marquer le pod comme non prêt. La valeur minimale est 1.

metrics.collector.readinessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 30

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'aptitude.

metrics.collector.readinessProbe.periodSeconds Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 10

Détermine la fréquence à laquelle effectuer une vérification d'aptitude, en secondes. La valeur minimale est 1.

metrics.collector.readinessProbe.successThreshold Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 1

Nombre minimal de succès consécutifs requis pour qu'une vérification d'aptitude soit considérée comme réussie après un échec. La valeur minimale est 1.

metrics.collector.readinessProbe.timeoutSeconds Avancé Introduit dans la version : 1.12.0

Valeur par défaut : 5

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

metrics.disablePrometheusPipeline De base Introduit dans la version : 1.12.0

Valeur par défaut : true

Les métriques des ressources surveillées ProxyV2 et TargetV2 ne sont pas émises lorsqu'elles sont définies sur true. Utilisez plutôt les métriques pour les ressources surveillées Proxy et Target.

metrics.enabled De base Introduit dans la version : 1.0.0

Valeur par défaut : true

Active les métriques Apigee. Défini sur true pour activer les métriques. Défini sur false pour désactiver les métriques.

metrics.gsa Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service Google IAM apigee-metrics (GSA) à associer au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm. Définissez ce paramètre lorsque vous avez défini gcp.workloadIdentity.enabled sur true.

Les adresses e-mail GSA ont généralement le format suivant :

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemple :

apigee-metrics@my-hybrid-project.iam.gserviceaccount.com

Consultez la section Activer Workload Identity sur GKE ou Activer la fédération d'identité de charge de travail sur AKS et EKS.

metrics.nodeSelector.key De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Clé d'étiquette de sélecteur de nœud utilisée pour cibler des nœuds Kubernetes dédiés pour les services d'exécution metrics.

Consultez la page Configurer des pools de nœuds dédiés.

metrics.nodeSelector.value De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Valeur de libellé de sélecteur de nœud utilisée pour cibler des nœuds Kubernetes dédiés pour les services d'exécution metrics.

Consultez la page Configurer des pools de nœuds dédiés.

metrics.prometheus.containerPort Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 9090

Port permettant de se connecter au service de métriques Prometheus.

metrics.prometheus.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

metrics.prometheus.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : v2.45.0

Libellé de la version pour l'image Docker de ce service.

metrics.prometheus.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

metrics.prometheus.livenessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 6

Nombre de fois où Kubernetes va vérifier que les vérifications d'activité ont échoué avant de redémarrer le conteneur. La valeur minimale est 1.

metrics.prometheus.livenessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Détermine la fréquence à laquelle effectuer une vérification d'activité, en secondes. La valeur minimale est 1.

metrics.prometheus.livenessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 3

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

metrics.prometheus.readinessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 120

Nombre de fois où Kubernetes vérifie que les vérifications d'aptitude ont échoué avant de marquer le pod comme non prêt. La valeur minimale est 1.

metrics.prometheus.readinessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Détermine la fréquence à laquelle effectuer une vérification d'aptitude, en secondes. La valeur minimale est 1.

metrics.prometheus.readinessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 3

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

metrics.prometheus.sslCertPath De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Chemin d'accès au certificat SSL pour le processus de collecte de métriques Prometheus. Prometheus est un outil qu'Apigee peut utiliser pour collecter et traiter les métriques.

Consultez les pages suivantes :

metrics.prometheus.sslKeyPath De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Chemin d'accès à la clé SSL pour le processus de collecte de métriques Prometheus. Prometheus est un outil qu'Apigee peut utiliser pour collecter et traiter les métriques.

Consultez les pages suivantes :

metrics.proxy.resources.requests.cpu Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal du proxy dans un conteneur Kubernetes, en millicores.

metrics.proxy.resources.requests.memory Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 512Mi

Mémoire requise pour le fonctionnement normal du proxy dans un conteneur Kubernetes, en mébioctets.

metrics.proxy.resources.limits.cpu Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 500m

Limite de processeur pour le proxy dans un conteneur Kubernetes, en millicores.

metrics.proxy.resources.limits.memory Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 1Gi

La limite de mémoire de la ressource de proxy dans un conteneur Kubernetes, en gibioctets.

metrics.proxyStackdriverExporter.resources.requests.cpu Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 128m

Processeur requis pour le fonctionnement normal de stackdriverExporter dans un conteneur Kubernetes, en millicores.

metrics.proxyStackdriverExporter.resources.requests.memory Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 512Mi

Mémoire requise pour le fonctionnement normal de stackdriverExporter dans un conteneur Kubernetes, en mébioctets.

metrics.proxyStackdriverExporter.resources.limits.cpu Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 500m

Limite de processeur pour stackdriverExporter dans un conteneur Kubernetes, en millicores.

metrics.proxyStackdriverExporter.resources.limits.memory Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 1Gi

La limite de mémoire pour la ressource stackdriverExporter dans un conteneur Kubernetes, en gibioctets.

metrics.proxyURL De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

URL du proxy side-car de traitement des métriques dans le cluster Kubernetes.

metrics.sdSidecar.containerPort Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 9091

Port de connexion au service de métriques Cloud Monitoring.

metrics.sdSidecar.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand Kubelet extrait l'image Docker de ce service. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà
  • Always : extrait toujours la stratégie, même si elle existe déjà

    Pour en savoir plus, consultez la section Mettre à jour des images.

metrics.sdSidecar.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : v0.9.0

Libellé de la version pour l'image Docker de ce service.

metrics.sdSidecar.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

metrics.serviceAccountPath De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

Chemin d'accès au fichier de clé de compte de service Google doté du rôle Rédacteur de métriques de surveillance.

metrics.serviceAccountRef De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

metrics.stackdriverExporter.resources.requests.cpu Avancé Introduit dans la version : 1.4.0

Deprecated : à partir de la version 1.8 d'Apigee hybrid, metrics:stackdriverExporter a été remplacé par metrics:appStackdriverExporter et metrics:proxyStackdriverExporter. Consultez les pages suivantes :

metrics.stackdriverExporter.resources.requests.memory Avancé Introduit dans la version : 1.4.0

Deprecated : à partir de la version 1.8 d'Apigee hybrid, metrics:stackdriverExporter a été remplacé par metrics:appStackdriverExporter et metrics:proxyStackdriverExporter. Consultez les pages suivantes :

metrics.stackdriverExporter.resources.limits.cpu Avancé Introduit dans la version : 1.4.0

Deprecated : à partir de la version 1.8 d'Apigee hybrid, metrics:stackdriverExporter a été remplacé par metrics:appStackdriverExporter et metrics:proxyStackdriverExporter. Consultez les pages suivantes :

metrics.stackdriverExporter.resources.limits.memory Avancé Introduit dans la version : 1.4.0

Deprecated : à partir de la version 1.8 d'Apigee hybrid, metrics:stackdriverExporter a été remplacé par metrics:appStackdriverExporter et metrics:proxyStackdriverExporter. Consultez les pages suivantes :

metrics.terminationGracePeriodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 300

Délai entre l'envoi d'une requête de suppression du pod et le moment où le pod est supprimé, en secondes. Pendant cette période, tous les hooks d'arrêt sont exécutés et tous les processus en cours doivent s'arrêter normalement.

metrics.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

metrics.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

metrics.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

metrics.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

metrics.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mintTaskScheduler

mintTaskScheduler est le job Cron pour planifier des tâches de monétisation, telles que le calcul de frais récurrents de manière périodique.

Le tableau suivant décrit les propriétés de l'objet mintTaskScheduler :

Propriété Type Description
mintTaskScheduler.image.pullPolicy Avancé Introduit dans la version : 1.7.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

mintTaskScheduler.image.tag Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

mintTaskScheduler.image.url Avancé Introduit dans la version : 1.7.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

mintTaskScheduler.resources.limits.cpu Avancé Introduit dans la version : 1.1.0

Valeur par défaut : 2000m

Limite de processeur pour la ressource dans un conteneur Kubernetes, en millicores.

mintTaskScheduler.resources.limits.memory Avancé Introduit dans la version : 1.1.0

Valeur par défaut : 4Gi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

mintTaskScheduler.resources.requests.cpu Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

mintTaskScheduler.resources.requests.memory Avancé Introduit dans la version : 1.7.0

Valeur par défaut : 512Mi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets.

mintTaskScheduler.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mintTaskScheduler.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mintTaskScheduler.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mintTaskScheduler.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

mintTaskScheduler.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

nodeSelector

L'objet nodeSelector définit le nœud pour votre instance Apigee. En arrière-plan, Apigee hybrid se charge de mapper la clé-valeur de libellé pour apigeeRuntime et apigeeData aux composants Istio et MART individuels lorsque vous installez ou mettez à niveau les charts apigee-org et apigee-ingress-manager. Vous pouvez ignorer ce comportement pour des objets individuels grâce à la propriété mart:nodeSelector.

Le tableau suivant décrit les propriétés de l'objet nodeSelector :

Propriété Type Description
nodeSelector.apigeeData.key Avancé Introduit dans la version : 1.0.0

Valeur par défaut : cloud.google.com/gke-nodepool

ApigeeData est le nœud pour la base de données Cassandra. Clé d'étiquette du sélecteur de nœud pour cibler les nœuds Kubernetes, permettant d'utiliser les données des services Apigee.

Consultez la page Configurer des pools de nœuds dédiés.

nodeSelector.apigeeData.value Avancé Introduit dans la version : 1.0.0

Valeur par défaut : apigee-data

apigee-data est le nœud pour la base de données Cassandra. Valeur de libellé du sélecteur de nœud pour cibler les nœuds Kubernetes, permettant d'utiliser les données des services Apigee.

Consultez la page Configurer des pools de nœuds dédiés.

nodeSelector.apigeeRuntime.key Avancé Introduit dans la version : 1.0.0

Valeur par défaut : cloud.google.com/gke-nodepool

Apigee Runtime est le nœud pour l'environnement d'exécution du projet. Clé de libellé du sélecteur de nœud pour cibler les nœuds Kubernetes pour les services d'exécution Apigee.

Consultez la page Configurer des pools de nœuds dédiés.

nodeSelector.apigeeRuntime.value Avancé Introduit dans la version : 1.0.0

Valeur par défaut : apigee-runtime

apigee-runtime est le nœud pour l'environnement d'exécution du projet. Valeur de libellé du sélecteur de nœud pour cibler les nœuds Kubernetes pour les services d'exécution Apigee.

Consultez la page Configurer des pools de nœuds dédiés.

nodeSelector.requiredForScheduling Avancé Introduit dans la version : 1.0.0

Valeur par défaut : true

La propriété requiredForScheduling est définie par défaut sur true. Lorsque la valeur est true, cela signifie que si Kubernetes ne peut pas trouver de nœuds avec la clé-valeur de libellé configurée, les pods sous-jacents ne seront pas programmés sur les nœuds de calcul de la VM.

Pour la production, nodeSelector.requiredForScheduling doit être défini sur "true".

Consultez la page Configurer des pools de nœuds dédiés.

redis

Le tableau suivant décrit les propriétés de l'objet redis :

Propriété Type Description
redis.auth.password De base Introduit dans la version : 1.6.0

Valeur par défaut : iloveapis123

Obligatoire

Mot de passe de l'administrateur Redis. Le rôle d'administrateur est utilisé pour toutes les activités d'administration effectuées sur le cluster Redis.

redis.auth.secret De base Introduit dans la version : 1.9.1

Valeur par défaut : aucune

Nom du fichier stocké dans un secret Kubernetes et contenant le mot de passe de l'administrateur Redis. Le fichier secret doit contenir la clé :

data:
    redis.auth.password: encoded_value

Voir également :

redis.envoy.image.pullPolicy Avancé Introduit dans la version : 1.6.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

redis.envoy.image.tag Avancé Introduit dans la version : 1.6.0

Valeur par défaut : v1.27.0

Libellé de la version pour l'image Docker de ce service.

redis.envoy.image.url Avancé Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

redis.image.pullPolicy Avancé Introduit dans la version : 1.6.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

redis.image.tag Avancé Introduit dans la version : 1.6.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

redis.image.url Avancé Introduit dans la version : 1.6.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

redis.replicaCount De base Introduit dans la version : 1.6.0

Valeur par défaut : 2

Redis est un espace de stockage dupliqué. Cette propriété spécifie le nombre de nœuds Redis utilisés comme StatefulSet.

redis.resources.requests.cpu Avancé Introduit dans la version : 1.6.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

redis.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

redis.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

redis.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

redis.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

redis.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

runtime

Le tableau suivant décrit les propriétés de l'objet runtime :

Propriété Type Description
runtime.annotations Avancé Introduit dans la version : 1.5.0

Valeur par défaut : aucune

Mappage clé/valeur facultatif utilisé pour annoter les pods. Pour en savoir plus, consultez la section Annotations personnalisées.

runtime.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

runtime.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

runtime.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

runtime.livenessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 2

Nombre de fois où Kubernetes va vérifier que les vérifications d'activité ont échoué avant de redémarrer le conteneur. La valeur minimale est 1.

runtime.livenessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 60

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'activité.

runtime.livenessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Détermine la fréquence à laquelle effectuer une vérification d'activité, en secondes. La valeur minimale est 1.

runtime.livenessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

runtime.nodeSelector.key De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Clé d'étiquette de sélecteur de nœud facultative pour le ciblage des nœuds Kubernetes pour les services runtime.

Consultez la section Propriété de nodeSelector.

runtime.nodeSelector.value De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Valeur de libellé de sélecteur de nœud pour le ciblage des nœuds Kubernetes pour les services runtime.

Consultez la page Configurer des pools de nœuds dédiés.

runtime.readinessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 2

Nombre de fois où Kubernetes vérifie que les vérifications d'aptitude ont échoué avant de marquer le pod comme non prêt. La valeur minimale est 1.

runtime.readinessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 60

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'aptitude.

runtime.readinessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Détermine la fréquence à laquelle effectuer une vérification d'aptitude, en secondes. La valeur minimale est 1.

runtime.readinessProbe.successThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre minimal de succès consécutifs requis pour qu'une vérification d'aptitude soit considérée comme réussie après un échec. La valeur minimale est 1.

runtime.readinessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

runtime.replicaCountMax De base Introduit dans la version : 1.0.0

Valeur par défaut : 4

Nombre maximal d'instances dupliquées disponibles pour l'autoscaling.

runtime.replicaCountMin De base Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre minimal d'instances dupliquées disponibles pour l'autoscaling.

runtime.resources.limits.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 4000m

Limite de processeur pour la ressource dans un conteneur Kubernetes, en millicores.

runtime.resources.limits.memory Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 6Gi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

runtime.resources.requests.cpu Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

runtime.resources.requests.memory Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 512Mi (voir la remarque ci-dessous)

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets (Mi) ou gibioctets (Gi).

runtime.service.type Avancé Introduit dans la version : 1.0.0

Valeur par défaut : ClusterIP

Type de service. Vous pouvez définir ce champ sur un service autre que ClusterIP. Par exemple, LoadBalancer.

runtime.targetCPUUtilizationPercentage Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 75

Utilisation du processeur cible pour le processus d'exécution sur le pod. La valeur de ce champ permet à l'environnement d'exécution de procéder à un autoscaling lorsque l'utilisation du processeur atteint cette valeur, jusqu'à replicaCountMax.

runtime.terminationGracePeriodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 180

Délai entre l'envoi d'une requête de suppression du pod et le moment où le pod est supprimé, en secondes. Pendant cette période, tous les hooks d'arrêt sont exécutés et tous les processus en cours doivent s'arrêter normalement.

runtime.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

runtime.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

runtime.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

runtime.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

runtime.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

synchronizer

S'assure que les processeurs de message sont tenus à jour avec les derniers groupes de proxy d'API déployés. Pour ce faire, le synchronisateur interroge le plan de gestion. Lorsqu'un nouveau contrat est détecté, le synchronisateur l'envoie au plan d'exécution. Par défaut, le synchronisateur stocke les données de configuration d'environnement dans Cassandra.

Pour en savoir plus, consultez la page Configurer le synchronisateur.

Le tableau suivant décrit les propriétés de l'objet synchronizer :

Propriété Type Description
synchronizer.annotations Avancé Introduit dans la version : 1.5.0

Valeur par défaut : aucune

Mappage clé/valeur facultatif utilisé pour annoter les pods. Pour en savoir plus, consultez la section Annotations personnalisées.

synchronizer.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

synchronizer.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

synchronizer.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

synchronizer.livenessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 2

Nombre de fois où Kubernetes va vérifier que les vérifications d'activité ont échoué avant de redémarrer le conteneur. La valeur minimale est 1.

synchronizer.livenessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 0

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'activité.

synchronizer.livenessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Détermine la fréquence à laquelle effectuer une vérification d'activité, en secondes. La valeur minimale est 1.

synchronizer.livenessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

synchronizer.nodeSelector.key De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Clé d'étiquette de sélecteur de nœud facultative pour le ciblage des nœuds Kubernetes pour les services d'exécution synchronizer.

Consultez la section nodeSelector.

synchronizer.nodeSelector.value De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Valeur de libellé de sélecteur de nœud facultative utilisée pour le ciblage des nœuds Kubernetes pour les services d'exécution synchronizer.

Consultez la section nodeSelector.

synchronizer.pollInterval Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 60

Durée d'attente du synchronisateur entre chaque opération d'interrogation. Le synchronisateur interroge les services du plan de contrôle Apigee pour détecter et extraire de nouveaux contrats d'exécution.

synchronizer.readinessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 2

Nombre de fois où Kubernetes vérifie que les vérifications d'aptitude ont échoué avant de marquer le pod comme non prêt. La valeur minimale est 1.

synchronizer.readinessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 0

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'aptitude.

synchronizer.readinessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Détermine la fréquence à laquelle effectuer une vérification d'aptitude, en secondes. La valeur minimale est 1.

synchronizer.readinessProbe.successThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre minimal de succès consécutifs requis pour qu'une vérification d'aptitude soit considérée comme réussie après un échec. La valeur minimale est 1.

synchronizer.readinessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

synchronizer.replicaCount De base Introduit dans la version : 1.0.0

Deprecated : à partir de la version 1.2 d'Apigee hybrid, vous pouvez gérer le nombre d'instances dupliquées de synchronisateur avec : synchronizer.replicaCountMax et synchronizer.replicaCountMin

synchronizer.replicaCountMax De base Introduit dans la version : 1.2.0

Valeur par défaut : 4

Nombre maximal d'instances dupliquées pour l'autoscaling.

synchronizer.replicaCountMin De base Introduit dans la version : 1.2.0

Valeur par défaut : 1

Nombre minimal d'instances dupliquées pour l'autoscaling.

synchronizer.resources.limits.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 2000m

Limite de processeur pour la ressource dans un conteneur Kubernetes, en millicores.

synchronizer.resources.limits.memory Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 5Gi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

synchronizer.resources.requests.cpu Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 100m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

synchronizer.resources.requests.memory Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1Gi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en gigaoctets.

synchronizer.serviceAccountPath De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

Chemin d'accès au fichier de clé de compte de service Google doté du rôle Gestionnaire de synchronisateur Apigee.

synchronizer.serviceAccountRef De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

synchronizer.targetCPUUtilizationPercentage Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 75

Utilisation du processeur cible pour le processus du synchronisateur sur le pod. La valeur de ce champ permet au synchronisateur de procéder à un autoscaling lorsque l'utilisation du processeur atteint cette valeur, jusqu'à replicaCountMax.

synchronizer.terminationGracePeriodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 30

Délai entre l'envoi d'une requête de suppression du pod et le moment où le pod est supprimé, en secondes. Pendant cette période, tous les hooks d'arrêt sont exécutés et tous les processus en cours doivent s'arrêter normalement.

synchronizer.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

synchronizer.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

synchronizer.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

synchronizer.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

synchronizer.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

udca

(Universal Data Collection Agent) Définit le service qui s'exécute dans le pod de collecte de données du plan d'exécution. Ce service extrait les données d'analyse et d'état du déploiement et les envoie à la plate-forme d'analyse unifiée UAP (Unified Analytics Platform).

Pour plus d'informations, consultez la section Collecte des données d'analyse et d'état du déploiement.

Le tableau suivant décrit les propriétés de l'objet udca :

Propriété Type Description
udca.annotations Avancé Introduit dans la version : 1.5.0

Valeur par défaut : aucune

Mappage clé/valeur facultatif utilisé pour annoter les pods. Pour en savoir plus, consultez la section Annotations personnalisées.

udca.fluentd.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

udca.fluentd.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.9.12-2

Libellé de la version pour l'image Docker de ce service.

udca.fluentd.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : gcr.io/apigee-release/hybrid/apigee-stackdriver-logging-agent

Emplacement de l'image Docker pour ce service.

udca.fluentd.resources.limits.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 1000m

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

udca.fluentd.resources.limits.memory Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 500Mi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

udca.fluentd.resources.requests.cpu Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 500m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

udca.fluentd.resources.requests.memory Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 250Mi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets.

udca.gsa Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service Google IAM apigee-udca (GSA) à associer au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm. Définissez ce paramètre lorsque vous avez défini gcp.workloadIdentity.enabled sur true.

Les adresses e-mail GSA ont généralement le format suivant :

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemple :

apigee-udca@my-hybrid-project.iam.gserviceaccount.com

Consultez la section Activer Workload Identity sur GKE ou Activer la fédération d'identité de charge de travail sur AKS et EKS.

udca.image.pullPolicy Avancé Introduit dans la version : 1.0.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

udca.image.tag Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

udca.image.url Avancé Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

udca.jvmXms Avancé Introduit dans la version : 1.0.0

Deprecated : à partir de la version 1.8 d'Apigee hybrid, udca.jvmXms n'est plus utilisé.

udca.jvmXmx Avancé Introduit dans la version : 1.0.0

Deprecated : à partir de la version 1.8 d'Apigee hybrid, udca.jvmXmx n'est plus utilisé.

udca.livenessProbe.failureThreshold Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 2

Nombre de fois où Kubernetes va vérifier que les vérifications d'activité ont échoué avant de redémarrer le conteneur. La valeur minimale est 1.

udca.livenessProbe.initialDelaySeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 0

Nombre de secondes entre le démarrage d'un conteneur et le lancement d'une vérification d'activité.

udca.livenessProbe.periodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 5

Détermine la fréquence à laquelle effectuer une vérification d'activité, en secondes. La valeur minimale est 1.

udca.livenessProbe.timeoutSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre de secondes au terme desquelles une vérification d'activité expire. La valeur minimale est 1.

udca.nodeSelector.key De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Clé d'étiquette de sélecteur de nœud utilisée pour cibler des nœuds Kubernetes dédiés pour les services d'exécution udca.

Consultez la page Configurer des pools de nœuds dédiés.

udca.nodeSelector.value De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

Obligatoire

Valeur de libellé de sélecteur de nœud utilisée pour cibler des nœuds Kubernetes dédiés pour les services d'exécution udca.

Consultez la page Configurer des pools de nœuds dédiés.

udca.pollingIntervalInSec Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 1

Durée d'attente, en secondes, entre les opérations d'interrogation de l'UDCA. L'UDCA interroge le répertoire de données sur le système de fichiers du pod de collecte de données pour détecter les nouveaux fichiers à importer.

udca.replicaCountMax De base Introduit dans la version : 1.0.0

Valeur par défaut : 4

Nombre maximal de pods que l'installation hybride peut ajouter automatiquement pour le déploiement de l'agent UDCA. Comme UDCA est mis en œuvre en tant que ReplicaSet, les pods sont des instances répliquées.

Il est recommandé de définir udca.replicaCountMax sur un nombre maximal d'instances répliquées par environnement, multiplié par le nombre d'environnements dans votre organisation Apigee. Par exemple, si vous souhaitez autoriser au maximum quatre instances répliquées par environnement et si vous disposez de trois environnements, définissez udca.replicaCountMax: 12.

udca.replicaCountMin De base Introduit dans la version : 1.0.0

Valeur par défaut : 1

Nombre minimal de pods pour le déploiement UDCA. Comme UDCA est mis en œuvre en tant que ReplicaSet, les pods sont des instances dupliquées.

Si l'utilisation du processeur dépasse udca.targetCPUUtilizationPercentage, le trafic hybride augmente progressivement le nombre de pods, jusqu'à udca.replicaCountMax.

udca.resources.limits.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 1000m

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

udca.resources.limits.memory Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 2Gi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

udca.resources.requests.cpu Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 250m

Processeur requis pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en millicores.

udca.resources.requests.memory Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 250Mi

Mémoire requise pour le fonctionnement normal de la ressource dans un conteneur Kubernetes, en mébioctets.

udca.revision Avancé Introduit dans la version : 1.0.0

Valeur par défaut : v1

Valeur statique renseignée dans un libellé pour activer les déploiements Canary.

udca.serviceAccountPath De base Introduit dans la version : 1.0.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef

Chemin d'accès au fichier de clé de compte de service Google doté du rôle Agent d'analyses Apigee.

udca.serviceAccountRef De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef

udca.targetCPUUtilizationPercentage Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 75

Seuil d'utilisation du processeur pour le scaling du nombre de pods dans ReplicaSet, sous forme de pourcentage du total des ressources processeur disponibles. Hybrid utilise l'utilisation combinée de tous les conteneurs du pod de collecte de données (fluentd et UDCA) pour calculer l'utilisation actuelle.

Lorsque l'utilisation du processeur dépasse cette valeur, hybrid augmente progressivement le nombre de pods, jusqu'à udca.replicaCountMax.

udca.terminationGracePeriodSeconds Avancé Introduit dans la version : 1.0.0

Valeur par défaut : 600

Délai entre l'envoi d'une requête de suppression du pod et le moment où le pod est supprimé, en secondes. Pendant cette période, tous les hooks d'arrêt sont exécutés et tous les processus en cours doivent s'arrêter normalement.

udca.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

udca.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

udca.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

udca.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

udca.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

virtualhosts

La propriété virtualhosts est une propriété de configuration obligatoire. Les hôtes virtuels permettent à Apigee hybrid de gérer les requêtes API adressées à un groupe d'environnements spécifié.

Pour plus d'informations, consultez la page Configurer des hôtes virtuels.

Le tableau suivant décrit les propriétés de l'objet virtualhosts :

Propriété Type Description
virtualhosts[].additionalGateways De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Liste des passerelles Istio vers lesquelles acheminer le trafic.

virtualhosts[].cipherSuites[] Avancé Introduit dans la version : 1.9.2

Valeur par défaut : aucune

Cette propriété configure les algorithmes de chiffrement TLS utilisés dans la passerelle d'entrée. Vous trouverez ci-dessous la liste des algorithmes de chiffrement activés par défaut au format OpenSSL. Pour en savoir plus sur les algorithmes de chiffrement acceptés, consultez la documentation sur la compilation Boring FIPS d'Envoy. Une valeur vide correspond par défaut aux suites de chiffrement compatibles avec la compilation FIPS Boring d'Envoy.

Activé par défaut pour TLS v1.3 (vous ne pouvez pas remplacer les suites de chiffrement TLS 1.3) :

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256

Activé par défaut pour TLS v1.2 :

  • ECDHE-ECDSA-AES128-GCM-SHA256
  • ECDHE-RSA-AES128-GCM-SHA256
  • ECDHE-ECDSA-AES256-GCM-SHA384
  • ECDHE-RSA-AES256-GCM-SHA384

Si vous souhaitez activer les anciennes versions de TLS dans votre déploiement de passerelle d'entrée Apigee, utilisez virtualhosts.minTLSProtocolVersion avec la propriété virtualhosts.cipherSuites.

Par exemple, pour activer TLS v1.1 :

virtualhosts:
- name: ENV_GROUP_NAME
  minTLSProtocolVersion: "1.1"
  cipherSuites:
  - "ECDHE-ECDSA-AES128-GCM-SHA256"
  - "ECDHE-RSA-AES128-GCM-SHA256"
  - "ECDHE-ECDSA-AES256-GCM-SHA384"
  - "ECDHE-RSA-AES256-GCM-SHA384"
  - "ECDHE-ECDSA-CHACHA20-POLY1305"
  - "ECDHE-RSA-CHACHA20-POLY1305"
  - "ECDHE-ECDSA-AES128-SHA"
  - "ECDHE-RSA-AES128-SHA"
  - "ECDHE-ECDSA-AES256-SHA"
  - "ECDHE-RSA-AES256-SHA"
...
virtualhosts[].name De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Obligatoire

Nom de l'hôte virtuel.

virtualhosts[].maxTLSProtocolVersion De base Introduit dans la version : 1.3.0

Valeur par défaut : aucune

Version maximale du protocole TLS qu'Envoy peut sélectionner. Envoy utilise automatiquement la version de protocole TLS optimale entre virtualhosts[].minTLSProtocolVersion et virtualhosts[].maxTLSProtocolVersion.

La valeur doit se présenter sous la forme d'un nombre. Exemple :

virtualhosts:
  - name: default
    maxTLSProtocolVersion: "1.3"

où le numéro représente le numéro de version TLS au format #.#. Dans l'exemple ci-dessus, "1.3" représente la version TLS TLSV1_3 d'Istio.

Consultez également la page ServerTLSSettings.TLSProtocol dans la documentation d'Istio.

virtualhosts[].minTLSProtocolVersion De base Introduit dans la version : 1.3.0

Valeur par défaut : aucune

Version minimale du protocole TLS qu'Envoy peut sélectionner. Envoy utilise automatiquement la version de protocole TLS optimale entre virtualhosts[].minTLSProtocolVersion et virtualhosts[].maxTLSProtocolVersion.

La valeur doit se présenter sous la forme d'un nombre. Exemple :

virtualhosts:
  - name: default
    minTLSProtocolVersion: "1.2"

où le numéro représente le numéro de version TLS au format #.#. Dans l'exemple ci-dessus, 1.2 représente la version TLS TLSV1_2 d'Istio.

Consultez également la page ServerTLSSettings.TLSProtocol dans la documentation d'Istio.

virtualhosts[].selector De base Introduit dans la version : 1.2.0

Valeur par défaut : app: apigee-ingressgateway

Obligatoire

Paire valeur de clé/valeur de sélecteur permettant de pointer vers différents sélecteurs d'entrée.

  • apigee-ingressgateway : pour les installations Apigee hybrid utilisant une passerelle d'entrée Apigee.
  • istio-ingressgateway : pour les installations Apigee hybrid utilisant Cloud Service Mesh (Apigee hybrid versions 1.8 et antérieures).

Si aucune étiquette de sélecteur n'est spécifiée, la configuration est fournie à la passerelle d'entrée Apigee.

virtualhosts[].sslCertPath De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Soit sslCertPath/sslKeyPath, soit sslSecret est requis.

Chemin d'accès de votre système à un fichier de certificat TLS.

virtualhosts[].sslKeyPath De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Soit sslCertPath/sslKeyPath, soit sslSecret est requis.

Chemin d'accès de votre système au fichier de clé privée TLS.

virtualhosts[].sslSecret De base Introduit dans la version : 1.2.0

Valeur par défaut : aucune

Soit sslCertPath/sslKeyPath, soit sslSecret est requis.

Nom d'un fichier stocké dans un secret Kubernetes contenant le certificat TLS et la clé privée. Vous devez créer le secret en utilisant le certificat TLS et des données de clé comme entrée.

Voir également :

watcher

La propriété watcher est une propriété de configuration obligatoire. Watcher est un processus qui surveille les modifications de configuration et déclenche leur application dans le plan d'exécution.

Le tableau suivant décrit les propriétés de l'objet watcher :

Propriété Type Description
watcher.annotations Avancé Introduit dans la version : 1.5.0

Valeur par défaut : aucune

Mappage clé/valeur facultatif utilisé pour annoter les pods. Pour en savoir plus, consultez la section Annotations personnalisées.

watcher.args.enableIssueScanning Avancé Introduit dans la version : 1.10.0

Valeur par défaut : true

Active ou désactive l'identification automatique des problèmes. Lorsque cette propriété est définie sur true, Watcher analyse automatiquement le plan de contrôle et l'état du serveur d'API Kubernetes pour déterminer s'il existe des problèmes de configuration.

Définissez-la sur false pour désactiver l'identification automatique des problèmes. Pour en savoir plus, consultez la section Identification automatique des problèmes.

watcher.args.issueScanInterval Avancé Introduit dans la version : 1.10.0

Valeur par défaut : 60

Intervalle en secondes définissant la fréquence à laquelle Watcher analyse le plan d'exécution pour identifier automatiquement des problèmes. Pour en savoir plus, consultez la section Identification automatique des problèmes.

watcher.gsa Avancé Introduit dans la version : 1.10.0

Valeur par défaut : aucune

Helm uniquement : adresse e-mail du compte de service Google IAM apigee-watcher (GSA) à associer au compte de service Kubernetes correspondant lors de l'activation de Workload Identity sur des clusters GKE à l'aide de graphiques Helm. Définissez ce paramètre lorsque vous avez défini gcp.workloadIdentity.enabled sur true.

Les adresses e-mail GSA ont généralement le format suivant :

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemple :

apigee-watcher@my-hybrid-project.iam.gserviceaccount.com

Consultez la section Activer Workload Identity sur GKE ou Activer la fédération d'identité de charge de travail sur AKS et EKS.

watcher.image.pullPolicy Avancé Introduit dans la version : 1.4.0

Valeur par défaut : IfNotPresent

Détermine quand kubelet extrait l'image Docker du pod. Les valeurs possibles sont les suivantes :

  • IfNotPresent : n'extrait pas une nouvelle image si elle existe déjà.
  • Always : extrait toujours l'image, qu'elle existe déjà ou non.

Pour en savoir plus, consultez la section Mettre à jour des images.

watcher.image.tag Avancé Introduit dans la version : 1.4.0

Valeur par défaut : 1.13.0

Libellé de la version pour l'image Docker de ce service.

watcher.image.url Avancé Introduit dans la version : 1.4.0

Valeur par défaut : aucune

Emplacement de l'image Docker pour ce service.

Utilisez apigee-pull-push --list pour afficher l'URL actuelle du dépôt de ce composant.

watcher.replicaCountMax De base Introduit dans la version : 1.3.0

Valeur par défaut : 1

Nombre maximal d'instances dupliquées de Watcher. Pour éviter tout conflit, vous devez conserver le paramètre sur 1.

watcher.replicaCountMin De base Introduit dans la version : 1.3.0

Valeur par défaut : 1

Nombre minimal d'instances dupliquées de Watcher.

watcher.resources.limits.cpu Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 1000m

Limite de processeur pour la ressource dans un conteneur Kubernetes, en millicores.

watcher.resources.limits.memory Avancé Introduit dans la version : 1.11.0

Valeur par défaut : 2Gi

Limite de mémoire pour la ressource dans un conteneur Kubernetes, en mébioctets.

watcher.serviceAccountPath De base Introduit dans la version : 1.3.0

Valeur par défaut : aucune

Obligatoire.

Chemin d'accès au fichier de clé de compte de service Google doté du rôle Agent d'exécution Apigee.

watcher.serviceAccountRef Avancé Introduit dans la version : 1.3.0

Valeur par défaut : aucune

L'une des valeurs suivantes est requise : serviceAccountPath ou serviceAccountRef.

watcher.tolerations.effect Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

effect spécifie l'effet qu'aura la correspondance d'une tolérance avec un rejet. Les valeurs possibles pour effect sont les suivantes :

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

watcher.tolerations.key Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

key identifie les pods auxquels la tolérance peut être appliquée.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

watcher.tolerations.operator Avancé Introduit dans la version : 1.10.1

Valeur par défaut : "Equal"

Obligatoire pour utiliser la fonctionnalité Rejets et tolérances de Kubernetes.

operator spécifie l'opération utilisée pour déclencher l'effect. Les valeurs possibles pour operator sont les suivantes :

  • Equal correspond à la valeur définie dans value.
  • Exists ignore la valeur définie dans value.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

watcher.tolerations.tolerationSeconds Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

tolerationSeconds définit en secondes la durée pendant laquelle un pod reste lié à un nœud défaillant ou qui ne répond pas.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.

watcher.tolerations.value Avancé Introduit dans la version : 1.10.1

Valeur par défaut : aucune

Utilisé par la fonctionnalité Rejets et tolérances de Kubernetes.

value est la valeur qui déclenche l'effect lorsque operator est défini sur Equal.

Pour plus d'informations, consultez la section Rejets et tolérances : Concepts.