Cette page a été traduite par l'API Cloud Translation.

Étape 7 : Créer les remplacements

Spécifier des remplacements de configuration

Le programme d'installation d'Apigee hybrid utilise les valeurs par défaut pour de nombreux paramètres. Cependant, certains paramètres n'ont pas de valeurs par défaut. Vous devez fournir des valeurs pour ces paramètres, comme expliqué ci-dessous.

Avant de commencer

Nous vous recommandons de consulter les scénarios suivants pour déterminer si vous souhaitez configurer votre cluster pour eux. Ces configurations sont facultatives.

Si vous prévoyez d'installer hybrid dans plusieurs régions, consultez la section Déploiement multirégional avant de continuer.
Apigee hybrid fournit des mots de passe par défaut pour les utilisateurs Cassandra. Apigee recommande de modifier les mots de passe utilisateur par défaut. Pour en savoir plus, consultez la page Configurer TLS pour Cassandra.
Si vous souhaitez configurer les paramètres de stockage et de segments de mémoire pour Cassandra, consultez la page Configurer les paramètres de stockage et de segments de mémoire.
Comme décrit sur la page Partie 1 : Configuration du projet et de l'organisation – Étape 1 : Activer les API, pour les scénarios d'installation en production, configurez un stockage sur disque SSD persistant pour Cassandra. Apigee ne permet pas d'utiliser des disques SSD locaux pour Apigee hybrid. Pour en savoir plus, consultez Ajouter un stockage SSD pour les déploiements de production.

Configurer le cluster

Par convention, les remplacements de configuration sont écrits dans un fichier nommé overrides.yaml généralement stocké dans votre répertoire $APIGEE_HELM_CHARTS_HOME.

Remarque : Le fichier overrides.yaml sera utilisé lors des mises à niveau, des expansions et chaque fois que vous devrez modifier la configuration de votre installation d'exécution hybride. Apigee vous recommande de stocker ce fichier dans un dépôt de gestion de code source avec contrôle des versions.

Créez un fichier nommé overrides.yaml dans votre répertoire $APIGEE_HELM_CHARTS_HOME.
Le fichier overrides.yaml fournit la configuration pour votre installation Apigee hybrid unique. Le fichier de remplacement utilisé à cette étape fournit une configuration de base pour une installation d'exécution Apigee hybrid peu encombrante, adaptée pour une première installation.

Dans overrides.yaml, ajoutez les valeurs de propriété requises, indiquées ci-dessous. Vous trouverez ci-dessous une description détaillée de chaque propriété.

Assurez-vous que le fichier overrides.yaml possède la structure et la syntaxe suivantes.

Sélectionnez l'onglet correspondant au type d'authentification du compte de service que vous utilisez dans votre installation : Étape 4 : Créer des comptes de service.

Clés de compte de service dans les secrets Kubernetes : Secrets Kubernetes
Fichiers de clé JSON du compte de service : fichiers JSON
Clés de compte de service dans Vault : Vault
Fédération d'identité de charge de travail pour GKE : WIF pour GKE
Fédération d'identité de charge de travail : Fédération d'identité de charge de travail sur d'autres plates-formes

Pour obtenir une présentation des différentes options d'authentification, consultez Méthodes d'authentification des comptes de service dans Apigee hybrid.

Sélectionnez l'onglet correspondant à votre installation de production ou hors production (démonstration, évaluation ou démonstration de faisabilité), selon votre choix à l'étape 4 : Créer des comptes de service.

Pour les installations dans des environnements de production, consultez les exigences de stockage de la base de données Cassandra dans la section Configurer Cassandra pour la production.

Secrets Kubernetes

Production

Modèle

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretRefs:
    synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-synchronizer-svc-account"
    runtime: RUNTIME_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-runtime-svc-account"
    udca: UDCA_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-udca-svc-account"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountRef: MART_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-mart-svc-account"

connectAgent:
  serviceAccountRef: MART_SERVICE_ACCOUNT_SECRET
    # Use the same secret for mart and connectAgent
    # For example: "apigee-mart-svc-account"

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountRef: LOGGER_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-logger-svc-account"

metrics:
  serviceAccountRef: METRICS_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-metrics-svc-account"

udca:
  serviceAccountRef: UDCA_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-udca-svc-account"

watcher:
  serviceAccountRef: WATCHER_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-watcher-svc-account"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountRef: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-mint-task-scheduler-svc-account"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

Le tableau suivant décrit chacune des valeurs de propriété que vous devez fournir dans le fichier de remplacement. Pour en savoir plus, consultez la documentation de référence sur les propriétés de configuration.

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ SECRET`	Nom du secret Kubernetes que vous avez créé pour la clé du compte de service à l'étape 5 : Configurer l'authentification du compte de service. Les noms par défaut des secrets suggérés dans ce guide sont les suivants : Production `apigee-cassandra-svc-account` `apigee-logger-svc-account` `apigee-mart-svc-account` `apigee-metrics-svc-account` `apigee-mint-task-scheduler-svc-account` `apigee-runtime-svc-account` `apigee-synchronizer-svc-account` `apigee-udca-svc-account` `apigee-watcher-svc-account` Hors production `apigee-non-prod-svc-account` Consultez les pages suivantes : `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountSecretRefs:
    synchronizer: "apigee-synchronizer-svc-account"
    runtime: "apigee-runtime-svc-account"
    udca: "apigee-udca-svc-account"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountRef: "apigee-mart-svc-account"

connectAgent:
  serviceAccountRef: "apigee-mart-svc-account"

logger:
  enabled: true
  serviceAccountRef: "apigee-logger-svc-account"

metrics:
  serviceAccountRef: "apigee-metrics-svc-account"

udca:
  serviceAccountRef: "apigee-udca-svc-account"

watcher:
  serviceAccountRef: "apigee-watcher-svc-account"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountRef: apigee-mint-task-scheduler-svc-account

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ SECRET`	Nom du secret Kubernetes que vous avez créé pour la clé du compte de service à l'étape 5 : Configurer l'authentification du compte de service. Les noms par défaut des secrets suggérés dans ce guide sont les suivants : Production `apigee-cassandra-svc-account` `apigee-logger-svc-account` `apigee-mart-svc-account` `apigee-metrics-svc-account` `apigee-mint-task-scheduler-svc-account` `apigee-runtime-svc-account` `apigee-synchronizer-svc-account` `apigee-udca-svc-account` `apigee-watcher-svc-account` Hors production `apigee-non-prod-svc-account` Consultez les pages suivantes : `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Hors production

Modèle

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretRefs:
    synchronizer: NON_PROD_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-non-prod-svc-account"
    runtime: NON_PROD_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-non-prod-svc-account"
    udca: NON_PROD_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-non-prod-svc-account"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

connectAgent:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # Use the same secret for mart and connectAgent
    # For example: "apigee-non-prod-svc-account"

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

metrics:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

udca:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

watcher:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ SECRET`	Nom du secret Kubernetes que vous avez créé pour la clé du compte de service à l'étape 5 : Configurer l'authentification du compte de service. Les noms par défaut des secrets suggérés dans ce guide sont les suivants : Production `apigee-cassandra-svc-account` `apigee-logger-svc-account` `apigee-mart-svc-account` `apigee-metrics-svc-account` `apigee-mint-task-scheduler-svc-account` `apigee-runtime-svc-account` `apigee-synchronizer-svc-account` `apigee-udca-svc-account` `apigee-watcher-svc-account` Hors production `apigee-non-prod-svc-account` Consultez les pages suivantes : `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountSecretRefs:
    synchronizer: "apigee-non-prod-svc-account"
    runtime: "apigee-non-prod-svc-account"
    udca: "apigee-non-prod-svc-account"

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountRef: "apigee-non-prod-svc-account"

connectAgent:
  serviceAccountRef: "apigee-non-prod-svc-account"

logger:
  enabled: true
  serviceAccountRef: "apigee-non-prod-svc-account"

metrics:
  serviceAccountRef: "apigee-non-prod-svc-account"

udca:
  serviceAccountRef: "apigee-non-prod-svc-account"

