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 befinden.
Kopieren Sie die Datei overrides-small.yaml aus dem Verzeichnis $APIGEECTL_HOME/examples in das Verzeichnis overrides:
Diese Beispieldatei enthält eine grundlegende Konfiguration für eine Laufzeitinstallation von Hybrid mit geringem Platzbedarf. Diese Konfiguration eignet sich für die erste Installation.
cd in das Verzeichnis overrides einbinden:
cd overrides
Öffnen Sie overrides.yaml und fügen Sie die unten aufgeführten erforderlichen Attributwerte hinzu. Im Folgenden finden Sie eine detaillierte Beschreibung der einzelnen Attribute:
Syntax
Die Datei overrides.yaml hat die folgende Struktur und Syntax.
Werte in red, bold italics sind Attributwerte, die Sie angeben müssen. Sie werden auch in der folgenden Tabelle beschrieben.
gcp:region:gcp-regionprojectID:gcp-project-idk8sCluster:name:cluster-nameregion:cluster-regionorg:org-namevirtualhosts:-name:virtual-host-namehostAliases:-"host-alias-1"-"host-alias-2"-"host-alias-n"sslCertPath:./certs/test-cert-name.pemsslKeyPath:./certs/test-key-name.keyroutingRules:-paths:-/path1-/path2-/pathnenv:environment-nameenvs:-name:environment-name# The same name of the env you created in the UIserviceAccountPaths:synchronizer:./service-accounts/synchronizer-service-account-name.jsonudca:./service-accounts/udca-service-account-name.jsonmart:hostAlias:mart-host-aliasserviceAccountPath:./service-accounts/mart-service-account-name.jsonsslCertPath:./certs/mart-cert-name.pemsslKeyPath:./certs/mart-key-name.keycassandra:hostNetwork:truednsPolicy:ClusterFirstWithHostNetingress:runtime:loadBalancerIP:virtual_IP_runtimemart:loadBalancerIP:virtual_IP_martmetrics:serviceAccountPath:./service-accounts/metrics-service-account-name.jsonlogger:enabled:false
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.
Erforderlich: Verwenden Sie für die Kurzanleitung das Platzhalterzeichen "*".
Die Verwendung von * wird nur für eine Testinstallation empfohlen, wenn selbst signierte TLS-Anmeldedaten verwendet werden.
Wenn Sie später komplexere Apigee Hybrid-Konfigurationen entwickeln, z. B. das Erstellen mehrerer Umgebungen, müssen Sie für diesen Wert einen qualifizierten Domainnamen verwenden.
test-cert-name test-key-name
Geben Sie den Namen der selbst signierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor im Schritt
TLS-Anmeldedaten für das Laufzeitgateway erstellen generiert haben. Diese Dateien müssen sich im Verzeichnis base_directory/hybrid-files/certs befinden. Beispiel:
Damit Sie das integrierte GKE On-Prem-Load-Balancing verwenden können, müssen Sie virtuelle IPs für Load-Balancer in den Hybrid-MART- und Laufzeitdiensten bereitstellen.
GKE On-Prem konfiguriert die virtuelle IP automatisch auf dem F 5-BIG-IP-Load-Balancer. Weitere Informationen finden Sie unter Load-Balancer für GKE On-Prem einrichten.
mart-host-alias
Ein qualifizierter DNS-Name für den MART-Serverendpunkt. Der Name muss mit dem gemeinsamen Namen (CN) übereinstimmen, der im autorisierten TLS-Zertifikat für diese Konfiguration verwendet wird. Beispiel: mart.mydomain.com
mart-service-account-name
Der Name der Schlüsseldatei des MART-Dienstkontos, die Sie mit dem create-service-account-Tool generiert haben.
mart-cert-name mart-key-name
Geben Sie den Namen der autorisierten TLS-Schlüssel- und Zertifikatsdateien ein, die Sie zuvor im Schritt TLS-Anmeldedaten für das MART-Gateway erstellen erstellt haben.
Diese Dateien müssen sich im Verzeichnis base_directory/hybrid-files/certs befinden. 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-08-28 (UTC)."],[[["\u003cp\u003eThis documentation covers configuring overrides for Apigee hybrid version 1.2, which is now end-of-life and should be upgraded to a newer version.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file is essential for customizing the hybrid installation, requiring specific property values for settings like GCP project ID, cluster name, and service accounts.\u003c/p\u003e\n"],["\u003cp\u003eUsers must copy the \u003ccode\u003eoverrides-small.yaml\u003c/code\u003e file to their \u003ccode\u003eoverrides\u003c/code\u003e directory and edit it, adding values for the required properties and disabling logging.\u003c/p\u003e\n"],["\u003cp\u003eThe configuration file utilizes specific placeholders, such as \u003ccode\u003e<var translate="no">red, bold italics</var>\u003c/code\u003e, to identify values that must be provided by the user.\u003c/p\u003e\n"],["\u003cp\u003eFor a quick start, using a wildcard character (\u003ccode\u003e*\u003c/code\u003e) is acceptable for host aliases when using self-signed TLS credentials, but qualified domain names are necessary for more complex configurations later.\u003c/p\u003e\n"]]],[],null,["# Step 3: Configure the GKE on-prem user cluster\n\n| You are currently viewing version 1.2 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| **UPGRADING:** If you are upgrading from v1.1.x to v1.2.0, see [Upgrading Apigee hybrid](/apigee/docs/hybrid/v1.2/upgrade) for instructions. If you are performing a new installation, continue with the configurations described below.\n\n1. Be sure you are in the \u003cvar translate=\"no\"\u003ehybrid-base-directory\u003c/var\u003e`/hybrid-files` directory.\n2. Copy the `overrides-small.yaml` file from the `$APIGEECTL_HOME``/examples` directory to your `overrides` directory: \n\n cp $APIGEECTL_HOME/examples/overrides-small.yaml ./overrides/overrides.yaml\n\n\n This example file provides a basic configuration for a small-footprint hybrid\n runtime installation, a configuration that is suitable for a your first installation.\n3. `cd` into the `overrides` directory: \n\n```\ncd overrides\n```\n 4. Open `overrides.yaml` and add the required property values, shown below. A detailed description of each property is also provided below: **NOTE:** Be sure to disable logging by setting `logger:enabled:false` in the overrides file. Logging is provided by default as part of GKE on-prem. \n\n ### Syntax\n\n The `overrides.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 also described in the table below. \n\n ```gdscript\n gcp:\n region: gcp-region\n projectID: gcp-project-id\n\n k8sCluster:\n name: cluster-name\n region: cluster-region\n\n org: org-name\n\n virtualhosts:\n - name: virtual-host-name\n hostAliases:\n - \"\u003cvar translate=\"no\"\u003ehost-alias-1\u003c/var\u003e\"\n - \"\u003cvar translate=\"no\"\u003ehost-alias-2\u003c/var\u003e\"\n - \"\u003cvar translate=\"no\"\u003ehost-alias-\u003cem\u003en\u003c/em\u003e\u003c/var\u003e\"\n sslCertPath: ./certs/test-cert-name.pem\n sslKeyPath: ./certs/test-key-name.key\n routingRules:\n - paths:\n - /path1\n - /path2\n - /pathn\n env: environment-name\n\n envs:\n - name: environment-name # The same name of the env you created in the UI\n serviceAccountPaths:\n synchronizer: ./service-accounts/synchronizer-service-account-name.json\n udca: ./service-accounts/udca-service-account-name.json\n\n mart:\n hostAlias: mart-host-alias\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n sslCertPath: ./certs/mart-cert-name.pem\n sslKeyPath: ./certs/mart-key-name.key\n\n cassandra:\n hostNetwork: true\n dnsPolicy: ClusterFirstWithHostNet\n\n ingress:\n runtime:\n loadBalancerIP: virtual_IP_runtime\n mart:\n loadBalancerIP: virtual_IP_mart\n\n\n metrics:\n serviceAccountPath: ./service-accounts/metrics-service-account-name.json\n\n logger:\n enabled: false\n ```\n\n ### Example\n\n The following example shows a completed overrides file with example property values\n added: \n\n ```gdscript\n gcp:\n region: us-central1\n projectID: my-gcp-project\n\n k8sCluster:\n name: apigee-hybrid\n region: us-central1\n\n org: hybrid-org\n\n virtualhosts:\n - name: default\n hostAliases:\n - \"*.acme.com\"\n sslCertPath: ./certs/keystore.pem\n sslKeyPath: ./certs/keystore.key\n routingRules:\n - paths:\n - /foo\n - /bar\n env: test\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 hostAlias: \"mart.apigee-hybrid-docs.net\"\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json\n sslCertPath: ./certs/fullchain.pem\n sslKeyPath: ./certs/privkey.key\n\n cassandra:\n hostNetwork: true\n dnsPolicy: ClusterFirstWithHostNet\n\n ingress:\n runtime:\n loadBalancerIP: 21.0.124.13\n mart:\n loadBalancerIP: 21.0.124.14\n\n metrics:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json\n\n logger:\n enabled: false\n ```\n | Although not required for this quick start installation, it's a good practice to create static IP addresses for the two ingress gateways that are exposed outside the cluster. These ingress gateways are used for MART and for handling API proxy traffic. For configuration details, see [Configure static IP addresses](/apigee/docs/hybrid/v1.2/static-ip).\n5. When your 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.2/config-prop-ref).\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.2/install-create-cluster-anthos) [2](/apigee/docs/hybrid/v1.2/install-download-install-anthos) [3](/apigee/docs/hybrid/v1.2/install-copy-overrides-anthos) [(NEXT) Step 4: Install hybrid runtime](/apigee/docs/hybrid/v1.2/install-apply-hybrid-anthos)\n\n\u003cbr /\u003e"]]
