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

Introduit dans la version : 1.3.0

Valeur par défaut : iloveapis123

Optional

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.

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

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

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.

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.

Valeur par défaut : aucune

Helm uniquement:URL d'un dépôt de conteneurs d'images privé utilisé pour extraire des images de tous les composants Apigee à partir 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.11.2
  imagePullPolicy: IfNotPresent

containers:
- name: apigee-ingressgateway
  image: private-docker-host.example.com/apigee-asm-ingress:1.18.7-asm.26-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 de tous les composants.

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

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

• ao.image.url
• apigeeIngressGateway.image.url
• cassandra.image.url
• cassandra.auth.image.url
• cassandra.backup.image.url
• cassandra.restore.image.url
• connectAgent.image.url
• ingressGateways[].image.url
• istiod.image.url
• kubeRBACProxy.image.url
• logger.image.url
• mart.image.url
• metrics.adapter.image.url
• metrics.prometheus.image.url
• metrics.sdSidecar.image.url
• mintTaskScheduler.image.url
• redis.image.url
• redis.envoy.image.url
• runtime.image.url
• synchronizer.image.url
• udca.image.url
• udca.fluentd.image.url
• watcher.image.url

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é.

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).

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Valeur par défaut : apigee

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

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.

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.

Valeur par défaut :"1112" (votre version hybride Apigee sans points). Par exemple, pour la version 1.11.0, la valeur par défaut est "1110".)

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 :

• nodeSelector
• envs
• imagePullSecrets
• gcpProjectID
• k8sClusterName
• contractProvider
• org

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

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

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

Valeur par défaut : true

Indique à Apigee de cesser de fournir une configuration aux instances ASM 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 Anthos Service Mesh (Apigee hybrid versions 1.8 et antérieures).

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.

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.

Valeur par défaut : 1.11.2

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

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.

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.

Valeur par défaut : 1.11.2

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

Valeur par défaut : gcr.io/apigee-release/hybrid/apigee-installer

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.

Valeur par défaut : 250m

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

Valeur par défaut : 256Mi

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

Valeur par défaut : 250m

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

Valeur par défaut : 256Mi

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

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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.

Valeur par défaut : 2

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

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.

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