Konfigurationsüberschreibungen festlegen
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
in das Verzeichnis$APIGEECTL_HOME
/examplesoverrides
:cp
$APIGEECTL_HOME
/examples/overrides-small.yaml ./overrides/overrides.yamlDiese 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 Verzeichnisoverrides
einbinden:- Ö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 in der nachfolgenden Tabelle beschrieben.gcp: region: gcp-region projectID: gcp-project-id k8sCluster: name: cluster-name region: cluster-region org: org-name virtualhosts: - name: virtual-host-name hostAliases: - "host-alias-1" - "host-alias-2" - "host-alias-n" sslCertPath: ./certs/cert-name.pem sslKeyPath: ./certs/key-name.key routingRules: - paths: - /path-1 - /path-2 - /path-n env: environment-name envs: - name: environment-name # The same name of the env you created in the UI serviceAccountPaths: synchronizer: ./service-accounts/synchronizer-service-account-name.json udca: ./service-accounts/udca-service-account-name.json mart: hostAlias: mart-host-alias serviceAccountPath: ./service-accounts/mart-service-account-name.json sslCertPath: ./certs/mart-cert-name.pem sslKeyPath: ./certs/mart-key-name.key metrics: serviceAccountPath: ./service-accounts/metrics-service-account-name.json logger: enabled: false
Beispiel
Das folgende Beispiel zeigt eine fertige Überschreibungsdatei mit hinzugefügten Attributwerten:
gcp: region: us-central1 projectID: my-gcp-project k8sCluster: name: apigee-hybrid region: us-central1 org: hybrid-org virtualhosts: - name: default hostAliases: - "*.acme.com" sslCertPath: ./certs/keystore.pem sslKeyPath: ./certs/keystore.key routingRules: # - paths: - env: my-environment envs: - name: test serviceAccountPaths: synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json udca: ./service-accounts/hybrid-project-apigee-udca.json mart: hostAlias: "mart.apigee-hybrid-docs.net" serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json sslCertPath: ./certs/fullchain.pem sslKeyPath: ./certs/privkey.key metrics: serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json logger: enabled: false
- Wenn Sie fertig sind, speichern Sie die Datei.
cd overrides
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 |
---|---|
gcp-region | Identifiziert die GCP-Region, in der apigee-logger und apigee-metrics Daten übertragen. |
gcp-project-id | Gibt das Google Cloud-Projekt an, in dem apigee-logger und apigee-metrics ihre Daten per Push übertragen. |
cluster-name | Der Name Ihres Kubernetes-Clusters. |
cluster-region | Die Region, in der der Cluster erstellt wurde. |
org-name | Der Name Ihrer Apigee Hybrid-Organisation. |
virtual-host-name | Ein Name zur Identifizierung des virtuellen Hosts. |
host-alias (1 - n) | (Erforderlich) Ein qualifizierter DNS-Name für die Umgebung. Sie können einen Platzhalter wie |
cert-name 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. Beispiele:
sslCertPath: ./certs/keystore.pem sslKeyPath: ./certs/keystore.key |
path (1 - n) | Routingregeln leiten API-Aufrufe an die bereitgestellten Pfade zur angegebenen Umgebung weiter.
path-1 bis path-n sind die Basispfade zu API-Proxys, die in der Umgebung mit dem Namen environment-name bereitgestellt werden. paths: ist optional. Der Standardpfad ist /. Siehe auch
Virtuelle Hosts konfigurieren.
paths: ist derzeit nicht erforderlich. Löschen oder kommentieren Sie paths: und Pfadeinträge. |
environment-name (unter routingRules ) |
An diese Umgebung werden API-Aufrufe weitergeleitet. Verwenden Sie denselben Namen, den Sie in der UI beim Erstellen einer Umgebung verwendet haben, wie unter Schritt 5: Neue Umgebung in der Hybrid-UI hinzufügen erläutert. . |
environment-name | Verwenden Sie denselben Namen, den Sie in der UI beim Erstellen einer Umgebung verwendet haben, wie unter Schritt 5: Neue Umgebung in der Hybrid-UI hinzufügen erläutert. |
synchronizer-service-account-name | Der Name der Schlüsseldatei des Synchronizer-Dienstkontos, die Sie mit dem create-service-account -Tool generiert haben. Beispiel:
synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json |
udca-service-account-name | Der Name der Schlüsseldatei des udca-Dienstkontos, die Sie mit dem create-service-account -Tool generiert haben. Beispiel:
udca: ./service-accounts/hybrid-project-apigee-udca.json |
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:
sslCertPath: ./certs/fullchain.pem sslKeyPath: ./certs/privkey.key |
metrics-service-account-name | Der Name der Schlüsseldatei des Messwertdienstkontos, die Sie mit dem create-service-account -Tool generiert haben. Beispiel:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json |
Fazit
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.
1 2 3 (ALS NÄCHSTES) Schritt 4: Hybrid-Laufzeit installieren