Das Installationsprogramm von Apigee Hybrid verwendet für viele Einstellungen Standardwerte. Es gibt jedoch einige Einstellungen, für die keine Standardeinstellungen festgelegt sind. Sie müssen für diese Einstellungen wie unten beschrieben Werte angeben.
Sie müssen sich im Verzeichnis hybrid-base-directory/hybrid-files/overrides/ befinden.
cd hybrid-base-directory/hybrid-files/overrides
Erstellen Sie in Ihrem bevorzugten Texteditor eine neue Datei mit dem Namen overrides.yaml. Beispiel:
vi overrides.yaml
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.
Fügen Sie in overrides.yaml die erforderlichen Attributwerte hinzu (siehe unten). Im Folgenden finden Sie eine detaillierte Beschreibung der einzelnen Attribute:
Informationen zu Installationen in Produktionsumgebungen finden Sie in den Speicheranforderungen für die Cassandra-Datenbank unter Cassandra für die Produktion konfigurieren.
Syntax
Ihre Datei overrides.yaml muss die unten aufgeführte Struktur und Syntax haben.
Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie werden in der nachfolgenden Tabelle beschrieben.
Es gibt Unterschiede zwischen den verschiedenen Plattformen für die Google Cloud-Projektregion und die Kubernetes-Clusterregion. Wählen Sie die Plattform aus, auf der Sie Apigee hybrid installieren.
gcp:
region: analytics-region
projectID: gcp-project-id
k8sCluster:
name: cluster-name
region: cluster-location # Must be the closest Google Cloud region to your cluster.
org: org-name
instanceID: "unique-instance-identifier" # See the property description table below information about this parameter.
cassandra:
hostNetwork: false
# Set to false for single region installations and multi-region installations
# with connectivity between pods in different clusters, for example GKE installations.
# Set to true for multi-region installations with no communication between
# pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,
# AKS, EKS, and OpenShift installations.
# See Multi-region deployment: Prerequisites
storage:
capacity: 500Gi
resources:
requests:
cpu: 7
memory: 15Gi
maxHeapSize: 8192M
heapNewSize: 1200M
# Minimum storage requirements for a production environment.
# See Configure Cassandra for production.
virtualhosts:
- name: environment-group-name
sslCertPath: ./certs/cert-name.pem
sslKeyPath: ./certs/key-name.key
envs:
- name: environment-name
serviceAccountPaths:
synchronizer: ./service-accounts/synchronizer-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-synchronizer.json
udca: ./service-accounts/udca-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-udca.json
runtime: ./service-accounts/runtime-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-runtime.json
mart:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-mart.json
connectAgent:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-mart.json
# Use the same service account for mart and connectAgent
metrics:
serviceAccountPath: ./service-accounts/metrics-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-metrics.json
udca:
serviceAccountPath: ./service-accounts/udca-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-udca.json
watcher:
serviceAccountPath: ./service-accounts/watcher-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-watcher.json
logger:
enabled: false
# Set to false to disable logger for GKE installations.
# Set to true for all platforms other than GKE.
# See apigee-logger in Service accounts and roles used by hybrid components.
serviceAccountPath: ./service-accounts/logger-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-logger.json
Beispiel
Das folgende Beispiel zeigt eine fertige Überschreibungsdatei mit hinzugefügten Attributwerten:
gcp:
region: us-central1
projectID: hybrid-example
k8sCluster:
name: apigee-hybrid
region: us-central1
org: hybrid-example
instanceID: "my_hybrid_example"
cassandra:
hostNetwork: false
virtualhosts:
- name: example-env-group
sslCertPath: ./certs/keystore.pem
sslKeyPath: ./certs/keystore.key
envs:
- name: test
serviceAccountPaths:
synchronizer: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-synchronizer.json
udca: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-udca.json
runtime: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-runtime.json
mart:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-mart.json
connectAgent:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, example-hybrid-apigee-mart.json
metrics:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-metrics.json
udca:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-udca.json
watcher:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-watcher.json
logger:
enabled: false # Set to "false" for GKE. Set to "true" for all other kubernetes platforms.
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, logger-service-account-name.json
Wenn Sie fertig sind, speichern Sie die Datei.
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
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 4: Organisation erstellen.
Dies ist der Wert, den Sie zuvor der Umgebungsvariable ANALYTICS_REGION zugewiesen haben.
gcp-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.
cluster-name
Der Name Ihres Kubernetes-Clusters. Dies ist der Wert, der der Umgebungsvariablen CLUSTER_NAME zugewiesen ist.
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.
org-name
Die ID Ihrer Apigee Hybrid-Organisation. Dies ist der Wert, der der Umgebungsvariablen ORG_NAME zugewiesen ist.
unique-instance-identifier
Ein eindeutiger String zur Identifizierung dieser Apigee Hybrid-Instanz pro Cluster. Der String kann eine Kombination aus Buchstaben und Zahlen mit einer Länge von bis zu 63 Zeichen sein.
Sie können mehrere Organisationen in einem einzelnen Cluster erstellen. Achten Sie darauf, für jedes Mal, wenn Sie einem Cluster eine neue Organisation hinzufügen, denselben instanceID-Wert zu verwenden.
Wenn Sie mehrere Cluster (in derselben Region oder in mehreren Regionen) haben, benötigt jeder Cluster eine eindeutige instanceID.
Wenn Sie Hilfe beim Generieren einer eindeutigen ID benötigen, können Sie ein Tool zur Generierung zufälliger Strings verwenden, z. B. random.org/strings.
Geben Sie den Namen 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 base_directory/hybrid-files/certs befinden. Beispiel:
In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig non-prod. In Produktionsumgebungen der Name der apigee-synchronizer-Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool unter Hybride Laufzeitkonfiguration – Schritt 6: Dienstkonten und Anmeldedaten erstellen generiert haben. Sie können die Liste der Dienstkontodateien in Ihrem service-accounts/-Verzeichnis einsehen. Beispiel:
ls ../service-accounts/
udca-service-account-name
In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig non-prod. In Produktionsumgebungen der Name der apigee-udca-Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool generiert haben.
runtime-service-account-name
In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig non-prod. In Produktionsumgebungen der Name der apigee-runtime-Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool generiert haben.
mart-service-account-name
In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig non-prod. In Produktionsumgebungen der Name der apigee-mart-Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool generiert haben.
metrics-service-account-name
In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig non-prod. In Produktionsumgebungen der Name der apigee-metrics-Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool generiert haben.
udca-service-account-name
In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig non-prod. In Produktionsumgebungen der Name der apigee-udca-Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool generiert haben.
watcher-service-account-name
In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig non-prod. In Produktionsumgebungen der Name der apigee-watcher-Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool generiert haben.
logger-service-account-name
In Nicht-Produktionsumgebungen der Name des einzelnen Dienstkontos, standardmäßig non-prod. In Produktionsumgebungen der Name der apigee-logger-Dienstkontoschlüsseldatei, die Sie mit dem create-service-account-Tool generiert haben.
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.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-08-28 (UTC)."],[[["\u003cp\u003eThis documentation version 1.7 is end of life and an upgrade to a newer version is needed.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file is essential for configuring a unique Apigee hybrid installation and it requires specific property values.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file structure includes settings for GCP project details, Kubernetes cluster information, organization details, instance ID, Cassandra database settings, virtual hosts, environments, and various service account paths.\u003c/p\u003e\n"],["\u003cp\u003eThe configuration for production environments differ from non-production environments, particularly in the assignment of specific service accounts for various components.\u003c/p\u003e\n"],["\u003cp\u003eSpecific service account key files are required and must be placed in the correct directories, for the components such as \u003ccode\u003esynchronizer\u003c/code\u003e, \u003ccode\u003eudca\u003c/code\u003e, \u003ccode\u003eruntime\u003c/code\u003e, \u003ccode\u003emart\u003c/code\u003e, \u003ccode\u003emetrics\u003c/code\u003e, \u003ccode\u003ewatcher\u003c/code\u003e and \u003ccode\u003elogger\u003c/code\u003e, among others.\u003c/p\u003e\n"]]],[],null,["# Step 7: Configure the hybrid runtime\n\n| You are currently viewing version 1.7 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\nSpecify configuration overrides\n-------------------------------\n\n\nThe Apigee hybrid installer uses defaults for many settings; however, there are a few settings\nthat do not have defaults. You must provide values for these settings, as explained next.\n\n1. Be sure you are in the \u003cvar translate=\"no\"\u003ehybrid-base-directory\u003c/var\u003e`/hybrid-files/overrides/` directory. \n\n ```\n cd hybrid-base-directory/hybrid-files/overrides\n ```\n2. Create a new file named **\u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml`** in your favorite text editor. For example: \n\n ```\n vi overrides.yaml\n ```\n\n\n The \u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml` provides the configuration for your unique Apigee hybrid\n installation. The overrides file in this step provides a basic configuration for a small-footprint\n hybrid runtime installation, suitable for your first installation.\n3. In \u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml`, add the required property values, shown below. A detailed description of each property is also provided below:\n\n For installations in production environments, look at the storage requirements for the\n Cassandra database in [Configure Cassandra for\n production](/apigee/docs/hybrid/v1.7/cassandra-production). \n\n ### Syntax\n\n Make sure the \u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml` file has the following structure and syntax.\n Values in \u003cvar translate=\"no\"\u003ered, bold italics\u003c/var\u003e are\n property values that you must provide. They are described in the [table below](#tablebelow).\n\n\n There are differences between the different platforms for the Google Cloud project region and\n Kubernetes cluster region. Choose the platform where you are installing Apigee hybrid. \n\n ```\n gcp:\n region: analytics-region\n projectID: gcp-project-id\n\n k8sCluster:\n name: cluster-name\n region: cluster-location # Must be the closest Google Cloud region to your cluster.\n org: org-name\n\n instanceID: \"unique-instance-identifier\" # See the property description table below information about this parameter.\n \n cassandra:\n hostNetwork: false\n # Set to false for single region installations and multi-region installations\n # with connectivity between pods in different clusters, for example GKE installations.\n # Set to true for multi-region installations with no communication between\n # pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,\n # AKS, EKS, and OpenShift installations.\n # See Multi-region deployment: Prerequisites\n storage:\n capacity: 500Gi\n resources:\n requests:\n cpu: 7\n memory: 15Gi\n maxHeapSize: 8192M\n heapNewSize: 1200M\n # Minimum storage requirements for a production environment.\n # See Configure Cassandra for production.\n\n virtualhosts:\n - name: environment-group-name\n sslCertPath: ./certs/cert-name.pem\n sslKeyPath: ./certs/key-name.key\n\n envs:\n - name: environment-name\n serviceAccountPaths:\n synchronizer: ./service-accounts/synchronizer-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-synchronizer.json\n udca: ./service-accounts/udca-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-udca.json\n runtime: ./service-accounts/runtime-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-runtime.json\n\n mart:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-mart.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-mart.json\n # Use the same service account for mart and connectAgent\n\n metrics:\n serviceAccountPath: ./service-accounts/metrics-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-metrics.json\n\n udca:\n serviceAccountPath: ./service-accounts/udca-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-udca.json\n\n watcher:\n serviceAccountPath: ./service-accounts/watcher-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-watcher.json\n\n logger:\n enabled: false\n # Set to false to disable logger for GKE installations.\n # Set to true for all platforms other than GKE.\n # See apigee-logger in Service accounts and roles used by hybrid components.\n serviceAccountPath: ./service-accounts/logger-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-logger.json\n\n ```\n\n ### Example\n\n The following example shows a completed overrides file with example property values\n added: \n\n ```\n gcp:\n region: us-central1\n projectID: hybrid-example\n\n k8sCluster:\n name: apigee-hybrid\n region: us-central1\n\n org: hybrid-example\n\n instanceID: \"my_hybrid_example\"\n \n cassandra:\n hostNetwork: false\n\n virtualhosts:\n - name: example-env-group\n sslCertPath: ./certs/keystore.pem\n sslKeyPath: ./certs/keystore.key\n\n envs:\n - name: test\n serviceAccountPaths:\n synchronizer: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-synchronizer.json\n udca: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-udca.json\n runtime: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-runtime.json\n\n mart:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-mart.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, example-hybrid-apigee-mart.json\n\n metrics:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-metrics.json\n\n udca:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-udca.json\n\n watcher:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-watcher.json\n\n logger:\n enabled: false # Set to \"false\" for GKE. Set to \"true\" for all other kubernetes platforms.\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, logger-service-account-name.json\n\n ```\n4. When you are finished, save the file.\n\n\nThe following table describes each of the property values that you must provide in the\noverrides file. For more information, see\n[Configuration property reference](/apigee/docs/hybrid/v1.7/config-prop-ref).\n\n| **Note:** If you want to create a security perimeter around your cluster and related Cloud services, you can configure one using Google Cloud [Virtual Private Cloud (VPC) Service\n| Controls](https://cloud.google.com/vpc-service-controls) with Apigee hybrid. See [Using\n| VPC Service Controls with Apigee and Apigee hybrid](/apigee/docs/api-platform/security/vpc-sc) for instructions.\n\nSummary\n-------\n\n\nThe configuration file tells Kubernetes how to deploy the hybrid components to\na cluster. Next, you will enable synchronizer access so the Apigee runtime and management planes\nwill be able to communicate.\n[1](/apigee/docs/hybrid/v1.7/install-create-cluster) [2](/apigee/docs/hybrid/v1.7/install-cert-manager) [3](/apigee/docs/hybrid/v1.7/install-asm) [4](/apigee/docs/hybrid/v1.7/install-apigeectl) [5](/apigee/docs/hybrid/v1.7/install-service-accounts) [6](/apigee/docs/hybrid/v1.7/install-create-tls-certificates) [7](/apigee/docs/hybrid/v1.7/install-configure-cluster) [(NEXT) Step 8: Enable Synchronizer access](/apigee/docs/hybrid/v1.7/install-enable-synchronizer-access) [9](/apigee/docs/hybrid/v1.7/install-hybrid-runtime)\n\n\u003cbr /\u003e"]]