watcher:
  serviceAccountRef: "apigee-non-prod-svc-account"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountRef: apigee-non-prod-svc-account

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ SECRET`	Nom du secret Kubernetes que vous avez créé pour la clé du compte de service à l'étape 5 : Configurer l'authentification du compte de service. Les noms par défaut des secrets suggérés dans ce guide sont les suivants : Production `apigee-cassandra-svc-account` `apigee-logger-svc-account` `apigee-mart-svc-account` `apigee-metrics-svc-account` `apigee-mint-task-scheduler-svc-account` `apigee-runtime-svc-account` `apigee-synchronizer-svc-account` `apigee-udca-svc-account` `apigee-watcher-svc-account` Hors production `apigee-non-prod-svc-account` Consultez les pages suivantes : `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Fichiers JSON

Production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    # Provide the path relative to the apigee-env chart directory.
    synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-synchronizer.json"
    runtime: RUNTIME_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-runtime.json"
    udca: UDCA_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-udca.json"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountPath: LOGGER_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-F chart directory.
    # For example: "PROJECT_ID-apigee-logger.json"

mart:
  serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-mart.json"

connectAgent:
  serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
    # Use the same service account for mart and connectAgent
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-mart.json"

metrics:
  serviceAccountPath: METRICS_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-metrics.json"

udca:
  serviceAccountPath: UDCA_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-udca.json"

watcher:
  serviceAccountPath: WATCHER_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-watcher.json"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountPath: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-mint-task-scheduler.json"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable Description

UNIQUE_INSTANCE_ IDENTIFIER

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

Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais instanceID doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions).

Vous pouvez créer plusieurs organisations dans le même cluster, mais le instanceID doit être identique pour toutes les organisations du même cluster Kubernetes.

Consultez instanceID.

APIGEE_NAMESPACE

Espace de noms Kubernetes pour vos composants Apigee hybrid.

La valeur par défaut est apigee.

Consultez namespace.

PROJECT_ID

Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement PROJECT_ID.

Consultez gcp.projectID.

ANALYTICS_REGION

Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation).

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement ANALYTICS_REGION.

Consultez gcp.region.

CLUSTER_NAME

Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement CLUSTER_NAME.

Consultez k8sCluster.name.

CLUSTER_LOCATION

La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster.

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement CLUSTER_LOCATION.

Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone us-central1-a, spécifiez us-central1 pour le paramètre CLUSTER_LOCATION.

Consultez k8sCluster.location.

ORG_NAME

ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement ORG_NAME.

Consultez org.

CONTROL_PLANE_ LOCATION

Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement CONTROL_PLANE_LOCATION à l'Étape 2 : Créer une organisation.

Consultez contractProvider.

ENVIRONMENT_NAME

Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation.

Consultez envs[].name.

ENVIRONMENT_GROUP_ NAME

Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement ENV_GROUP.

Consultez virtualhosts[].name.

INGRESS_NAME

Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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.

Consultez les pages suivantes :

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. Exemple :

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consultez les pages suivantes :

SVC_ANNOTATIONS_ KEY : SVC_ANNOTATIONS_ VALUE

