Schritt 7: Überschreibungen erstellen

Konfigurationsüberschreibungen festlegen

Das Installationsprogramm von Apigee Hybrid verwendet für viele Einstellungen Standardwerte. Es gibt jedoch einige Einstellungen, die keine Standardeinstellungen haben. Sie müssen für diese Einstellungen wie unten beschrieben Werte angeben.

Hinweis

Anhand der folgenden Szenarien können Sie feststellen, ob Sie Ihren Cluster für diese konfigurieren möchten. Diese Konfigurationen sind optional.

Cluster konfigurieren

Konventionsgemäß werden Konfigurationsüberschreibungen in einer Datei mit dem Namen overrides.yaml geschrieben, die normalerweise in dem Verzeichnis $APIGEE_HELM_CHARTS_HOME gespeichert ist.

  1. Erstellen Sie eine neue Datei mit dem Namen overrides.yaml in Ihrem Verzeichnis $APIGEE_HELM_CHARTS_HOME.

    overrides.yaml stellt die Konfiguration für Ihre spezielle Installation von Apigee Hybrid bereit. Die Datei „overrides“ in diesem Schritt bietet eine einfache Konfiguration für eine Hybrid-Laufzeitinstallation mit geringem Ressourcenbedarf, die für die erste Installation geeignet ist.

  2. Fügen Sie in overrides.yaml die erforderlichen Attributwerte hinzu (siehe unten). Im Folgenden finden Sie eine detaillierte Beschreibung der einzelnen Attribute.

    Ihre Datei overrides.yaml muss die unten aufgeführte Struktur und Syntax haben.

    Wählen Sie den Tab für die Art der Dienstkonto-Authentifizierung aus, die Sie in Ihrer Installation verwenden: Schritt 4: Dienstkonten erstellen.

    • Dienstkontoschlüssel in Kubernetes-Secrets: Kubernetes-Secrets
    • JSON-Schlüsseldateien des Dienstkontos: JSON-Dateien
    • Dienstkontoschlüssel in Vault: Vault
    • Workload Identity Federation for GKE: WIF for GKE
    • Identitätsföderation von Arbeitslasten: WIF auf anderen Plattformen

    Eine Übersicht über die verschiedenen Authentifizierungsoptionen finden Sie unter Authentifizierungsmethoden für Dienstkonten in Apigee Hybrid.

    Wählen Sie je nach Ihrer Auswahl in Schritt 4: Dienstkonten erstellen den Tab für Ihre Installation aus: Produktion (Production) oder Nicht-Produktion (Non-prod) (Demo-, Test- oder Proof-of-Concept-Installationen).

    Informationen zu Installationen in Produktionsumgebungen finden Sie in den Speicheranforderungen für die Cassandra-Datenbank unter Cassandra für die Produktion konfigurieren.

    Kubernetes-Secrets

    Produktion

    Vorlage

    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
    

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    SECRET
    Der Name des Kubernetes-Secrets, das Sie für den Dienstkontoschlüssel in Schritt 5: Dienstkonto-Authentifizierung einrichten erstellt haben.

    Die Standardnamen der in diesem Leitfaden vorgeschlagenen Secrets sind:

    Produktion

    • 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

    Non-prod

    • apigee-non-prod-svc-account

    Weitere Informationen:

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    SECRET
    Der Name des Kubernetes-Secrets, das Sie für den Dienstkontoschlüssel in Schritt 5: Dienstkonto-Authentifizierung einrichten erstellt haben.

    Die Standardnamen der in diesem Leitfaden vorgeschlagenen Secrets sind:

    Produktion

    • 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

    Non-prod

    • apigee-non-prod-svc-account

    Weitere Informationen:

    Non-prod

    Vorlage

    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
    

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    SECRET
    Der Name des Kubernetes-Secrets, das Sie für den Dienstkontoschlüssel in Schritt 5: Dienstkonto-Authentifizierung einrichten erstellt haben.

    Die Standardnamen der in diesem Leitfaden vorgeschlagenen Secrets sind:

    Produktion

    • 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

    Non-prod

    • apigee-non-prod-svc-account

    Weitere Informationen:

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    SECRET
    Der Name des Kubernetes-Secrets, das Sie für den Dienstkontoschlüssel in Schritt 5: Dienstkonto-Authentifizierung einrichten erstellt haben.

    Die Standardnamen der in diesem Leitfaden vorgeschlagenen Secrets sind:

    Produktion

    • 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

    Non-prod

    • apigee-non-prod-svc-account

    Weitere Informationen:

    JSON-Dateien

    Produktion

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    FILEPATH
    Der Pfad und der Dateiname des JSON-Dateien des Dienstkontos in dem entsprechenden Diagrammverzeichnis. Geben Sie die Namen mit dem Pfad relativ zum Diagrammverzeichnis an. Beispiel:
    • Wenn sich die Datei my-project-apigee-synchronizer.json im Diagrammverzeichnis apigee-env/ befindet, müssen Sie nur den Dateinamen angeben, z. B.:
      synchronizer:  "FILE_NAME.json"
    • Wenn sich die Datei in einem apigee-env/service-accounts/-Verzeichnis befindet, müssen Sie einen relativen Pfad angeben:
      synchronizer:  "service-accounts/FILE_NAME.json"

    In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig PROJECT_ID-non-prod.json.

    In Produktionsumgebungen der Name der Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool unter Schritt 4: Dienstkonten erstellen generiert haben.

    Sie können die Dienstkontodateien in den entsprechenden Diagrammverzeichnissen sehen.

    Die Standardnamen der und der entsprechenden Diagrammverzeichnisse für die Dienstkonten sind:

    Produktion

    Dateiname des Dienstkontos Diagrammverzeichnis
    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/

    Non-prod

    Dateiname des Dienstkontos Diagrammverzeichnis
    PROJECT_ID-non-prod.json apigee-datastore/
    apigee-org/
    apigee-telemetry/

    Weitere Informationen:

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    FILEPATH
    Der Pfad und der Dateiname des JSON-Dateien des Dienstkontos in dem entsprechenden Diagrammverzeichnis. Geben Sie die Namen mit dem Pfad relativ zum Diagrammverzeichnis an. Beispiel:
    • Wenn sich die Datei my-project-apigee-synchronizer.json im Diagrammverzeichnis apigee-env/ befindet, müssen Sie nur den Dateinamen angeben, z. B.:
      synchronizer:  "FILE_NAME.json"
    • Wenn sich die Datei in einem apigee-env/service-accounts/-Verzeichnis befindet, müssen Sie einen relativen Pfad angeben:
      synchronizer:  "service-accounts/FILE_NAME.json"

    In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig PROJECT_ID-non-prod.json.

    In Produktionsumgebungen der Name der Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool unter Schritt 4: Dienstkonten erstellen generiert haben.

    Sie können die Dienstkontodateien in den entsprechenden Diagrammverzeichnissen sehen.

    Die Standardnamen der und der entsprechenden Diagrammverzeichnisse für die Dienstkonten sind:

    Produktion

    Dateiname des Dienstkontos Diagrammverzeichnis
    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/

    Non-prod

    Dateiname des Dienstkontos Diagrammverzeichnis
    PROJECT_ID-non-prod.json apigee-datastore/
    apigee-org/
    apigee-telemetry/

    Weitere Informationen:

    Non-prod

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    FILEPATH
    Der Pfad und der Dateiname des JSON-Dateien des Dienstkontos in dem entsprechenden Diagrammverzeichnis. Geben Sie die Namen mit dem Pfad relativ zum Diagrammverzeichnis an. Beispiel:
    • Wenn sich die Datei my-project-apigee-synchronizer.json im Diagrammverzeichnis apigee-env/ befindet, müssen Sie nur den Dateinamen angeben, z. B.:
      synchronizer:  "FILE_NAME.json"
    • Wenn sich die Datei in einem apigee-env/service-accounts/-Verzeichnis befindet, müssen Sie einen relativen Pfad angeben:
      synchronizer:  "service-accounts/FILE_NAME.json"

    In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig PROJECT_ID-non-prod.json.

    In Produktionsumgebungen der Name der Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool unter Schritt 4: Dienstkonten erstellen generiert haben.

    Sie können die Dienstkontodateien in den entsprechenden Diagrammverzeichnissen sehen.

    Die Standardnamen der und der entsprechenden Diagrammverzeichnisse für die Dienstkonten sind:

    Produktion

    Dateiname des Dienstkontos Diagrammverzeichnis
    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/

    Non-prod

    Dateiname des Dienstkontos Diagrammverzeichnis
    PROJECT_ID-non-prod.json apigee-datastore/
    apigee-org/
    apigee-telemetry/

    Weitere Informationen:

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    FILEPATH
    Der Pfad und der Dateiname des JSON-Dateien des Dienstkontos in dem entsprechenden Diagrammverzeichnis. Geben Sie die Namen mit dem Pfad relativ zum Diagrammverzeichnis an. Beispiel:
    • Wenn sich die Datei my-project-apigee-synchronizer.json im Diagrammverzeichnis apigee-env/ befindet, müssen Sie nur den Dateinamen angeben, z. B.:
      synchronizer:  "FILE_NAME.json"
    • Wenn sich die Datei in einem apigee-env/service-accounts/-Verzeichnis befindet, müssen Sie einen relativen Pfad angeben:
      synchronizer:  "service-accounts/FILE_NAME.json"

    In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig PROJECT_ID-non-prod.json.

    In Produktionsumgebungen der Name der Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool unter Schritt 4: Dienstkonten erstellen generiert haben.

    Sie können die Dienstkontodateien in den entsprechenden Diagrammverzeichnissen sehen.

    Die Standardnamen der und der entsprechenden Diagrammverzeichnisse für die Dienstkonten sind:

    Produktion

    Dateiname des Dienstkontos Diagrammverzeichnis
    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/

    Non-prod

    Dateiname des Dienstkontos Diagrammverzeichnis
    PROJECT_ID-non-prod.json apigee-datastore/
    apigee-org/
    apigee-telemetry/

    Weitere Informationen:

    Vault

    Produktion

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    Non-prod

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    WIF für GKE

    Produktion

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    EMAIL
    Die E-Mail-Adressen des Dienstkontos für die Google-Dienstkonten (GSA), die Sie angeben müssen, wenn Sie die Workload Identity-Föderation für GKE verwenden. Dies sind die Dienstkonten, die Sie in Schritt 4: Dienstkonten erstellen erstellt haben. Sie können die E-Mail-Adressen der Dienstkonten mit dem folgenden Befehl ermitteln:
    gcloud iam service-accounts list \
      --project ${PROJECT_ID} \
      --filter "apigee"

    Weitere Informationen:

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    SERVICE_ACCOUNT_
    EMAIL
    Die E-Mail-Adressen des Dienstkontos für die Google-Dienstkonten (GSA), die Sie angeben müssen, wenn Sie die Workload Identity-Föderation für GKE verwenden. Dies sind die Dienstkonten, die Sie in Schritt 4: Dienstkonten erstellen erstellt haben. Sie können die E-Mail-Adressen der Dienstkonten mit dem folgenden Befehl ermitteln:
    gcloud iam service-accounts list \
      --project ${PROJECT_ID} \
      --filter "apigee"

    Weitere Informationen:

    Non-prod

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    NON_PROD_
    SERVICE_ACCOUNT_
    EMAIL
    Die E-Mail-Adressen des Dienstkontos für das Google-Dienstkonto (GSA) für Nicht-Produktionsumgebungen. Dies ist das apigee-non-prod-Dienstkonto, das Sie in Schritt 4: Dienstkonten erstellen erstellt haben.

    Wenn Sie Workload Identity-Föderation für GKE in einer Nichtproduktionsinstallation verwenden, geben Sie die E-Mail-Adresse des Dienstkontos für die gcp.workloadIdentity.gsa-Property an. Sie müssen die gsa-Property nicht für einzelne Komponenten hinzufügen.

    Sie können die E‑Mail-Adressen der Dienstkonten mit dem folgenden Befehl ermitteln:

    gcloud iam service-accounts list \
      --project ${PROJECT_ID} \
      --filter "apigee"

    Weitere Informationen finden Sie unter gcp.workloadIdentity.gsa.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    NON_PROD_
    SERVICE_ACCOUNT_
    EMAIL
    Die E-Mail-Adressen des Dienstkontos für das Google-Dienstkonto (GSA) für Nicht-Produktionsumgebungen. Dies ist das apigee-non-prod-Dienstkonto, das Sie in Schritt 4: Dienstkonten erstellen erstellt haben.

    Wenn Sie Workload Identity-Föderation für GKE in einer Nichtproduktionsinstallation verwenden, geben Sie die E-Mail-Adresse des Dienstkontos für die gcp.workloadIdentity.gsa-Property an. Sie müssen die gsa-Property nicht für einzelne Komponenten hinzufügen.

    Sie können die E‑Mail-Adressen der Dienstkonten mit dem folgenden Befehl ermitteln:

    gcloud iam service-accounts list \
      --project ${PROJECT_ID} \
      --filter "apigee"

    Weitere Informationen finden Sie unter gcp.workloadIdentity.gsa.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    WIF auf anderen Plattformen

    WIF: Secrets

    Produktion

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    WORKLOAD_IDENTITY_
    SECRET
    Der Name des Kubernetes-Secrets, das Sie für die Konfiguration der Dienstkonto-Anmeldedaten in Schritt 5: Dienstkonto-Authentifizierung einrichten verwendet haben.

    Die Standardnamen der in diesem Leitfaden vorgeschlagenen Secrets sind:

    Produktion

    • 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

    Non-prod

    • non-prod-workload-identity-secret

    Weitere Informationen:

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    WORKLOAD_IDENTITY_
    SECRET
    Der Name des Kubernetes-Secrets, das Sie für die Konfiguration der Dienstkonto-Anmeldedaten in Schritt 5: Dienstkonto-Authentifizierung einrichten verwendet haben.

    Die Standardnamen der in diesem Leitfaden vorgeschlagenen Secrets sind:

    Produktion

    • 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

    Non-prod

    • non-prod-workload-identity-secret

    Weitere Informationen:

    Non-prod

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    WORKLOAD_IDENTITY_
    SECRET
    Der Name des Kubernetes-Secrets, das Sie für die Konfiguration der Dienstkonto-Anmeldedaten in Schritt 5: Dienstkonto-Authentifizierung einrichten verwendet haben.

    Die Standardnamen der in diesem Leitfaden vorgeschlagenen Secrets sind:

    Produktion

    • 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

    Non-prod

    • non-prod-workload-identity-secret

    Weitere Informationen:

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    WORKLOAD_IDENTITY_
    SECRET
    Der Name des Kubernetes-Secrets, das Sie für die Konfiguration der Dienstkonto-Anmeldedaten in Schritt 5: Dienstkonto-Authentifizierung einrichten verwendet haben.

    Die Standardnamen der in diesem Leitfaden vorgeschlagenen Secrets sind:

    Produktion

    • 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

    Non-prod

    • non-prod-workload-identity-secret

    Weitere Informationen:

    WIF: Dateien

    Produktion

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    CREDENTIAL_
    CONFIGURATION_
    FILEPATH
    Der Pfad und der Dateiname der Konfigurationsdateien mit Anmeldedaten, die Sie in Schritt 5: Dienstkonto-Authentifizierung einrichten erstellt haben.

    Geben Sie die Namen mit dem Pfad relativ zum Diagrammverzeichnis an. Beispiel:

    • Wenn sich die Datei apigee-synchronizer-credential-configuration.json im Diagrammverzeichnis apigee-env/ befindet, müssen Sie nur den Dateinamen angeben, z. B.:
      synchronizer:  "FILE_NAME.json"
    • Wenn sich die Datei in einem apigee-env/service-accounts/-Verzeichnis befindet, müssen Sie einen relativen Pfad angeben:
      synchronizer:  "service-accounts/FILE_NAME.json"

    Die Standardnamen der und der entsprechenden Diagrammverzeichnisse für die Dienstkonten sind:

    Produktion

    Dateiname des Dienstkontos Diagrammverzeichnis
    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/

    Non-prod

    Dateiname des Dienstkontos Diagrammverzeichnis
    apigee-non-prod-credential-configuration.json apigee-datastore/
    apigee-org/
    apigee-telemetry/

    Weitere Informationen:

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    CREDENTIAL_
    CONFIGURATION_
    FILEPATH
    Der Pfad und der Dateiname der Konfigurationsdateien mit Anmeldedaten, die Sie in Schritt 5: Dienstkonto-Authentifizierung einrichten erstellt haben.

    Geben Sie die Namen mit dem Pfad relativ zum Diagrammverzeichnis an. Beispiel:

    • Wenn sich die Datei apigee-synchronizer-credential-configuration.json im Diagrammverzeichnis apigee-env/ befindet, müssen Sie nur den Dateinamen angeben, z. B.:
      synchronizer:  "FILE_NAME.json"
    • Wenn sich die Datei in einem apigee-env/service-accounts/-Verzeichnis befindet, müssen Sie einen relativen Pfad angeben:
      synchronizer:  "service-accounts/FILE_NAME.json"

    Die Standardnamen der und der entsprechenden Diagrammverzeichnisse für die Dienstkonten sind:

    Produktion

    Dateiname des Dienstkontos Diagrammverzeichnis
    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/

    Non-prod

    Dateiname des Dienstkontos Diagrammverzeichnis
    apigee-non-prod-credential-configuration.json apigee-datastore/
    apigee-org/
    apigee-telemetry/

    Weitere Informationen:

    Non-prod

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    CREDENTIAL_
    CONFIGURATION_
    FILEPATH
    Der Pfad und der Dateiname der Konfigurationsdateien mit Anmeldedaten, die Sie in Schritt 5: Dienstkonto-Authentifizierung einrichten erstellt haben.

    Geben Sie die Namen mit dem Pfad relativ zum Diagrammverzeichnis an. Beispiel:

    • Wenn sich die Datei apigee-synchronizer-credential-configuration.json im Diagrammverzeichnis apigee-env/ befindet, müssen Sie nur den Dateinamen angeben, z. B.:
      synchronizer:  "FILE_NAME.json"
    • Wenn sich die Datei in einem apigee-env/service-accounts/-Verzeichnis befindet, müssen Sie einen relativen Pfad angeben:
      synchronizer:  "service-accounts/FILE_NAME.json"

    Die Standardnamen der und der entsprechenden Diagrammverzeichnisse für die Dienstkonten sind:

    Produktion

    Dateiname des Dienstkontos Diagrammverzeichnis
    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/

    Non-prod

    Dateiname des Dienstkontos Diagrammverzeichnis
    apigee-non-prod-credential-configuration.json apigee-datastore/
    apigee-org/
    apigee-telemetry/

    Weitere Informationen:

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    <component>_
    CREDENTIAL_
    CONFIGURATION_
    FILEPATH
    Der Pfad und der Dateiname der Konfigurationsdateien mit Anmeldedaten, die Sie in Schritt 5: Dienstkonto-Authentifizierung einrichten erstellt haben.

    Geben Sie die Namen mit dem Pfad relativ zum Diagrammverzeichnis an. Beispiel:

    • Wenn sich die Datei apigee-synchronizer-credential-configuration.json im Diagrammverzeichnis apigee-env/ befindet, müssen Sie nur den Dateinamen angeben, z. B.:
      synchronizer:  "FILE_NAME.json"
    • Wenn sich die Datei in einem apigee-env/service-accounts/-Verzeichnis befindet, müssen Sie einen relativen Pfad angeben:
      synchronizer:  "service-accounts/FILE_NAME.json"

    Die Standardnamen der und der entsprechenden Diagrammverzeichnisse für die Dienstkonten sind:

    Produktion

    Dateiname des Dienstkontos Diagrammverzeichnis
    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/

    Non-prod

    Dateiname des Dienstkontos Diagrammverzeichnis
    apigee-non-prod-credential-configuration.json apigee-datastore/
    apigee-org/
    apigee-telemetry/

    Weitere Informationen:

    WIF: Vault

    Produktion

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    Non-prod

    Vorlage

    Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie können die Werte auf dieser Seite bearbeiten. Sie werden in der nachfolgenden Tabelle beschrieben.

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    Beispiel

    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
    

    In der folgenden Tabelle sind alle Attributwerte beschrieben, die Sie in der Überschreibungsdatei angeben müssen. Weitere Informationen finden Sie unter Referenz zu Konfigurationsattributen.

    Variable Beschreibung
    UNIQUE_INSTANCE_
    IDENTIFIER

    Ein eindeutiger String zur Identifizierung dieser Instanz. Es kann eine beliebige Kombination aus Buchstaben und Ziffern mit bis zu 63 Zeichen sein.

    Sie können mehrere Organisationen im selben Cluster erstellen, die instanceID muss jedoch für alle Organisationen im selben Kubernetes-Cluster identisch sein.

    Weitere Informationen finden Sie unter instanceID.

    APIGEE_NAMESPACE

    Der Kubernetes-Namespace für Ihre Apigee Hybrid-Komponenten.

    Der Standardwert ist apigee.

    Weitere Informationen finden Sie unter namespace.

    PROJECT_ID Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. Dies ist der Wert, der der Umgebungsvariablen PROJECT_ID zugewiesen ist.

    Weitere Informationen finden Sie unter gcp.projectID.

    ANALYTICS_REGION In GKE müssen Sie diesen Wert auf dieselbe Region festlegen, in der der Cluster ausgeführt wird. Wählen Sie auf allen anderen Plattformen die nächstgelegene Analyseregion für Ihren Cluster aus, die Analytics unterstützt. Weitere Informationen finden Sie in der Tabelle in Teil 1, Schritt 2: Organisation erstellen.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.

    Weitere Informationen finden Sie unter gcp.region.

    AUDIENCE Die zulässige Zielgruppe des Workload Identity Providers. Sie finden den Wert, indem Sie in den Konfigurationsdateien mit Anmeldedaten nach dem Begriff audience: suchen. Der entsprechende Wert ist in allen Dateien gleich.

    Nehmen wir als Beispiel die folgende Datei apigee-udca-credential-configuration.json:

    {
      "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"
        }
      }
    }

    Der Zielgruppenwert sieht in etwa so aus (ohne Zeilenumbrüche):

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

    Weitere Informationen finden Sie unter gcp.federatedWorkloadIdentity.audience.

    CLUSTER_NAME Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter k8sCluster.name.

    CLUSTER_LOCATION Die Region, in der der Cluster ausgeführt wird. Dies ist die Region, in der Sie den Cluster in Schritt 1: Cluster erstellen erstellt haben.

    Dies ist der Wert, den Sie zuvor der Umgebungsvariable CLUSTER_LOCATION zugewiesen haben.

    Weitere Informationen finden Sie unter k8sCluster.location.

    ORG_NAME Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.

    Weitere Informationen finden Sie unter org.

    CONTROL_PLANE_
    LOCATION
    Erforderlich, wenn Sie den Datenstandort mit Ihrer Apigee Hybrid-Installation verwenden. Dies ist der Speicherort, an dem wichtige Kundeninhalte wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene. Dies ist der Wert, der der Umgebungsvariablen CONTROL_PLANE_LOCATION in Schritt 2: Organisation erstellen zugewiesen ist.

    Weitere Informationen finden Sie unter contractProvider.

    ENVIRONMENT_NAME Verwenden Sie denselben Namen, den Sie beim Erstellen einer Umgebung in der Benutzeroberfläche verwendet haben, wie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erläutert.

    Weitere Informationen finden Sie unter envs[].name.

    ENVIRONMENT_GROUP_
    NAME
    Der Name der Umgebungsgruppe, der Ihre Umgebungen zugewiesen sind. Das ist die Gruppe, die Sie unter Projekt und Organisation einrichten – Schritt 3: Umgebungsgruppe erstellen erstellt haben. Dies ist der Wert, der der Umgebungsvariablen ENV_GROUP zugewiesen ist.

    Weitere Informationen finden Sie unter virtualhosts[].name.

    INGRESS_NAME Der Name des Apigee Ingress-Gateways für Ihre Bereitstellung. Dies kann ein beliebiger Name sein, der die folgenden Anforderungen erfüllt:
    • Darf maximal 17 Zeichen lang sein.
    • Darf nur kleingeschriebene, alphanumerische Zeichen enthalten, "-" oder ".".
    • Muss mit einem alphanumerischen Zeichen beginnen.
    • Muss mit einem alphanumerischen Zeichen enden.

    Weitere Informationen:

    PATH_TO_CERT_FILE
    PATH_TO_KEY_FILE
    Geben Sie den Pfad und den Dateinamen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor in Schritt 6: TLS-Zertifikate erstellen erstellt haben. Diese Dateien müssen sich im Verzeichnis APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs befinden. Beispiel:
    sslCertPath: certs/keystore.crt
    sslKeyPath: certs/keystore.key

    Weitere Informationen:

    SVC_ANNOTATIONS_
    KEY
    : SVC_ANNOTATIONS_
    VALUE
    Optional: Dies ist ein Schlüssel/Wert-Paar, das Annotationen für Ihren Standarddienst für eingehenden Traffic bereitstellt. Ihre Cloud-Plattform verwendet Annotationen, um Ihre Hybridinstallation zu konfigurieren, z. B. um den Load Balancer-Typ auf intern oder extern festzulegen.

    Annotationen variieren je nach Plattform. Erforderliche und vorgeschlagene Annotationen finden Sie in der Dokumentation Ihrer Plattform.

    Kommentieren Sie diesen Abschnitt aus oder löschen Sie ihn, wenn Sie ihn nicht verwenden.

    Weitere Informationen finden Sie unter ingressGateways[].svcAnnotations.

    Zusammenfassung

    Die Konfigurationsdatei teilt Kubernetes mit, wie die Hybridkomponenten in einem Cluster bereitgestellt werden sollen. Als Nächstes aktivieren Sie den Synchronisierungszugriff, damit die Apigee-Laufzeit und die Verwaltungsebenen kommunizieren können.

    Nächster Schritt

    1 2 3 4 5 6 7 (WEITER) Schritt 8: Control Plane-Zugriff aktivieren 9 10 11