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:
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.
gcp:
region: analytics-region # Choose the closest Google Cloud region to your cluster.
projectID: gcp-project-id
k8sCluster:
name: cluster-name
region: analytics-region # Choose the closest Google Cloud region to your cluster.
org: org-name
instanceID: "unique-instance-identifier"
cassandra:
hostNetwork: false #Set this to `true` for GKE-On-prem installations.
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
udca: ./service-accounts/udca-service-account-name.json
mart:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
connectAgent:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
# Same account used for mart and connectAgent
metrics:
serviceAccountPath: ./service-accounts/metrics-service-account-name.json
watcher:
serviceAccountPath: ./service-accounts/watcher-service-account-name.json
logger:
enabled: true
serviceAccountPath: ./service-accounts/logger-service-account-name.json
Beispiel
Das folgende Beispiel zeigt eine fertige Überschreibungsdatei mit hinzugefügten Attributwerten:
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
Die Region, in der der Cluster ausgeführt wird.
Dies ist der Wert, den Sie der Umgebungsvariable ANALYTICS_REGION zugewiesen haben zuvor bei der Clustererstellung.
apigee-logger und derapigee-metrics übertragen deren Daten in diese Region.
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.
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 Instanz. Es kann eine beliebige Kombination aus Buchstaben und Zahlen mit einer Länge von bis zu 63 Zeichen sein.
Geben Sie den Namen des selbst signierten TLS-Schlüssels und der Zertifikatsdateien ein, die Sie zuvor in Schritt 3: Apigeectl installieren generiert haben.
Diese Dateien müssen sich im Verzeichnis base_directory/hybrid-files/certs befinden. Beispiel:
Der Name des Dienstkontos mart (dem die Rolle Apigee Connect-Agent zugewiesen), das Sie in Schritt 3: Apigeectl installieren erstellt haben
MART und der Apigee Connect Agent verwenden dasselbe Dienstkonto.
watcher-service-account-name
Der Name der watcher-Dienstkonto-JSON-Datei, die Sie mit dem create-service-account Tool generiert haben. Beispiel:
Die Konfigurationsdatei teilt Kubernetes mit, wie die Hybridkomponenten in einem Cluster bereitgestellt werden sollen. Als Nächstes wenden Sie diese Konfiguration auf Ihren Cluster an.
[[["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-09-03 (UTC)."],[[["\u003cp\u003eThis document provides instructions for configuring the \u003ccode\u003eoverrides.yaml\u003c/code\u003e file, which is essential for customizing your unique Apigee hybrid installation, including settings for Google Cloud, Kubernetes cluster, and service accounts.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file must be created in the \u003ccode\u003ehybrid-base-directory/hybrid-files/overrides/\u003c/code\u003e directory and requires specific property values such as project IDs, cluster names, region, organization ID, and unique instance identifiers, as well as environment and virtual host details.\u003c/p\u003e\n"],["\u003cp\u003eThe configuration requires paths to service account JSON files for various components like synchronizer, udca, mart, metrics, watcher, and logger, ensuring each component can securely interact with the necessary resources.\u003c/p\u003e\n"],["\u003cp\u003eEach of the required properties and their purpose is described in the table, that includes details like the necessary google cloud region, cluster name and org name, along with service account names, key names, and certificate files location.\u003c/p\u003e\n"],["\u003cp\u003eAfter configuring the \u003ccode\u003eoverrides.yaml\u003c/code\u003e file, it will be used to deploy the hybrid components to a cluster, and is required to be saved once completed.\u003c/p\u003e\n"]]],[],null,["# Step 4: Configure the user cluster\n\n| You are currently viewing version 1.3 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 ### 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\n gcp:\n region: analytics-region # Choose the closest Google Cloud region to your cluster.\n projectID: gcp-project-id\n\n k8sCluster:\n name: cluster-name\n region: analytics-region # Choose the closest Google Cloud region to your cluster.\n\n\n org: org-name\n\n instanceID: \"unique-instance-identifier\"\n\n cassandra:\n hostNetwork: false #Set this to `true` for GKE-On-prem installations.\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 udca: ./service-accounts/udca-service-account-name.json\n\n mart:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n # Same account used for mart and connectAgent\n\n metrics:\n serviceAccountPath: ./service-accounts/metrics-service-account-name.json\n\n watcher:\n serviceAccountPath: ./service-accounts/watcher-service-account-name.json\n\n logger:\n enabled: true\n serviceAccountPath: ./service-accounts/logger-service-account-name.json\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 #Set this to `true` for GKE-On Prem installations.\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-synchronizer.json\n udca: ./service-accounts/hybrid-project-apigee-udca.json\n\n mart:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/example-hybrid-apigee-mart.json\n\n metrics:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json\n\n watcher:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-watcher.json\n\n logger:\n enabled: true\n serviceAccountPath: ./service-accounts/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.3/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 apply this configuration to your cluster.\n[1](/apigee/docs/hybrid/v1.3/install-create-cluster-eks) [2](/apigee/docs/hybrid/v1.3/install-download-cert-manager-istio-eks) [3](/apigee/docs/hybrid/v1.3/install-download-install-eks) [4](/apigee/docs/hybrid/v1.3/install-copy-overrides-eks) [(NEXT) Step 5: Install hybrid runtime](/apigee/docs/hybrid/v1.3/install-apply-hybrid-eks)\n\n\u003cbr /\u003e"]]