(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe.

Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées.

Remarque : Vous n'avez pas besoin de définir svcAnnotations si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee.

Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas.

Consultez ingressGateways[].svcAnnotations.

<component>_ SERVICE_ACCOUNT_ FILEPATH

Chemin d'accès et compte de nom de fichier des fichiers JSON du compte de service dans votre répertoire de chart correspondant. Indiquez les noms en indiquant le chemin d'accès relatif au répertoire de chart. Par exemple :

Si le fichier my-project-apigee-synchronizer.json se trouve dans le répertoire de chart apigee-env/, il vous suffit de fournir le nom du fichier, par exemple :
```
synchronizer:  "FILE_NAME.json"
```
Si le fichier se trouve dans un répertoire apigee-env/service-accounts/, vous devez spécifier un chemin d'accès relatif :
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Pour les environnements hors production, le nom du compte de service unique, PROJECT_ID-non-prod.json par défaut.

Pour les environnements de production, le nom du fichier de clé de compte de service que vous avez généré à l'aide de l'outil create-service-account à l'Étape 4 : Créer des comptes de service.

Vous pouvez voir les fichiers du compte de service dans chaque répertoire de chart correspondant.

Les noms par défaut des répertoires de charts correspondants pour les comptes de service sont les suivants :

Production

Nom du fichier du compte de service	Répertoire de chart
`PROJECT_ID-apigee-cassandra.json`	`apigee-datastore/`
`PROJECT_ID-apigee-mart.json`	`apigee-org/`
`PROJECT_ID-apigee-metrics.json`	`apigee-telemetry/`
`PROJECT_ID-apigee-mint-task-scheduler.json`	`apigee-org/`
`PROJECT_ID-apigee-runtime.json`	`apigee-env/`
`PROJECT_ID-apigee-synchronizer.json`	`apigee-env/`
`PROJECT_ID-apigee-udca.json`	`apigee-org/`
`PROJECT_ID-apigee-watcher.json`	`apigee-org/`

Hors production

Nom du fichier du compte de service	Répertoire de chart
`PROJECT_ID-non-prod.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Remarque : mart et connectAgent utilisent le compte de service apigee-mart.

Consultez les pages suivantes :

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountPaths:
    synchronizer: "my-project-apigee-synchronizer.json"
    runtime: "my-project-apigee-runtime.json"
    udca: "my-project-apigee-udca.json"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: true
  serviceAccountPath: "my-project-apigee-logger.json"

mart:
  serviceAccountPath: "my-project-apigee-mart.json"

connectAgent:
  serviceAccountPath: "my-project-apigee-mart.json"

metrics:
  serviceAccountPath: "my-project-apigee-metrics.json"

udca:
  serviceAccountPath: "my-project-apigee-udca.json"

watcher:
  serviceAccountPath: "my-project-apigee-watcher.json"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: my-project-apigee-mint-task-scheduler.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable Description

UNIQUE_INSTANCE_ IDENTIFIER

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

Vous pouvez créer plusieurs organisations dans le même cluster, mais le instanceID doit être identique pour toutes les organisations du même cluster Kubernetes.

Consultez instanceID.

APIGEE_NAMESPACE

Espace de noms Kubernetes pour vos composants Apigee hybrid.

La valeur par défaut est apigee.

Consultez namespace.

PROJECT_ID

Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement PROJECT_ID.

Consultez gcp.projectID.

ANALYTICS_REGION

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement ANALYTICS_REGION.

Consultez gcp.region.

CLUSTER_NAME

Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement CLUSTER_NAME.

Consultez k8sCluster.name.

CLUSTER_LOCATION

La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster.

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement CLUSTER_LOCATION.

Consultez k8sCluster.location.

ORG_NAME

ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement ORG_NAME.

Consultez org.

CONTROL_PLANE_ LOCATION

Consultez contractProvider.

ENVIRONMENT_NAME

Consultez envs[].name.

ENVIRONMENT_GROUP_ NAME

Consultez virtualhosts[].name.

INGRESS_NAME

Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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.

Consultez les pages suivantes :

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consultez les pages suivantes :

SVC_ANNOTATIONS_ KEY : SVC_ANNOTATIONS_ VALUE

Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées.

Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas.

Consultez ingressGateways[].svcAnnotations.

<component>_ SERVICE_ACCOUNT_ FILEPATH

Si le fichier my-project-apigee-synchronizer.json se trouve dans le répertoire de chart apigee-env/, il vous suffit de fournir le nom du fichier, par exemple :
```
synchronizer:  "FILE_NAME.json"
```
Si le fichier se trouve dans un répertoire apigee-env/service-accounts/, vous devez spécifier un chemin d'accès relatif :
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Pour les environnements hors production, le nom du compte de service unique, PROJECT_ID-non-prod.json par défaut.

Vous pouvez voir les fichiers du compte de service dans chaque répertoire de chart correspondant.

Les noms par défaut des répertoires de charts correspondants pour les comptes de service sont les suivants :

Production

Nom du fichier du compte de service	Répertoire de chart
`PROJECT_ID-apigee-cassandra.json`	`apigee-datastore/`
`PROJECT_ID-apigee-mart.json`	`apigee-org/`
`PROJECT_ID-apigee-metrics.json`	`apigee-telemetry/`
`PROJECT_ID-apigee-mint-task-scheduler.json`	`apigee-org/`
`PROJECT_ID-apigee-runtime.json`	`apigee-env/`
`PROJECT_ID-apigee-synchronizer.json`	`apigee-env/`
`PROJECT_ID-apigee-udca.json`	`apigee-org/`
`PROJECT_ID-apigee-watcher.json`	`apigee-org/`

Hors production

Nom du fichier du compte de service	Répertoire de chart
`PROJECT_ID-non-prod.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Remarque : mart et connectAgent utilisent le compte de service apigee-mart.

Consultez les pages suivantes :

Hors production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    # Provide the path relative to the apigee-env chart directory.
    synchronizer: NON_PROD_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-non-prod.json"
    runtime: NON_PROD_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-non-prod.json"
    udca: NON_PROD_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-non-prod.json"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

connectAgent:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Use the same service account for mart and connectAgent
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-F chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

metrics:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

udca:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

watcher:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable Description

UNIQUE_INSTANCE_ IDENTIFIER

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

Vous pouvez créer plusieurs organisations dans le même cluster, mais le instanceID doit être identique pour toutes les organisations du même cluster Kubernetes.

Consultez instanceID.

APIGEE_NAMESPACE

Espace de noms Kubernetes pour vos composants Apigee hybrid.

La valeur par défaut est apigee.

Consultez namespace.

PROJECT_ID

Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement PROJECT_ID.

Consultez gcp.projectID.

ANALYTICS_REGION

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement ANALYTICS_REGION.

Consultez gcp.region.

CLUSTER_NAME

Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement CLUSTER_NAME.

Consultez k8sCluster.name.

CLUSTER_LOCATION

La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster.

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement CLUSTER_LOCATION.

Consultez k8sCluster.location.

ORG_NAME

ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement ORG_NAME.

Consultez org.

CONTROL_PLANE_ LOCATION

Consultez contractProvider.

ENVIRONMENT_NAME

Consultez envs[].name.

ENVIRONMENT_GROUP_ NAME

Consultez virtualhosts[].name.

INGRESS_NAME

Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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.

Consultez les pages suivantes :

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consultez les pages suivantes :

SVC_ANNOTATIONS_ KEY : SVC_ANNOTATIONS_ VALUE

Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées.

Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas.

Consultez ingressGateways[].svcAnnotations.

<component>_ SERVICE_ACCOUNT_ FILEPATH

Si le fichier my-project-apigee-synchronizer.json se trouve dans le répertoire de chart apigee-env/, il vous suffit de fournir le nom du fichier, par exemple :
```
synchronizer:  "FILE_NAME.json"
```
Si le fichier se trouve dans un répertoire apigee-env/service-accounts/, vous devez spécifier un chemin d'accès relatif :
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Pour les environnements hors production, le nom du compte de service unique, PROJECT_ID-non-prod.json par défaut.

Vous pouvez voir les fichiers du compte de service dans chaque répertoire de chart correspondant.

Les noms par défaut des répertoires de charts correspondants pour les comptes de service sont les suivants :

Production

Nom du fichier du compte de service	Répertoire de chart
`PROJECT_ID-apigee-cassandra.json`	`apigee-datastore/`
`PROJECT_ID-apigee-mart.json`	`apigee-org/`
`PROJECT_ID-apigee-metrics.json`	`apigee-telemetry/`
`PROJECT_ID-apigee-mint-task-scheduler.json`	`apigee-org/`
`PROJECT_ID-apigee-runtime.json`	`apigee-env/`
`PROJECT_ID-apigee-synchronizer.json`	`apigee-env/`
`PROJECT_ID-apigee-udca.json`	`apigee-org/`
`PROJECT_ID-apigee-watcher.json`	`apigee-org/`

Hors production

Nom du fichier du compte de service	Répertoire de chart
`PROJECT_ID-non-prod.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Remarque : mart et connectAgent utilisent le compte de service apigee-mart.

Consultez les pages suivantes :

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountPaths:
    synchronizer: "hybrid-example-apigee-non-prod.json"
    runtime: "hybrid-example-apigee-non-prod.json"
    udca: "hybrid-example-apigee-non-prod.json"

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountPath: "my-project-apigee-non-prod.json"

connectAgent:
  serviceAccountPath: "my-project-apigee-non-prod.json"

logger:
  enabled: true
  serviceAccountPath: "my-project-apigee-non-prod.json"

metrics:
  serviceAccountPath: "my-project-apigee-non-prod.json"

udca:
  serviceAccountPath: "my-project-apigee-non-prod.json"

watcher:
  serviceAccountPath: "my-project-apigee-non-prod.json"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: my-project-apigee-non-prod.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable Description

UNIQUE_INSTANCE_ IDENTIFIER

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

Vous pouvez créer plusieurs organisations dans le même cluster, mais le instanceID doit être identique pour toutes les organisations du même cluster Kubernetes.

Consultez instanceID.

APIGEE_NAMESPACE

Espace de noms Kubernetes pour vos composants Apigee hybrid.

La valeur par défaut est apigee.

Consultez namespace.

PROJECT_ID

Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement PROJECT_ID.

Consultez gcp.projectID.

ANALYTICS_REGION

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement ANALYTICS_REGION.

Consultez gcp.region.

CLUSTER_NAME

Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement CLUSTER_NAME.

Consultez k8sCluster.name.

CLUSTER_LOCATION

La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster.

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement CLUSTER_LOCATION.

Consultez k8sCluster.location.

ORG_NAME

ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement ORG_NAME.

Consultez org.

CONTROL_PLANE_ LOCATION

Consultez contractProvider.

ENVIRONMENT_NAME

Consultez envs[].name.

ENVIRONMENT_GROUP_ NAME

Consultez virtualhosts[].name.

INGRESS_NAME

Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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.

Consultez les pages suivantes :

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consultez les pages suivantes :

SVC_ANNOTATIONS_ KEY : SVC_ANNOTATIONS_ VALUE

Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées.

Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas.

Consultez ingressGateways[].svcAnnotations.

<component>_ SERVICE_ACCOUNT_ FILEPATH

Si le fichier my-project-apigee-synchronizer.json se trouve dans le répertoire de chart apigee-env/, il vous suffit de fournir le nom du fichier, par exemple :
```
synchronizer:  "FILE_NAME.json"
```
Si le fichier se trouve dans un répertoire apigee-env/service-accounts/, vous devez spécifier un chemin d'accès relatif :
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Pour les environnements hors production, le nom du compte de service unique, PROJECT_ID-non-prod.json par défaut.

Vous pouvez voir les fichiers du compte de service dans chaque répertoire de chart correspondant.

Les noms par défaut des répertoires de charts correspondants pour les comptes de service sont les suivants :

Production

Nom du fichier du compte de service	Répertoire de chart
`PROJECT_ID-apigee-cassandra.json`	`apigee-datastore/`
`PROJECT_ID-apigee-mart.json`	`apigee-org/`
`PROJECT_ID-apigee-metrics.json`	`apigee-telemetry/`
`PROJECT_ID-apigee-mint-task-scheduler.json`	`apigee-org/`
`PROJECT_ID-apigee-runtime.json`	`apigee-env/`
`PROJECT_ID-apigee-synchronizer.json`	`apigee-env/`
`PROJECT_ID-apigee-udca.json`	`apigee-org/`
`PROJECT_ID-apigee-watcher.json`	`apigee-org/`

Hors production

Nom du fichier du compte de service	Répertoire de chart
`PROJECT_ID-non-prod.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Remarque : mart et connectAgent utilisent le compte de service apigee-mart.

Consultez les pages suivantes :

Vault

Production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountSecretProviderClass: apigee-envsakeys-prod-env-spc

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: true

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

Hors production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountSecretProviderClass: apigee-envsakeys-test-env-spc

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: true

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# for message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

WIF pour GKE

Production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: true

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  gsa:
    synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_EMAIL
      # For example: "apigee-synchronizer@PROJECT_ID.iam.gserviceaccount.com"
    runtime: RUNTIME_SERVICE_ACCOUNT_EMAIL
      # For example: "apigee-runtime@PROJECT_ID.iam.gserviceaccount.com"
    udca: UDCA_SERVICE_ACCOUNT_EMAIL
      # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.
  backup:
    enabled: true # Required to create the Cassandra Kubernetes service accounts
                  # for Workload Identity Federation for GKE
                  # See Cassandra backup overview.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  gsa: MART_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com"

connectAgent:
  gsa: MART_SERVICE_ACCOUNT_EMAIL
    # Use the same service account email for mart and connectAgent
    # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com"

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  gsa: LOGGER_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-logger@PROJECT_ID.iam.gserviceaccount.com"

metrics:
  gsa: METRICS_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-metrics@PROJECT_ID.iam.gserviceaccount.com"

udca:
  gsa: UDCA_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com"

watcher:
  gsa: WATCHER_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-watcher@PROJECT_ID.iam.gserviceaccount.com"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  gsa: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-mint-task-scheduler@PROJECT_ID.iam.gserviceaccount.com"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ EMAIL`	Adresses e-mail des comptes de service Google que vous devez fournir si vous utilisez Workload Identity Federation for GKE. Il s'agit des comptes de service que vous avez créés à l'Étape 4 : Créer des comptes de service. Vous pouvez trouver les adresses e-mail des comptes de service à l'aide de la commande suivante : gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee" Consultez les pages suivantes : `envs[].gsa.synchronizer`. `envs[].gsa.runtime`. `envs[].gsa.udca`. `logger.gsa`. `connectAgent.gsa`. `mart.gsa`. `metrics.gsa`. `mintTaskScheduler.gsa`. `udca.serviceAccountRef`. `watcher.gsa`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: true

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  gsa:
    synchronizer: "apigee-synchronizer@my-project.iam.gserviceaccount.com"
    runtime: "apigee-runtime@my-project.iam.gserviceaccount.com"
    udca: "apigee-udca@my-project.iam.gserviceaccount.com"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  gsa: "apigee-mart@my-project.iam.gserviceaccount.com"

connectAgent:
  gsa: "apigee-mart@my-project.iam.gserviceaccount.com"

logger:
  enabled: true
  gsa: "apigee-logger@my-project.iam.gserviceaccount.com"

metrics:
  gsa: "apigee-metrics@my-project.iam.gserviceaccount.com"

udca:
  gsa: "apigee-udca@my-project.iam.gserviceaccount.com"

watcher:
  gsa: "apigee-watcher@my-project.iam.gserviceaccount.com"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: my-project-apigee-mint-task-scheduler.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ EMAIL`	Adresses e-mail des comptes de service Google que vous devez fournir si vous utilisez Workload Identity Federation for GKE. Il s'agit des comptes de service que vous avez créés à l'Étape 4 : Créer des comptes de service. Vous pouvez trouver les adresses e-mail des comptes de service à l'aide de la commande suivante : gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee" Consultez les pages suivantes : `envs[].gsa.synchronizer`. `envs[].gsa.runtime`. `envs[].gsa.udca`. `logger.gsa`. `connectAgent.gsa`. `mart.gsa`. `metrics.gsa`. `mintTaskScheduler.gsa`. `udca.serviceAccountRef`. `watcher.gsa`.

Hors production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: true
    gsa: "NON_PROD_SERVICE_ACCOUNT_EMAIL"
    # For example: "apigee-non-prod@PROJECT_ID.iam.gserviceaccount.com"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`NON_PROD_ SERVICE_ACCOUNT_ EMAIL`	Adresses e-mail des comptes de service Google non destinés à la production. Il s'agit du compte de service `apigee-non-prod` que vous avez créé à l'étape 4 : Créer des comptes de service. Si vous utilisez Workload Identity Federation for GKE dans une installation non destinée à la production, spécifiez l'adresse e-mail du compte de service pour la propriété `gcp.workloadIdentity.gsa`. Vous n'aurez pas besoin d'ajouter la propriété `gsa` pour chaque composant individuel. Vous pouvez trouver les adresses e-mail des comptes de service à l'aide de la commande suivante : gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee" Consultez `gcp.workloadIdentity.gsa`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: true
    gsa: "apigee-non-prod@my-project.iam.gserviceaccount.com"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: true

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`NON_PROD_ SERVICE_ACCOUNT_ EMAIL`	Adresses e-mail des comptes de service Google non destinés à la production. Il s'agit du compte de service `apigee-non-prod` que vous avez créé à l'étape 4 : Créer des comptes de service. Si vous utilisez Workload Identity Federation for GKE dans une installation non destinée à la production, spécifiez l'adresse e-mail du compte de service pour la propriété `gcp.workloadIdentity.gsa`. Vous n'aurez pas besoin d'ajouter la propriété `gsa` pour chaque composant individuel. Vous pouvez trouver les adresses e-mail des comptes de service à l'aide de la commande suivante : gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee" Consultez `gcp.workloadIdentity.gsa`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

WIF sur d'autres plates-formes

WIF : secrets

Production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretRefs:
    synchronizer: SYNCHRONIZER_WORKLOAD_IDENTITY_SECRET
      # For example: "synchronizer-workload-identity-secret"
    runtime: RUNTIME_WORKLOAD_IDENTITY_SECRET
      # For example: "runtime-workload-identity-secret"
    udca: UDCA_WORKLOAD_IDENTITY_SECRET
      # For example: "udca-workload-identity-secret"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountPath: MART_WORKLOAD_IDENTITY_SECRET
    # For example: "mart-workload-identity-secret"

connectAgent:
  serviceAccountPath: MART_WORKLOAD_IDENTITY_SECRET
    # Use the same secret for mart and connectAgent
    # For example: "mart-workload-identity-secret"

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, create a
    # Kubernetes secret for apigee-logger by following the steps
    # under Kubernetes secrets in
    # Step 5: Set up service account authentication.
    # Provide a reference to the secret with the
    # logger.serviceAccountRef property.

metrics:
  serviceAccountPath: METRICS_WORKLOAD_IDENTITY_SECRET
    # For example: "metrics-workload-identity-secret"

udca:
  serviceAccountPath: UDCA_WORKLOAD_IDENTITY_SECRET
    # For example: "udca-workload-identity-secret"

watcher:
  serviceAccountPath: WATCHER_WORKLOAD_IDENTITY_SECRET
    # For example: "watcher-workload-identity-secret"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountRef: MINT_TASK_SCHEDULER_WORKLOAD_IDENTITY_SECRET
    # For example: "apigee-mint-task-scheduler-workload-identity-secret"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`AUDIENCE`	Audience autorisée du fournisseur d'identité de charge de travail. Pour trouver la valeur, recherchez le terme `audience:` dans l'un des fichiers de configuration des identifiants. La valeur de l'audience est la même dans chaque fichier de configuration des identifiants. Par exemple, dans l'exemple de fichier `apigee-udca-credential-configuration.json` suivant : { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } La valeur de l'audience se présente comme suit (sans saut de ligne) : "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Conseil : Vous pouvez supprimer les fichiers de configuration des identifiants après avoir copié la valeur de l'audience. Consultez `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ WORKLOAD_IDENTITY_ SECRET`	Nom du secret Kubernetes que vous avez créé pour la configuration des identifiants du compte de service dans Étape 5 : Configurer l'authentification du compte de service. Les noms par défaut des secrets suggérés dans ce guide sont les suivants : Production `cassandra-workload-identity-secret` `logger-workload-identity-secret` `mart-workload-identity-secret` `metrics-workload-identity-secret` `mint-task-scheduler-workload-identity-secret` `runtime-workload-identity-secret` `synchronizer-workload-identity-secret` `udca-workload-identity-secret` `watcher-workload-identity-secret` Hors production `non-prod-workload-identity-secret` Consultez les pages suivantes : `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountSecretRefs:
    synchronizer: "synchronizer-workload-identity-secret"
    runtime: "runtime-workload-identity-secret"
    udca: "udca-workload-identity-secret"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountRef: "mart-workload-identity-secret"

connectAgent:
  serviceAccountRef: "mart-workload-identity-secret"

logger:
  enabled: false

metrics:
  serviceAccountRef: "metrics-workload-identity-secret"

udca:
  serviceAccountRef: "udca-workload-identity-secret"

watcher:
  serviceAccountRef: "watcher-workload-identity-secret"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountRef: "apigee-mint-task-scheduler-workload-identity-secret"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`AUDIENCE`	Audience autorisée du fournisseur d'identité de charge de travail. Pour trouver la valeur, recherchez le terme `audience:` dans l'un des fichiers de configuration des identifiants. La valeur de l'audience est la même dans chaque fichier de configuration des identifiants. Par exemple, dans l'exemple de fichier `apigee-udca-credential-configuration.json` suivant : { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } La valeur de l'audience se présente comme suit (sans saut de ligne) : "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Conseil : Vous pouvez supprimer les fichiers de configuration des identifiants après avoir copié la valeur de l'audience. Consultez `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ WORKLOAD_IDENTITY_ SECRET`	Nom du secret Kubernetes que vous avez créé pour la configuration des identifiants du compte de service dans Étape 5 : Configurer l'authentification du compte de service. Les noms par défaut des secrets suggérés dans ce guide sont les suivants : Production `cassandra-workload-identity-secret` `logger-workload-identity-secret` `mart-workload-identity-secret` `metrics-workload-identity-secret` `mint-task-scheduler-workload-identity-secret` `runtime-workload-identity-secret` `synchronizer-workload-identity-secret` `udca-workload-identity-secret` `watcher-workload-identity-secret` Hors production `non-prod-workload-identity-secret` Consultez les pages suivantes : `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Hors production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretRefs:
    synchronizer: NON_PROD_WORKLOAD_IDENTITY_SECRET
      # For example: "non-prod-workload-identity-secret"
    runtime: NON_PROD_WORKLOAD_IDENTITY_SECRET
      # For example: "non-prod-workload-identity-secret"
    udca: NON_PROD_WORKLOAD_IDENTITY_SECRET
      # For example: "non-prod-workload-identity-secret"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

connectAgent:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # Use the same secret for mart and connectAgent
    # For example: "non-prod-workload-identity-secret"

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, create a
    # Kubernetes secret for apigee-logger by following the steps
    # under Kubernetes secrets in
    # Step 5: Set up service account authentication.
    # Provide a reference to the secret with the
    # logger.serviceAccountRef property.

metrics:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

udca:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

watcher:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`AUDIENCE`	Audience autorisée du fournisseur d'identité de charge de travail. Pour trouver la valeur, recherchez le terme `audience:` dans l'un des fichiers de configuration des identifiants. La valeur de l'audience est la même dans chaque fichier de configuration des identifiants. Par exemple, dans l'exemple de fichier `apigee-udca-credential-configuration.json` suivant : { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } La valeur de l'audience se présente comme suit (sans saut de ligne) : "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Conseil : Vous pouvez supprimer les fichiers de configuration des identifiants après avoir copié la valeur de l'audience. Consultez `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ WORKLOAD_IDENTITY_ SECRET`	Nom du secret Kubernetes que vous avez créé pour la configuration des identifiants du compte de service dans Étape 5 : Configurer l'authentification du compte de service. Les noms par défaut des secrets suggérés dans ce guide sont les suivants : Production `cassandra-workload-identity-secret` `logger-workload-identity-secret` `mart-workload-identity-secret` `metrics-workload-identity-secret` `mint-task-scheduler-workload-identity-secret` `runtime-workload-identity-secret` `synchronizer-workload-identity-secret` `udca-workload-identity-secret` `watcher-workload-identity-secret` Hors production `non-prod-workload-identity-secret` Consultez les pages suivantes : `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountSecretRefs:
    synchronizer: "non-prod-workload-identity-secret"
    runtime: "non-prod-workload-identity-secret"
    udca: "non-prod-workload-identity-secret"

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountRef: "non-prod-workload-identity-secret"

connectAgent:
  serviceAccountRef: "non-prod-workload-identity-secret"

logger:
  enabled: false

metrics:
  serviceAccountRef: "non-prod-workload-identity-secret"

udca:
  serviceAccountRef: "non-prod-workload-identity-secret"

watcher:
  serviceAccountRef: "non-prod-workload-identity-secret"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountRef: "non-prod-workload-identity-secret"

# for message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`AUDIENCE`	Audience autorisée du fournisseur d'identité de charge de travail. Pour trouver la valeur, recherchez le terme `audience:` dans l'un des fichiers de configuration des identifiants. La valeur de l'audience est la même dans chaque fichier de configuration des identifiants. Par exemple, dans l'exemple de fichier `apigee-udca-credential-configuration.json` suivant : { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } La valeur de l'audience se présente comme suit (sans saut de ligne) : "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Conseil : Vous pouvez supprimer les fichiers de configuration des identifiants après avoir copié la valeur de l'audience. Consultez `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.
`<component>_ WORKLOAD_IDENTITY_ SECRET`	Nom du secret Kubernetes que vous avez créé pour la configuration des identifiants du compte de service dans Étape 5 : Configurer l'authentification du compte de service. Les noms par défaut des secrets suggérés dans ce guide sont les suivants : Production `cassandra-workload-identity-secret` `logger-workload-identity-secret` `mart-workload-identity-secret` `metrics-workload-identity-secret` `mint-task-scheduler-workload-identity-secret` `runtime-workload-identity-secret` `synchronizer-workload-identity-secret` `udca-workload-identity-secret` `watcher-workload-identity-secret` Hors production `non-prod-workload-identity-secret` Consultez les pages suivantes : `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

WIF : fichiers

Production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    # Provide the path relative to the apigee-env chart directory.
    synchronizer: SYNCHRONIZER_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-synchronizer-credential-configuration.json"
    runtime: RUNTIME_SERVICE_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-runtime-credential-configuration.json"
    udca: UDCA_SERVICE_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-udca-credential-configuration.json"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE installations.
    # Set to true  for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift
    # installations. See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountPath: MART_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-mart-credential-configuration.json"

connectAgent:
  serviceAccountPath: MART_CREDENTIAL_CONFIGURATION_FILEPATH
    # Use the same service account for mart and connectAgent
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-mart-credential-configuration.json"

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, provide
    # the path to the apigee-logger service account key file with
    # the logger.serviceAccountPath property.

metrics:
  serviceAccountPath: METRICS_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-metrics-credential-configuration.json"

udca:
  serviceAccountPath: UDCA_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-udca-credential-configuration.json"

watcher:
  serviceAccountPath: WATCHER_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-watcher-credential-configuration.json"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountPath: MINT_TASK_SCHEDULER_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-mint-task-scheduler-credential-configuration.json"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable Description

UNIQUE_INSTANCE_ IDENTIFIER

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

Vous pouvez créer plusieurs organisations dans le même cluster, mais le instanceID doit être identique pour toutes les organisations du même cluster Kubernetes.

Consultez instanceID.

APIGEE_NAMESPACE

Espace de noms Kubernetes pour vos composants Apigee hybrid.

La valeur par défaut est apigee.

Consultez namespace.

PROJECT_ID

Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement PROJECT_ID.

Consultez gcp.projectID.

ANALYTICS_REGION

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement ANALYTICS_REGION.

Consultez gcp.region.

AUDIENCE

Audience autorisée du fournisseur d'identité de charge de travail. Pour trouver la valeur, recherchez le terme audience: dans l'un des fichiers de configuration des identifiants. La valeur de l'audience est la même dans chaque fichier de configuration des identifiants.

Par exemple, dans l'exemple de fichier apigee-udca-credential-configuration.json suivant :

{
  "universe_domain": "googleapis.com",
  "type": "external_account:,"
  "audience": "AUDIENCE",
  "subject_token_type": "TOKEN_TYPE",
  "token_url": "TOKEN_URL",
  "service
  "impersonation_url": "IMPERSONATION_URL",
  "credential_source": {
    "file": "FILE_PATH",
    "format": {
      "type": "text"
    }
  }
}

La valeur de l'audience se présente comme suit (sans saut de ligne) :

"//iam.googleapis.com/projects/123456789012/
locations/global/workloadIdentityPools/
POOL_ID/providers/WORKLOAD_PROVIDER_ID"

Consultez gcp.federatedWorkloadIdentity.audience.

CLUSTER_NAME

Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement CLUSTER_NAME.

Consultez k8sCluster.name.

CLUSTER_LOCATION

La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster.

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement CLUSTER_LOCATION.

Consultez k8sCluster.location.

ORG_NAME

ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement ORG_NAME.

Consultez org.

CONTROL_PLANE_ LOCATION

Consultez contractProvider.

ENVIRONMENT_NAME

Consultez envs[].name.

ENVIRONMENT_GROUP_ NAME

Consultez virtualhosts[].name.

INGRESS_NAME

Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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.

Consultez les pages suivantes :

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consultez les pages suivantes :

SVC_ANNOTATIONS_ KEY : SVC_ANNOTATIONS_ VALUE

Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées.

Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas.

Consultez ingressGateways[].svcAnnotations.

<component>_ CREDENTIAL_ CONFIGURATION_ FILEPATH

Chemin d'accès et compte de nom de fichier des fichiers de configuration des identifiants que vous avez créés à l'Étape 5 : Configurer l'authentification du compte de service.

Indiquez les noms en indiquant le chemin d'accès relatif au répertoire de chart. Exemple :

Si le fichier apigee-synchronizer-credential-configuration.json se trouve dans le répertoire de chart apigee-env/, il vous suffit de fournir le nom du fichier, par exemple :
```
synchronizer:  "FILE_NAME.json"
```
Si le fichier se trouve dans un répertoire apigee-env/service-accounts/, vous devez spécifier un chemin d'accès relatif :
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Les noms par défaut des répertoires de charts correspondants pour les comptes de service sont les suivants :

Production

Nom du fichier du compte de service	Répertoire de chart
`apigee-cassandra-credential-configuration.json`	`apigee-datastore/`
`apigee-logger-credential-configuration.json`	`apigee-telemetry/`
`apigee-mart-credential-configuration.json`	`apigee-org/`
`apigee-metrics-credential-configuration.json`	`apigee-telemetry/`
`apigee-mint-task-scheduler-credential-configuration.json`	`apigee-org/`
`apigee-runtime-credential-configuration.json`	`apigee-env/`
`apigee-synchronizer-credential-configuration.json`	`apigee-env/`
`apigee-udca-credential-configuration.json`	`apigee-org/`
`apigee-watcher-credential-configuration.json`	`apigee-org/`

Hors production

Nom du fichier du compte de service	Répertoire de chart
`apigee-non-prod-credential-configuration.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Remarque : mart et connectAgent utilisent le compte de service apigee-mart.

Consultez les pages suivantes :

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountPaths:
    synchronizer: "apigee-synchronizer-credential-configuration.json"
    runtime: "apigee-runtime-credential-configuration.json"
    udca: "apigee-udca-credential-configuration.json"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountPath: "apigee-mart-credential-configuration.json"

connectAgent:
  serviceAccountPath: "apigee-mart-credential-configuration.json"

logger:
  enabled: false

metrics:
  serviceAccountPath: "apigee-metrics-credential-configuration.json"

udca:
  serviceAccountPath: "apigee-udca-credential-configuration.json"

watcher:
  serviceAccountPath: "apigee-watcher-credential-configuration.json"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: apigee-mint-task-scheduler-credential-configuration.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable Description

UNIQUE_INSTANCE_ IDENTIFIER

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

Vous pouvez créer plusieurs organisations dans le même cluster, mais le instanceID doit être identique pour toutes les organisations du même cluster Kubernetes.

Consultez instanceID.

APIGEE_NAMESPACE

Espace de noms Kubernetes pour vos composants Apigee hybrid.

La valeur par défaut est apigee.

Consultez namespace.

PROJECT_ID

Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement PROJECT_ID.

Consultez gcp.projectID.

ANALYTICS_REGION

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement ANALYTICS_REGION.

Consultez gcp.region.

AUDIENCE

Par exemple, dans l'exemple de fichier apigee-udca-credential-configuration.json suivant :

{
  "universe_domain": "googleapis.com",
  "type": "external_account:,"
  "audience": "AUDIENCE",
  "subject_token_type": "TOKEN_TYPE",
  "token_url": "TOKEN_URL",
  "service
  "impersonation_url": "IMPERSONATION_URL",
  "credential_source": {
    "file": "FILE_PATH",
    "format": {
      "type": "text"
    }
  }
}

La valeur de l'audience se présente comme suit (sans saut de ligne) :

"//iam.googleapis.com/projects/123456789012/
locations/global/workloadIdentityPools/
POOL_ID/providers/WORKLOAD_PROVIDER_ID"

Consultez gcp.federatedWorkloadIdentity.audience.

CLUSTER_NAME

Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement CLUSTER_NAME.

Consultez k8sCluster.name.

CLUSTER_LOCATION

La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster.

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement CLUSTER_LOCATION.

Consultez k8sCluster.location.

ORG_NAME

ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement ORG_NAME.

Consultez org.

CONTROL_PLANE_ LOCATION

Consultez contractProvider.

ENVIRONMENT_NAME

Consultez envs[].name.

ENVIRONMENT_GROUP_ NAME

Consultez virtualhosts[].name.

INGRESS_NAME

Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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.

Consultez les pages suivantes :

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consultez les pages suivantes :

SVC_ANNOTATIONS_ KEY : SVC_ANNOTATIONS_ VALUE

Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées.

Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas.

Consultez ingressGateways[].svcAnnotations.

<component>_ CREDENTIAL_ CONFIGURATION_ FILEPATH

Chemin d'accès et compte de nom de fichier des fichiers de configuration des identifiants que vous avez créés à l'Étape 5 : Configurer l'authentification du compte de service.

Indiquez les noms en indiquant le chemin d'accès relatif au répertoire de chart. Exemple :

Si le fichier apigee-synchronizer-credential-configuration.json se trouve dans le répertoire de chart apigee-env/, il vous suffit de fournir le nom du fichier, par exemple :
```
synchronizer:  "FILE_NAME.json"
```
Si le fichier se trouve dans un répertoire apigee-env/service-accounts/, vous devez spécifier un chemin d'accès relatif :
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Les noms par défaut des répertoires de charts correspondants pour les comptes de service sont les suivants :

Production

Nom du fichier du compte de service	Répertoire de chart
`apigee-cassandra-credential-configuration.json`	`apigee-datastore/`
`apigee-logger-credential-configuration.json`	`apigee-telemetry/`
`apigee-mart-credential-configuration.json`	`apigee-org/`
`apigee-metrics-credential-configuration.json`	`apigee-telemetry/`
`apigee-mint-task-scheduler-credential-configuration.json`	`apigee-org/`
`apigee-runtime-credential-configuration.json`	`apigee-env/`
`apigee-synchronizer-credential-configuration.json`	`apigee-env/`
`apigee-udca-credential-configuration.json`	`apigee-org/`
`apigee-watcher-credential-configuration.json`	`apigee-org/`

Hors production

Nom du fichier du compte de service	Répertoire de chart
`apigee-non-prod-credential-configuration.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Remarque : mart et connectAgent utilisent le compte de service apigee-mart.

Consultez les pages suivantes :

Hors production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    # Provide the path relative to the apigee-env chart directory.
    synchronizer: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-non-prod-credential-configuration.json"
    runtime: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-non-prod-credential-configuration.json"
    udca: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-non-prod-credential-configuration.json"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

connectAgent:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Use the same service account for mart and connectAgent
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, provide
    # the path to the apigee-non-prod service account key file with
    # the logger.serviceAccountPath property.

metrics:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

udca:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

watcher:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable Description

UNIQUE_INSTANCE_ IDENTIFIER

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

Vous pouvez créer plusieurs organisations dans le même cluster, mais le instanceID doit être identique pour toutes les organisations du même cluster Kubernetes.

Consultez instanceID.

APIGEE_NAMESPACE

Espace de noms Kubernetes pour vos composants Apigee hybrid.

La valeur par défaut est apigee.

Consultez namespace.

PROJECT_ID

Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement PROJECT_ID.

Consultez gcp.projectID.

ANALYTICS_REGION

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement ANALYTICS_REGION.

Consultez gcp.region.

AUDIENCE

Par exemple, dans l'exemple de fichier apigee-udca-credential-configuration.json suivant :

{
  "universe_domain": "googleapis.com",
  "type": "external_account:,"
  "audience": "AUDIENCE",
  "subject_token_type": "TOKEN_TYPE",
  "token_url": "TOKEN_URL",
  "service
  "impersonation_url": "IMPERSONATION_URL",
  "credential_source": {
    "file": "FILE_PATH",
    "format": {
      "type": "text"
    }
  }
}

La valeur de l'audience se présente comme suit (sans saut de ligne) :

"//iam.googleapis.com/projects/123456789012/
locations/global/workloadIdentityPools/
POOL_ID/providers/WORKLOAD_PROVIDER_ID"

Consultez gcp.federatedWorkloadIdentity.audience.

CLUSTER_NAME

Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement CLUSTER_NAME.

Consultez k8sCluster.name.

CLUSTER_LOCATION

La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster.

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement CLUSTER_LOCATION.

Consultez k8sCluster.location.

ORG_NAME

ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement ORG_NAME.

Consultez org.

CONTROL_PLANE_ LOCATION

Consultez contractProvider.

ENVIRONMENT_NAME

Consultez envs[].name.

ENVIRONMENT_GROUP_ NAME

Consultez virtualhosts[].name.

INGRESS_NAME

Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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.

Consultez les pages suivantes :

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consultez les pages suivantes :

SVC_ANNOTATIONS_ KEY : SVC_ANNOTATIONS_ VALUE

Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées.

Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas.

Consultez ingressGateways[].svcAnnotations.

<component>_ CREDENTIAL_ CONFIGURATION_ FILEPATH

Chemin d'accès et compte de nom de fichier des fichiers de configuration des identifiants que vous avez créés à l'Étape 5 : Configurer l'authentification du compte de service.

Indiquez les noms en indiquant le chemin d'accès relatif au répertoire de chart. Exemple :

Si le fichier apigee-synchronizer-credential-configuration.json se trouve dans le répertoire de chart apigee-env/, il vous suffit de fournir le nom du fichier, par exemple :
```
synchronizer:  "FILE_NAME.json"
```
Si le fichier se trouve dans un répertoire apigee-env/service-accounts/, vous devez spécifier un chemin d'accès relatif :
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Les noms par défaut des répertoires de charts correspondants pour les comptes de service sont les suivants :

Production

Nom du fichier du compte de service	Répertoire de chart
`apigee-cassandra-credential-configuration.json`	`apigee-datastore/`
`apigee-logger-credential-configuration.json`	`apigee-telemetry/`
`apigee-mart-credential-configuration.json`	`apigee-org/`
`apigee-metrics-credential-configuration.json`	`apigee-telemetry/`
`apigee-mint-task-scheduler-credential-configuration.json`	`apigee-org/`
`apigee-runtime-credential-configuration.json`	`apigee-env/`
`apigee-synchronizer-credential-configuration.json`	`apigee-env/`
`apigee-udca-credential-configuration.json`	`apigee-org/`
`apigee-watcher-credential-configuration.json`	`apigee-org/`

Hors production

Nom du fichier du compte de service	Répertoire de chart
`apigee-non-prod-credential-configuration.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Remarque : mart et connectAgent utilisent le compte de service apigee-mart.

Consultez les pages suivantes :

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountPaths:
    synchronizer: "apigee-non-prod-credential-configuration.json"
    runtime: "apigee-non-prod-credential-configuration.json<"
    udca: "apigee-non-prod-credential-configuration.json"

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

connectAgent:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

logger:
  enabled: false

metrics:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

udca:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

watcher:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: apigee-non-prod-credential-configuration.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable Description

UNIQUE_INSTANCE_ IDENTIFIER

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

Vous pouvez créer plusieurs organisations dans le même cluster, mais le instanceID doit être identique pour toutes les organisations du même cluster Kubernetes.

Consultez instanceID.

APIGEE_NAMESPACE

Espace de noms Kubernetes pour vos composants Apigee hybrid.

La valeur par défaut est apigee.

Consultez namespace.

PROJECT_ID

Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement PROJECT_ID.

Consultez gcp.projectID.

ANALYTICS_REGION

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement ANALYTICS_REGION.

Consultez gcp.region.

AUDIENCE

Par exemple, dans l'exemple de fichier apigee-udca-credential-configuration.json suivant :

{
  "universe_domain": "googleapis.com",
  "type": "external_account:,"
  "audience": "AUDIENCE",
  "subject_token_type": "TOKEN_TYPE",
  "token_url": "TOKEN_URL",
  "service
  "impersonation_url": "IMPERSONATION_URL",
  "credential_source": {
    "file": "FILE_PATH",
    "format": {
      "type": "text"
    }
  }
}

La valeur de l'audience se présente comme suit (sans saut de ligne) :

"//iam.googleapis.com/projects/123456789012/
locations/global/workloadIdentityPools/
POOL_ID/providers/WORKLOAD_PROVIDER_ID"

Consultez gcp.federatedWorkloadIdentity.audience.

CLUSTER_NAME

Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement CLUSTER_NAME.

Consultez k8sCluster.name.

CLUSTER_LOCATION

La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster.

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement CLUSTER_LOCATION.

Consultez k8sCluster.location.

ORG_NAME

ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement ORG_NAME.

Consultez org.

CONTROL_PLANE_ LOCATION

Consultez contractProvider.

ENVIRONMENT_NAME

Consultez envs[].name.

ENVIRONMENT_GROUP_ NAME

Consultez virtualhosts[].name.

INGRESS_NAME

Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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.

Consultez les pages suivantes :

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consultez les pages suivantes :

SVC_ANNOTATIONS_ KEY : SVC_ANNOTATIONS_ VALUE

Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées.

Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas.

Consultez ingressGateways[].svcAnnotations.

<component>_ CREDENTIAL_ CONFIGURATION_ FILEPATH

Chemin d'accès et compte de nom de fichier des fichiers de configuration des identifiants que vous avez créés à l'Étape 5 : Configurer l'authentification du compte de service.

Indiquez les noms en indiquant le chemin d'accès relatif au répertoire de chart. Exemple :

Si le fichier apigee-synchronizer-credential-configuration.json se trouve dans le répertoire de chart apigee-env/, il vous suffit de fournir le nom du fichier, par exemple :
```
synchronizer:  "FILE_NAME.json"
```
Si le fichier se trouve dans un répertoire apigee-env/service-accounts/, vous devez spécifier un chemin d'accès relatif :
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Les noms par défaut des répertoires de charts correspondants pour les comptes de service sont les suivants :

Production

Nom du fichier du compte de service	Répertoire de chart
`apigee-cassandra-credential-configuration.json`	`apigee-datastore/`
`apigee-logger-credential-configuration.json`	`apigee-telemetry/`
`apigee-mart-credential-configuration.json`	`apigee-org/`
`apigee-metrics-credential-configuration.json`	`apigee-telemetry/`
`apigee-mint-task-scheduler-credential-configuration.json`	`apigee-org/`
`apigee-runtime-credential-configuration.json`	`apigee-env/`
`apigee-synchronizer-credential-configuration.json`	`apigee-env/`
`apigee-udca-credential-configuration.json`	`apigee-org/`
`apigee-watcher-credential-configuration.json`	`apigee-org/`

Hors production

Nom du fichier du compte de service	Répertoire de chart
`apigee-non-prod-credential-configuration.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Remarque : mart et connectAgent utilisent le compte de service apigee-mart.

Consultez les pages suivantes :

WIF: Vault

Production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, add
    # a "logger" : "value" entry in the orgsakeys vault secret
    # using the contents of the apigee-logger key file for the
    # value. See Step 5: Set up service account authentication.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`AUDIENCE`	Audience autorisée du fournisseur d'identité de charge de travail. Pour trouver la valeur, recherchez le terme `audience:` dans l'un des fichiers de configuration des identifiants. La valeur de l'audience est la même dans chaque fichier de configuration des identifiants. Par exemple, dans l'exemple de fichier `apigee-udca-credential-configuration.json` suivant : { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } La valeur de l'audience se présente comme suit (sans saut de ligne) : "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Conseil : Vous pouvez supprimer les fichiers de configuration des identifiants après avoir copié la valeur de l'audience. Consultez `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountSecretProviderClass: apigee-envsakeys-prod-env-spc

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: false

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`AUDIENCE`	Audience autorisée du fournisseur d'identité de charge de travail. Pour trouver la valeur, recherchez le terme `audience:` dans l'un des fichiers de configuration des identifiants. La valeur de l'audience est la même dans chaque fichier de configuration des identifiants. Par exemple, dans l'exemple de fichier `apigee-udca-credential-configuration.json` suivant : { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } La valeur de l'audience se présente comme suit (sans saut de ligne) : "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Conseil : Vous pouvez supprimer les fichiers de configuration des identifiants après avoir copié la valeur de l'audience. Consultez `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

Hors production

Modèle

Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Vous pouvez modifier leurs valeurs sur cette page. Elles sont décrites dans le tableau ci-dessous.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, add
    # a "logger" : "value" entry in the orgsakeys vault secret
    # using the contents of the apigee-non-prod key file for the
    # value. See Step 5: Set up service account authentication.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`AUDIENCE`	Audience autorisée du fournisseur d'identité de charge de travail. Pour trouver la valeur, recherchez le terme `audience:` dans l'un des fichiers de configuration des identifiants. La valeur de l'audience est la même dans chaque fichier de configuration des identifiants. Par exemple, dans l'exemple de fichier `apigee-udca-credential-configuration.json` suivant : { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } La valeur de l'audience se présente comme suit (sans saut de ligne) : "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Conseil : Vous pouvez supprimer les fichiers de configuration des identifiants après avoir copié la valeur de l'audience. Consultez `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

Exemple

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountSecretProviderClass: apigee-envsakeys-test-env-spc

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: false

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# for message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Variable	Description
`UNIQUE_INSTANCE_ IDENTIFIER`	Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères). Remarque : Vous pouvez créer plusieurs organisations dans le même cluster, mais `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Pour les installations multirégionales, chaque région nécessite son propre cluster (les clusters individuels ne couvrent pas les régions). Vous pouvez créer plusieurs organisations dans le même cluster, mais le `instanceID` doit être identique pour toutes les organisations du même cluster Kubernetes. Consultez `instanceID`.
`APIGEE_NAMESPACE`	Espace de noms Kubernetes pour vos composants Apigee hybrid. La valeur par défaut est `apigee`. Consultez `namespace`.
`PROJECT_ID`	Identifie le projet Google Cloud dans lequel `apigee-logger` et `apigee-metrics` envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement `PROJECT_ID`. Consultez `gcp.projectID`.
`ANALYTICS_REGION`	Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 2 : Créer une organisation). Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `ANALYTICS_REGION`. Consultez `gcp.region`.
`AUDIENCE`	Audience autorisée du fournisseur d'identité de charge de travail. Pour trouver la valeur, recherchez le terme `audience:` dans l'un des fichiers de configuration des identifiants. La valeur de l'audience est la même dans chaque fichier de configuration des identifiants. Par exemple, dans l'exemple de fichier `apigee-udca-credential-configuration.json` suivant : { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } La valeur de l'audience se présente comme suit (sans saut de ligne) : "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Conseil : Vous pouvez supprimer les fichiers de configuration des identifiants après avoir copié la valeur de l'audience. Consultez `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement `CLUSTER_NAME`. Consultez `k8sCluster.name`.
`CLUSTER_LOCATION`	La région dans laquelle le cluster est exécuté. Il s'agit de la région dans laquelle vous avez créé le cluster à l'étape 1 : Créer un cluster. Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement `CLUSTER_LOCATION`. Si vous utilisez des clusters zonaux, vous devez spécifier la région dans laquelle votre cluster a été créé. Par exemple, si vous avez créé votre cluster dans la zone `us-central1-a`, spécifiez `us-central1` pour le paramètre `CLUSTER_LOCATION`. Consultez `k8sCluster.location`.
`ORG_NAME`	ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement `ORG_NAME`. Consultez `org`.
`CONTROL_PLANE_ LOCATION`	Obligatoire si vous utilisez la résidence des données avec votre installation Apigee hybrid. Il s'agit de l'emplacement où est stocké le contenu principal du client, tel que les groupes de proxys. Pour obtenir la liste, consultez Régions du plan de contrôle de l'API Apigee disponibles. Il s'agit de la valeur attribuée à la variable d'environnement `CONTROL_PLANE_LOCATION` à l'Étape 2 : Créer une organisation. Consultez `contractProvider`.
`ENVIRONMENT_NAME`	Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l' étape 3 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation. Consultez `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 3 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement `ENV_GROUP`. Remarque : Si vous souhaitez placer des instances de cluster dans plusieurs régions, vous devez prendre garde à la façon dont vous définissez vos environnements et vos hôtes virtuels. Si un ou plusieurs environnements sont associés à un groupe d'environnements, vous devez inclure cette même configuration de groupe d'environnements dans le fichier de remplacement de chaque instance de cluster. Consultez `virtualhosts[].name`.
`INGRESS_NAME`	Nom de la passerelle d'entrée Apigee de votre déploiement. Il peut s'agir de n'importe quel nom qui répond 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. Consultez les pages suivantes : `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Saisissez le chemin d'accès et le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l' Étape 6 : Créer des certificats TLS. Ces fichiers doivent se trouver dans le répertoire `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Exemple : sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consultez les pages suivantes : `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY` : `SVC_ANNOTATIONS_ VALUE`	(Facultatif) Il s'agit d'une paire clé-valeur qui fournit des annotations pour votre service d'entrée par défaut. Votre plate-forme cloud utilise des annotations pour vous aider à configurer votre installation hybride, par exemple pour définir le type d'équilibreur de charge sur interne ou externe. Les annotations varient selon les plates-formes. Reportez-vous à la documentation de votre plate-forme pour connaître les annotations requises et celles suggérées. Remarque : Vous n'avez pas besoin de définir `svcAnnotations` si vous créez votre propre service Kubernetes pour le déploiement d'entrée, comme décrit dans la section Exposer la passerelle d'entrée Apigee. Mettez en commentaire ou supprimez cette section si vous ne l'utilisez pas. Consultez `ingressGateways[].svcAnnotations`.

Résumé

Le fichier de configuration indique à Kubernetes comment déployer les composants hybrides sur un cluster. Vous allez ensuite activer l'accès du synchronisateur pour que les plans d'exécution et de gestion Apigee puissent communiquer.

Étape suivante

1 2 3 4 5 6 7 (SUITE) Étape 8 : Activer l'accès au plan de contrôle 9 10 11

Étape 7 : Créer les remplacements Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Spécifier des remplacements de configuration

Avant de commencer

Configurer le cluster

Secrets Kubernetes

Production

Modèle

Production

Hors production

Exemple

Production

Hors production

Hors production

Modèle

Production

Hors production

Exemple

Production

Hors production

Fichiers JSON

Production

Modèle

Production

Hors production

Exemple

Production

Hors production

Hors production

Modèle

Production

Hors production

Exemple

Production

Hors production

Vault

Production

Modèle

Exemple

Hors production

Modèle

Exemple

WIF pour GKE

Production

Modèle

Exemple

Hors production

Modèle

Exemple

WIF sur d'autres plates-formes

WIF : secrets

Production

Modèle

Production

Hors production

Exemple

Production

Hors production

Hors production

Modèle

Production

Hors production

Exemple

Production

Hors production

WIF : fichiers

Production

Modèle

Production

Hors production

Exemple

Production

Hors production

Hors production

Modèle

Production

Hors production

Exemple

Production

Hors production

WIF: Vault

Étape 7 : Créer les remplacements