Referenz zu Konfigurationsattributen

In diesem Abschnitt werden alle Konfigurationsattribute aufgeführt, mit denen Sie die Laufzeitebene Ihrer Bereitstellung von Apigee Hybrid anpassen können.

Diese Seite filtern

Wählen Sie zum Filtern der auf dieser Seite angezeigten Attribute Einfach (am häufigsten verwendete Attribute) oder Erweitert (Attribute, die sich nur selten ändern) aus:

Anzeige   Konfigurationsattribute auf dieser Seite.

Attribute der obersten Ebene

In der folgenden Tabelle werden die Attribute der obersten Ebene in der overrides.yaml-Datei beschrieben. Dies sind Attribute, die nicht zu einem anderen Objekt gehören und auf Organisations- oder Umgebungsebene angewendet werden:

Attribut Typ Beschreibung
axHashSalt Erweitert

Eingeführt in Version: 1.3.0

Standardwert: iloveapis123

Optional

Der Name eines Kubernetes-Secrets, das einen Salt bei der Berechnung von Hashes enthält, um Nutzerdaten zu verschleiern, bevor sie an Apigee Analytics gesendet werden. Wenn Sie keinen Salt-Wert angeben, wird standardmäßig iloveapis123 verwendet. Erstellen Sie das Secret mit dem Salt-Wert als Eingabe. Sie können denselben Salt-Wert für mehrere Cluster verwenden, um konsistente Hash-Ergebnisse zwischen den Clustern zu gewährleisten.

Apigee verwendet SHA512, um den ursprünglichen Wert zu hashen, bevor Daten von der Laufzeitebene an die Steuerungsebene gesendet werden.

Weitere Informationen finden Sie unter Nutzerdaten für Analysen verschleiern.

contractProvider Erweitert Eingeführt in Version: 1.0.0

Standardwert: https://apigee.googleapis.com

Definiert den API-Pfad für alle APIs in Ihrer Installation.

Erforderlich, wenn für Ihre Hybridinstallation der Datenstandort verwendet wird, im folgenden Format:

contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

Dabei ist CONTROL_PLANE_LOCATION der Speicherort, an dem Daten der Steuerungsebene wie Proxy-Bundles gespeichert werden. Eine Liste finden Sie unter Verfügbare Regionen der Apigee API-Steuerungsebene.

Beispiel:

contractProvider: https://us-apigee.googleapis.com
gcpProjectID Erweitert Deprecated: Verwenden Sie für v1.2.0 und höher stattdessen gcp.projectID.

Eingeführt in Version: 1.0.0

Standardwert: keiner

Erforderlich

ID Ihres Google Cloud-Projekts. Funktioniert mit k8sClusterName (verworfen) und gcpRegion (verworfen), um das Projekt zu identifizieren und zu bestimmen, wohin apigee-logger und apigee-metrics ihre Daten per Push übertragen.

gcpRegion Erweitert Deprecated: Verwenden Sie für v1.2.0 und höher stattdessen gcp.region.

Eingeführt in Version: 1.0.0

Standardwert: us-central1

Erforderlich

Die geschlossene Google Cloud-Region oder -Zone Ihres Kubernetes-Clusters. Funktioniert mit gcpProjectID (verworfen) und k8sClusterName (verworfen), um das Projekt zu identifizieren und zu bestimmen, wohin apigee-logger und apigee-metrics ihre Daten per Push übertragen.

hub Erweitert Eingeführt in Version: 1.11.0

Standardwert: Keiner

Die URL eines privaten Image-Container-Repositorys, das zum Abrufen von Images für alle Apigee-Komponenten aus einem privaten Repository verwendet wird.

hub bietet einen Standardpfad für alle Apigee Hybrid-Komponenten. Wenn Sie ein privates Repository verwenden, legen Sie die Repository-URL für alle Komponenten mit hub fest, anstatt die einzelne image.url-Property für jede Komponente zu verwenden. Konfigurieren Sie einzelne URLs nur, wenn Sie ein separates Repository für eine bestimmte Komponente verwenden.

Der Bildpfad für jede einzelne Komponente ist der Wert von hub plus der Bildname und das Tag für die Komponente.

Lautet der Wert von hub beispielsweise private-docker-host.example.com, lösen einzelne Komponenten automatisch den Image-Pfad auf:

hub: private-docker-host.example.com

als:

## an example of internal component vs 3rd party
containers:
- name: apigee-udca
  image: private-docker-host.example.com/apigee-udca:1.13.4
  imagePullPolicy: IfNotPresent

containers:
- name: apigee-ingressgateway
  image: private-docker-host.example.com/apigee-asm-ingress:1.18.7-asm.4-distroless
  imagePullPolicy: IfNotPresent

Für die anderen Komponenten gilt ein ähnliches Muster.

Mit apigee-pull-push --list können Sie die aktuelle Repository-URL für alle Komponenten aufrufen.

Privates Image-Repository mit Apigee Hybrid verwenden.

Sie können die Bild-URL für Komponenten einzeln mit den folgenden Attributen überschreiben:

imagePullSecrets.name Erweitert Eingeführt in Version: 1.0.0

Standardwert: Keiner

Als Kubernetes-Secret-Name konfigurierter Docker-Registry-Typ zum Abrufen von Images aus einem privaten Repository.

instanceID Einfach Eingeführt in Version: 1.3.0

Standardwert: Keiner

Erforderlich

Eine eindeutige Kennung für diese Installation.

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

k8sClusterName Erweitert Deprecated: Verwenden Sie für v1.2.0 und höher stattdessen k8sCluster.name oder k8sCluster.region.

Eingeführt in Version: 1.0.0

Standardwert: Keiner

Name des Kubernetes-Clusters (K8S), in dem Ihr Hybrid-Projekt ausgeführt wird. Funktioniert mit gcpProjectID (verworfen) und gcpRegion (verworfen), um das Projekt zu identifizieren und zu bestimmen, wohin apigee-logger und apigee-metrics ihre Daten per Push übertragen.

kmsEncryptionKey Erweitert Eingeführt in Version: 1.0.0

Standardwert: defaults.org.kmsEncryptionKey

Optional. Verwenden Sie nur eines der Elemente kmsEncryptionKey oder kmsEncryptionKey oder kmsEncryptionKey.

Lokaler Dateisystempfad für den Verschlüsselungsschlüssel von Apigee KMS-Daten.

kmsEncryptionPath Erweitert Eingeführt in Version: 1.2.0

Standardwert: Keiner

Optional. Verwenden Sie nur eines der Elemente kmsEncryptionKey oder kmsEncryptionKey oder kmsEncryptionKey.

Der Pfad zu einer Datei, die einen base64-codierten Verschlüsselungsschlüssel enthält. Siehe Datenverschlüsselung.

kmsEncryptionSecret.key Erweitert Eingeführt in Version: 1.2.0

Standardwert: Keiner

Optional. Verwenden Sie nur eines der Elemente kmsEncryptionKey oder kmsEncryptionKey oder kmsEncryptionKey.

Der Schlüssel eines Kubernetes-Secrets mit einem base64-codierten Verschlüsselungsschlüssel. Siehe Datenverschlüsselung.

kmsEncryptionSecret.name Erweitert Eingeführt in Version: 1.2.0

Standardwert: Keiner

Optional. Verwenden Sie nur eines der Elemente kmsEncryptionKey oder kmsEncryptionKey oder kmsEncryptionKey.

Name eines Kubernetes-Secrets mit einem base64-codierten Verschlüsselungsschlüssel. Siehe Datenverschlüsselung.

kvmEncryptionKey Erweitert Eingeführt in Version: 1.0.0

Standardwert: defaults.org.kmsEncryptionKey

Optional. Verwenden Sie nur eines der Elemente kvmEncryptionKey oder kvmEncryptionKey oder kvmEncryptionKey.

Lokaler Dateisystempfad für den Verschlüsselungsschlüssel von Apigee KVM-Daten.

kvmEncryptionPath Erweitert Eingeführt in Version: 1.2.0

Standardwert: Keiner

Optional. Verwenden Sie nur eines der Elemente kvmEncryptionKey oder kvmEncryptionKey oder kvmEncryptionKey.

Der Pfad zu einer Datei, die einen base64-codierten Verschlüsselungsschlüssel enthält. Siehe Datenverschlüsselung.

kvmEncryptionSecret.key Erweitert Eingeführt in Version: 1.2.0

Standardwert: Keiner

Optional. Verwenden Sie nur eines der Elemente kvmEncryptionKey oder kvmEncryptionKey oder kvmEncryptionKey.

Der Schlüssel eines Kubernetes-Secrets mit einem base64-codierten Verschlüsselungsschlüssel. Siehe Datenverschlüsselung.

kvmEncryptionSecret.name Erweitert Eingeführt in Version: 1.2.0

Standardwert: Keiner

Optional. Verwenden Sie nur eines der Elemente kvmEncryptionKey oder kvmEncryptionKey oder kvmEncryptionKey.

Name eines Kubernetes-Secrets mit einem base64-codierten Verschlüsselungsschlüssel. Siehe Datenverschlüsselung.

multiOrgCluster Erweitert Eingeführt in Version: 1.10.0

Standardwert: false

Bei Clustern für mehrere Organisationen können mit diesem Attribut die Messwerte der Organisation in das Projekt exportiert werden, das im Attribut gcp.projectID aufgeführt ist. Wenden Sie diese Einstellung in der Überschreibungsdatei für jede Organisation in einem Cluster für mehrere Organisationen. Weitere Informationen finden Sie unter Mehrere Hybridorganisationen einem Cluster hinzufügen.

namespace Einfach Eingeführt in Version: 1.0.0

Standardwert: apigee

Der Namespace Ihres Kubernetes-Clusters, in dem die Apigee-Komponenten installiert werden.

org Einfach

Eingeführt in Version: 1.0.0

Standardwert: Keiner

Erforderlich

Die Hybrid-fähige Organisation, die von Apigee während der Hybridinstallation bereitgestellt wurde. Eine Organisation ist der übergeordnete Container in Apigee. Sie enthält alle Ihre API-Proxys und die zugehörigen Ressourcen. Wenn der Wert leer ist, müssen Sie ihn nach dem Erstellen mit dem Namen Ihrer Organisation aktualisieren.

orgScopedUDCA Erweitert Eingeführt in Version: 1.8.0

Standardwert: true

Aktiviert den UDCA-Dienst (Universal Data Collection Agent) auf Organisationsebene, der Analysen, Monetarisierung und Fehlerbehebung (Trace) extrahiert und an die Unified Analytics Platform (UAP) sendet, die sich auf der Steuerungsebene befindet.

Die UDCA auf Organisationsebene verwendet ein einziges Google-Dienstkonto für alle Apigee-Umgebungen. Das Dienstkonto muss die Rolle „Apigee Analytics-Agent“ (roles/apigee.analyticsAgent) haben.

Geben Sie den Pfad zur Dienstkontoschlüsseldatei mit dem Attribut udca.serviceAccountPath an oder stellen Sie den Schlüssel in einem Kubernetes-Secret mit dem Attribut udca.serviceAccountRef in Ihrer overrides.yaml-Konfigurationsdatei bereit.

Wenn Sie einen separaten UDCA-Agent für jede Umgebung verwenden möchten, legen Sie orgScopedUDCA: false fest und legen Sie die Werte für envs[].serviceAccountPaths.udca und envs[].serviceAccountSecretRefs.udca fest.

Siehe auch: UDCA.

revision Erweitert Eingeführt in Version: 1.0.0

Standardwert:"1134" (Ihre Apigee Hybrid-Version ohne Punkte. Bei Version 1.12.0 ist der Standardwert beispielsweise "1120".)

Apigee Hybrid unterstützt das Rollout von Kubernetes-Updates, die Bereitstellungsaktualisierungen ohne Ausfallzeit ermöglichen, indem sie Pod-Instanzen schrittweise mit neuen aktualisieren.

Beim Aktualisieren bestimmter YAML-Überschreibungen, die zu einer zugrunde liegenden Kubernetes-PodTemplateSpec-Änderung führen, muss auch das revision-Überschreibungsattribut in der override.yaml des Kunden geändert werden. Dies ist erforderlich, damit der zugrunde liegende Kubernetes ApigeeDeployment-Controller (AD) ein sicheres Rolling Update von der vorherigen Version auf die neue Version durchführt. Sie können einen beliebigen Kleinbuchstabenwert verwenden, z. B. blue, a, 1.0.0.

Wird das revision-Attribut geändert und angewendet, wird für alle Komponenten ein Rolling Update durchgeführt.

Bei Änderungen an den Attributen der folgenden Objekte muss revision aktualisiert werden:

Weitere Informationen finden Sie unter Rolling Updates.

serviceAccountSecretProviderClass Erweitert Eingeführt in Version: 1.12.0

Standardwert: Keiner

Der Name der organisationsspezifischen Secret-Provider-Klasse (SecretProviderClass), die zum Speichern von Dienstkontoschlüsseln in Vault verwendet wird.

Dienstkontoschlüssel in Hashicorp Vault speichern.

validateOrg Erweitert Eingeführt in Version: 1.8.0

Standardwert: true

Ermöglicht eine strenge Validierung der Verknüpfung zwischen dem Apigee-Organisations- und dem Google Cloud-Projekt und prüft, ob Umgebungsgruppen vorhanden sind.

Siehe auch: org

validateServiceAccounts Erweitert Eingeführt in Version: 1.0.0

Standardwert: true

Ermöglicht eine strenge Validierung von Dienstkontoberechtigungen. Dadurch wird mithilfe der Cloud Resource Manager API-Methode testIamPermissions geprüft, ob das angegebene Dienstkonto die erforderlichen Berechtigungen hat. Bei Dienstkonten für eine Apigee-Organisation ist die Projekt-ID-Prüfung diejenige, die der Organisation zugeordnet ist. Für Messwerte und Logger basiert das geprüfte Projekt auf der Konfiguration gcpProjectID overrides.yaml.

Siehe auch: gcpProjectID

ao

Apigee Operators (AO) erstellt und aktualisiert untergeordnete Kubernetes- und Istio-Ressourcen, die zur Bereitstellung und Verwaltung einer Komponente erforderlich sind. Beispielsweise führt der Controller den Release von Nachrichtenprozessoren aus.

In folgender Tabelle werden die Attribute des ao-Objekts von Apigee Operators beschrieben:

Attribut Typ Beschreibung
ao.args.disableIstioConfigInAPIServer Erweitert Eingeführt in Version: 1.8.0

Standardwert: true

Hindert Apigee daran, die Konfiguration für vom Kunden installiertes Cloud Service Mesh bereitzustellen.

  • Legen Sie true für Hybridinstallationen mit dem Apigee Ingress-Gateway fest.
  • Legen Sie false für Hybridinstallationen mit Cloud Service Mesh (Apigee Hybridversionen 1.8 und früher) fest.
ao.args.disableManagedClusterRoles Erweitert Eingeführt in Version: 1.10.0

Standardwert: true

Wenn true (Standardeinstellung) verwaltet Apigee Hybrid ClusterRole und ClursterRoleBinding von Kubernetes nicht direkt. Wenn Sie einen Prozess haben, der die Verwaltung dieser Ressourcen erfordert, muss der Prozess von einem Nutzer mit den entsprechenden Berechtigungen ausgeführt werden.

ao.image.pullPolicy Erweitert Eingeführt in Version: 1.2.0

Standardwert: IfNotPresent

Legt fest, wann kubelet das Docker-Image des Pods abruft. Zulässige Werte:

  • IfNotPresent: Rufen Sie kein neues Image ab, das bereits vorhanden ist.
  • Always: Das Image wird immer abgerufen, unabhängig davon, ob es bereits vorhanden ist.

Weitere Informationen finden Sie unter Images aktualisieren.

ao.image.tag Erweitert Eingeführt in Version: 1.2.0

Standardwert: 1.13.4

Das Versionslabel für das Docker-Image dieses Dienstes.

ao.image.url Erweitert Eingeführt in Version: 1.2.0

Standardwert: Keiner

Der Speicherort des Docker-Image für diesen Dienst.

Mit apigee-pull-push --list können Sie die aktuelle Repository-URL für diese Komponente aufrufen.

ao.resources.limits.cpu Erweitert Eingeführt in Version: 1.2.0

Standardwert: 250m

Das CPU-Limit für die Ressource in einem Kubernetes-Container in Millicore.

ao.resources.limits.memory Erweitert Eingeführt in Version: 1.2.0

Standardwert: 256Mi

Das Speicherlimit für die Ressource in einem Kubernetes-Container in Mebibyte.

ao.resources.requests.cpu Erweitert Eingeführt in Version: 1.2.0

Standardwert: 250m

Die CPU, die für den normalen Betrieb der Ressource in einem Kubernetes-Container in Millicore erforderlich ist.

ao.resources.requests.memory Erweitert Eingeführt in Version: 1.2.0

Standardwert: 256Mi

Der erforderliche Arbeitsspeicher für die Ressource in einem Kubernetes-Container in Mebibyte.

ao.tolerations.effect Erweitert Eingeführt in Version: 1.10.1

Standardwert: Keiner

Erforderlich, um das Markierungs- und Toleranzfeature von Kubernetes zu verwenden.

effect gibt die Auswirkung an, die eine Übereinstimmung mit einer Toleranz mit einer Markierung hat. effect kann folgende Werte haben:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

ao.tolerations.key Erweitert Eingeführt in Version: 1.10.1

Standardwert: Keiner

Erforderlich, um das Markierungs- und Toleranzfeature von Kubernetes zu verwenden.

key identifiziert Pods, auf die die Toleranz angewendet werden kann.

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

ao.tolerations.operator Erweitert Eingeführt in Version: 1.10.1

Standardwert: "Equal"

Erforderlich, um das Markierungs- und Toleranzfeature von Kubernetes zu verwenden.

operator gibt den Vorgang an, der zum Auslösen von effect verwendet wird. operator kann folgende Werte haben:

  • Equal entspricht dem in value festgelegten Wert.
  • Exists ignoriert den in value festgelegten Wert.

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

ao.tolerations.tolerationSeconds Erweitert Eingeführt in Version: 1.10.1

Standardwert: Keiner

Wird vom Markierungs- und Toleranzfeature von Kubernetes verwendet.

tolerationSeconds definiert in Sekunden, wie lange ein Pod an einen fehlerhaften oder nicht reagierenden Knoten gebunden ist.

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

ao.tolerations.value Erweitert Eingeführt in Version: 1.10.1

Standardwert: Keiner

Wird vom Markierungs- und Toleranzfeature von Kubernetes verwendet.

value ist der Wert, der effect auslöst, wenn operator auf Equal gesetzt ist.

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

apigeeIngressGateway

Konfiguriert das Apigee Ingress-Gateway für Apigee Hybrid. Verwenden Sie apigeeIngressGateway-Attribute, um eine gemeinsame Konfiguration auf alle Instanzen des Apigee-Ingress-Gateways anzuwenden.

Informationen zum Konfigurieren einzelner Instanzen finden Sie unter ingressGateways.

Wenden Sie Änderungen an apigeeIngressGateway-Eigenschaften mit dem apigee-org-Diagramm an.

In der folgenden Tabelle werden die Attribute des apigeeIngressGateway-Objekts beschrieben:

Attribut Typ Beschreibung
apigeeIngressGateway.image.pullPolicy Erweitert Eingeführt in Version: 1.11.0

Standardwert: IfNotPresent

Legt fest, wann kubelet das Docker-Image des Pods abruft. Zulässige Werte:

  • IfNotPresent: Rufen Sie kein neues Image ab, das bereits vorhanden ist.
  • Always: Das Image wird immer abgerufen, unabhängig davon, ob es bereits vorhanden ist.

Weitere Informationen finden Sie unter Images aktualisieren.

apigeeIngressGateway.image.tag Erweitert Eingeführt in Version: 1.11.0

Standardwert: 1.18.7-asm.4-distroless

Das Versionslabel für das Docker-Image dieses Dienstes.

apigeeIngressGateway.image.url Erweitert Eingeführt in Version: 1.11.0

Standardwert: Keiner

Der Speicherort des Docker-Image für diesen Dienst.

Mit apigee-pull-push --list können Sie die aktuelle Repository-URL für diese Komponente aufrufen.

apigeeIngressGateway.nodeSelector.key Erweitert Eingeführt in Version: 1.11.0

Standardwert: Keiner

Erforderlich

Knotenselektorlabelschlüssel, der zur Ausrichtung auf dedizierte Kubernetes-Knoten für Ingress-Gateway-Dienste verwendet wird.

Siehe Dedizierte Knotenpools konfigurieren.

apigeeIngressGateway.nodeSelector.value Erweitert Eingeführt in Version: 1.11.0

Standardwert: Keiner

Optionaler Labelwert für den Knotenselektor, der auf bestimmte Kubernetes-Knoten für Ingress-Gateway-Dienste ausgerichtet ist und die nodeSelector.apigeeData-Einstellungen überschreibt.

Siehe nodeSelector.

apigeeIngressGateway.replicaCountMax Einfach Eingeführt in Version: 1.11.0

Standardwert: 4

Die maximale Anzahl von Pods, die Hybrid automatisch für das für Autoscaling verfügbare Ingress-Gateway hinzufügen kann.

apigeeIngressGateway.replicaCountMin Einfach Eingeführt in Version: 1.11.0

Standardwert: 2

Die Mindestanzahl der Pods für das Ingress-Gateway, die für die automatische Skalierung verfügbar sind.

apigeeIngressGateway.targetCPUUtilizationPercentage Erweitert Eingeführt in Version: 1.10.5, 1.11.2, 1.12.1

Standardwert: 75

Der Schwellenwert der CPU-Auslastung zur Skalierung der Anzahl der Pods im ReplicaSet als Prozentsatz der insgesamt verfügbaren CPU-Ressourcen.

Wenn die CPU-Nutzung diesen Wert überschreitet, erhöht Hybrid die Anzahl der Pods im ReplicaSet bis zu apigeeIngressGateway.replicaCountMax.

Weitere Informationen zur Skalierung in Kubernetes finden Sie in der Kubernetes-Dokumentation unter Horizontal Pod Autoscaling.

apigeeIngressGateway.tolerations.effect Erweitert Eingeführt in Version: 1.11.0

Standardwert: Keiner

Erforderlich, um das Markierungs- und Toleranzfeature von Kubernetes zu verwenden.

effect gibt die Auswirkung an, die eine Übereinstimmung mit einer Toleranz mit einer Markierung hat. effect kann folgende Werte haben:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

apigeeIngressGateway.tolerations.key Erweitert Eingeführt in Version: 1.11.0

Standardwert: Keiner

Erforderlich, um das Markierungs- und Toleranzfeature von Kubernetes zu verwenden.

key identifiziert Pods, auf die die Toleranz angewendet werden kann.

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

apigeeIngressGateway.tolerations.operator Erweitert Eingeführt in Version: 1.11.0

Standardwert: "Equal"

Erforderlich, um das Markierungs- und Toleranzfeature von Kubernetes zu verwenden.

operator gibt den Vorgang an, der zum Auslösen von effect verwendet wird. operator kann folgende Werte haben:

  • Equal entspricht dem in value festgelegten Wert.
  • Exists ignoriert den in value festgelegten Wert.

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

apigeeIngressGateway.tolerations.tolerationSeconds Erweitert Eingeführt in Version: 1.11.0

Standardwert: Keiner

Wird vom Markierungs- und Toleranzfeature von Kubernetes verwendet.

tolerationSeconds definiert in Sekunden, wie lange ein Pod an einen fehlerhaften oder nicht reagierenden Knoten gebunden ist.

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

apigeeIngressGateway.tolerations.value Erweitert Eingeführt in Version: 1.11.0

Standardwert: Keiner

Wird vom Markierungs- und Toleranzfeature von Kubernetes verwendet.

value ist der Wert, der effect auslöst, wenn operator auf Equal gesetzt ist.

Weitere Informationen finden Sie unter Markierungen und Toleranzen: Konzepte.

cassandra

Definiert den Hybrid-Dienst, der das Laufzeitdaten-Repository verwaltet. Dieses Repository speichert Anwendungskonfigurationen, verteilte Kontingentzähler, API-Schlüssel und OAuth-Tokens für Anwendungen, die auf dem Gateway ausgeführt werden.

Weitere Informationen finden Sie unter StorageClass-Konfiguration.

In der folgenden Tabelle werden die Attribute des cassandra-Objekts beschrieben:

Attribut Typ Beschreibung
cassandra.annotations Erweitert Einführung in Version: 1.5.0

Standardwert: Keiner

Optionale Schlüssel/Wert-Zuordnung, die zum Annotieren von Pods verwendet wird. Weitere Informationen finden Sie unter Benutzerdefinierte Annotationen.

cassandra.auth.admin.password Einfach Eingeführt in Version: 1.0.0

Standardwert: iloveapis123

Erforderlich

Passwort für den Cassandra-Administrator. Der Administrator wird für alle Administratoraktivitäten verwendet, die im Cassandra-Cluster ausgeführt werden, z. B. Sicherung und Wiederherstellung.

cassandra.auth.ddl.password Einfach Eingeführt in Version: 1.0.0

Standardwert: iloveapis123

Erforderlich

Passwort für den Nutzer von Cassandra Data Definition Language (DDL). Wird von MART für beliebige Datendefinitionsaufgaben wie das Erstellen, Aktualisieren und Löschen von Schlüsselbereichen verwendet.

cassandra.auth.default.password Einfach Eingeführt in Version: 1.0.0

Standardwert: iloveapis123

Erforderlich

Das Passwort für den Cassandra-Standardnutzer, der bei aktivierter Authentifizierung erstellt wird. Dieses Passwort muss zurückgesetzt werden, wenn Sie die Cassandra-Authentifizierung konfigurieren. Weitere Informationen finden Sie unter TLS für Cassandra konfigurieren.

cassandra.auth.dml.password Einfach Eingeführt in Version: 1.0.0

Standardwert: iloveapis123

Erforderlich

Passwort für den Nutzer von Cassandra Data Manipulation Language. Der DML-Nutzer wird von der Clientkommunikation verwendet, um Daten in Cassandra zu lesen und zu schreiben.

cassandra.auth.image.pullPolicy Erweitert Eingeführt in Version: 1.0.0

Standardwert: IfNotPresent

Legt fest, wann kubelet das Docker-Image des Pods abruft. Zulässige Werte:

  • IfNotPresent: Rufen Sie kein neues Image ab, das bereits vorhanden ist.
  • Always: Das Image wird immer abgerufen, unabhängig davon, ob es bereits vorhanden ist.

Weitere Informationen finden Sie unter Images aktualisieren.

cassandra.auth.image.tag Erweitert Eingeführt in Version: 1.0.0

Standardwert: 1.13.4

Das Versionslabel für das Docker-Image dieses Dienstes.

cassandra.auth.image.url Erweitert Eingeführt in Version: 1.0.0

Standardwert: Keiner

Der Speicherort des Docker-Image für diesen Dienst.

Mit apigee-pull-push --list können Sie die aktuelle Repository-URL für diese Komponente aufrufen.

cassandra.auth.jmx.password Einfach Eingeführt in Version: 1.4.0

Standardwert: iloveapis123

Erforderlich

Passwort für den Cassandra JMX-Betriebsnutzer. Wird zur Authentifizierung und Kommunikation mit der Cassandra JMX-Schnittstelle verwendet.

cassandra.auth.jmx.username Einfach Eingeführt in Version: 1.4.0

Standardwert: jmxuser

Erforderlich

Nutzername für den Cassandra JMX-Betriebsnutzer. Wird zur Authentifizierung und Kommunikation mit der Cassandra JMX-Schnittstelle verwendet.

cassandra.auth.jolokia.password Einfach Eingeführt in Version: 1.4.0

Standardwert: iloveapis123

Erforderlich

Passwort für den Cassandra Jolokia JMX-Betriebsnutzer. Wird zur Authentifizierung und Kommunikation mit der Cassandra JMX API verwendet.

cassandra.auth.jolokia.username Einfach Eingeführt in Version: 1.4.0

Standardwert: apigee

Erforderlich

Nutzername für den Cassandra Jolokia JMX-Betriebsnutzer. Wird zur Authentifizierung und Kommunikation mit der Cassandra JMX API verwendet.

cassandra.auth.secret Einfach Eingeführt in Version:1.3.3

Standardwert: Keiner

Der Name der Datei, die in einem Kubernetes-Secret gespeichert ist, das die Cassandra-Nutzer und -Passwörter enthält. Sie können das Secret mit der folgenden Anleitung erstellen: Secret erstellen.

Siehe auch:

cassandra.auth.secretProviderClass Erweitert Eingeführt in Version: 1.10.3

Standardwert: Keiner

Die Cassandra-Secret-Speicher-Richtlinie. Wenn diese festgelegt ist, muss sie mit der SecretProviderClass übereinstimmen, die auf den externen Secret-Anbieter verweist, z. B. Hashicorp Vault. Wenn sie nicht festgelegt ist, verwendet Apigee Hybrid entweder die hier gespeicherten Nutzernamen und Passwörter:

oder das hier gespeicherte Kubernetes-Secret:

Eine Anleitung zum Erstellen der Richtlinie finden Sie unter Cassandra-Secrets in Hashicorp Vault speichern.

cassandra.backup.cloudProvider Erweitert Eingeführt in Version: 1.0.0

Standardwert: GCP

Der Name eines Sicherungsanbieters. Unterstützte Werte: GCP, HYBRID und CSI. Legen Sie den Wert fest auf:

  • GCP zum Speichern von Sicherungsarchiven in Google Cloud Storage.
  • HYBRID, um Sicherungsarchive auf einem Remote-SSH-Server zu speichern.
  • CSI (empfohlen) zur Verwendung von Kubernetes-CSI-VolumeSnapshots für die Sicherung. Informationen zum Sichern und Wiederherstellen in CSI für Cloud-Plattformen wie Google Cloud, AWS und Azure finden Sie unter CSI-Sicherung und -Wiederherstellung.
cassandra.backup.dbStorageBucket Erweitert Eingeführt in Version: 1.0.0

Standardwert: Keiner

Erforderlich, wenn die Sicherung aktiviert ist und cassandra.backup.cloudProvider auf GCP gesetzt ist.

Der Name eines vorhandenen Google Cloud Storage-Bucket, in dem Sicherungsarchive gespeichert werden. Informationen zum Erstellen eines Buckets finden Sie unter Buckets erstellen.

cassandra.backup.enabled Erweitert Eingeführt in Version: 1.0.0

Standardwert: false

Die Datensicherung ist nicht standardmäßig aktiviert. Setzen Sie den Wert auf true, um die Funktion zu aktivieren.

Siehe Cassandra-Back-up und -Wiederherstellung.

cassandra.backup.gsa Erweitert Eingeführt in Version: 1.10.0

Standardwert: Keiner

Nur Helm: Die E-Mail-Adresse des apigee-cassandra Google IAM-Dienstkontos (GSA), das beim Aktivieren von Workload Identity in GKE-Clustern mit dem Kubernetes-Dienstkonto für Cassandra-Back-ups verknüpft werden soll. Legen Sie dies fest, wenn Sie für gcp.workloadIdentity.enabled den Wert true und für cassandra.backup.enabled den Wert true festgelegt haben.

GSA-E-Mail-Adressen haben normalerweise folgendes Format:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Beispiel:

apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com

Weitere Informationen finden Sie unter Identitätsföderation von Arbeitslasten in GKE aktivieren.

cassandra.backup.image.pullPolicy Erweitert Eingeführt in Version: 1.0.0

Standardwert: IfNotPresent

Legt fest, wann kubelet das Docker-Image des Pods abruft. Zulässige Werte:

  • IfNotPresent: Rufen Sie kein neues Image ab, das bereits vorhanden ist.
  • Always: Das Image wird immer abgerufen, unabhängig davon, ob es bereits vorhanden ist.

Weitere Informationen finden Sie unter Images aktualisieren.

cassandra.backup.image.tag Erweitert Eingeführt in Version: 1.0.0

Standardwert: 1.13.4

Das Versionslabel für das Docker-Image dieses Dienstes.

cassandra.backup.image.url Erweitert Eingeführt in Version: 1.0.0

Standardwert: Keiner

Der Speicherort des Docker-Image für diesen Dienst.

Mit apigee-pull-push --list können Sie die aktuelle Repository-URL für diese Komponente aufrufen.

cassandra.backup.keyfile Erweitert Eingeführt in Version: 1.3.0

Standardwert: Keiner

Erforderlich, wenn die Sicherung aktiviert ist und cassandra.backup.cloudProvider auf HYBRID gesetzt ist.

Der Pfad in Ihrem lokalen Dateisystem zur privaten SSH-Schlüsseldatei.

cassandra.backup.schedule Erweitert Eingeführt in Version: 1.0.0

Standardwert: 0 2 * * *

Der Zeitplan für den Wiederherstellungs-Cronjob.

Siehe Cassandra-Back-up und -Wiederherstellung.

cassandra.backup.server Erweitert Eingeführt in Version: 1.3.0

Standardwert: Keiner

Erforderlich, wenn die Sicherung aktiviert ist und cassandra.backup.cloudProvider auf HYBRID gesetzt ist.

Die IP-Adresse Ihres Remote-SSH-Sicherungsservers.

cassandra.backup.serviceAccountPath Erweitert Eingeführt in Version: 1.0.0

Standardwert: Keiner

Pfad zu einer Google-Dienstkonto-Schlüsseldatei mit der Rolle Storage-Objekt-Administrator (roles/storage.objectAdmin). Dieses Google-Dienstkonto wird zum Hochladen von Sicherungsarchiven in ein angegebenes cassandra.backup.dbStorageBucket verwendet.

Wenn die Sicherung aktiviert ist und cassandra.backup.cloudProvider auf GCP festgelegt ist, ist eine der folgenden Optionen erforderlich, damit Apigee Hybrid auf den Google Cloud Storage-Bucket zugreifen und Sicherungsarchive hochladen kann:

cassandra.backup.serviceAccountRef Erweitert Eingeführt in Version: 1.2.0

Standardwert: Keiner

Der Name eines vorhandenen Kubernetes-Secrets, in dem der Inhalt einer Google-Dienstkonto-Schlüsseldatei mit der Rolle Storage-Objekt-Administrator (roles/storage.objectAdmin) gespeichert ist. Dieses Google-Dienstkonto wird zum Hochladen von Sicherungsarchiven in ein angegebenes cassandra.backup.dbStorageBucket verwendet.

Wenn die Sicherung aktiviert ist und cassandra.backup.cloudProvider auf GCP festgelegt ist, ist eine der folgenden Optionen erforderlich, damit Apigee Hybrid auf den Google Cloud Storage-Bucket zugreifen und Sicherungsarchive hochladen kann:

cassandra.backup.storageDirectory Erweitert Eingeführt in Version: 1.3.0

Standardwert: Keiner

Erforderlich, wenn die Sicherung aktiviert ist und cassandra.backup.cloudProvider auf HYBRID gesetzt ist.

Kann entweder ein absoluter oder relativer Pfad zum Basisverzeichnis apigee des Nutzers sein.

Der Name des Sicherungsverzeichnisses auf dem SSH-Sicherungsserver.

cassandra.clusterName Einfach Eingeführt in Version: 1.0.0

Standardwert: apigeecluster

Gibt den Namen des Cassandra-Clusters an.

cassandra.datacenter Einfach Eingeführt in Version: 1.0.0

Standardwert: dc-1

Gibt das Rechenzentrum des Cassandra-Knotens an.

cassandra.dnsPolicy Einfach Einführung in Version: 1.1.1

Standardwert: Keiner

Wenn Sie hostNetwork auf "true" setzen, wird die DNS-Richtlinie auf ClusterFirstWithHostNet gesetzt.

cassandra.externalSeedHost Einfach Eingeführt in Version: 1.0.0

Standardwert: Keiner

Hostname oder IP-Adresse eines Cassandra-Clusterknotens. Wenn nicht festgelegt, wird der lokale Kubernetes-Dienst verwendet.

cassandra.heapNewSize Einfach Eingeführt in Version: 1.0.0

Standardwert: 100M

Die Menge des dem neueren Objekt zugewiesenen JVM-Speichers in Megabyte.

cassandra.hostNetwork Einfach Einführung in Version: 1.1.1

Standardwert: false

Aktiviert das Feature hostNetwork von Kubernetes. Apigee verwendet diese Funktion in Installationen mit mehreren Regionen für die Kommunikation zwischen Pods, wenn der Pod-Netzwerk-Namespace keine Verbindung zwischen Clustern hat (die Cluster werden im „Island Network Mode“ ausgeführt). Dies ist der Standardfall bei Nicht-GKE-Installationen, einschließlich Google Distributed Cloud auf VMware oder Bare Metal, GKE auf AWS, AKS, EKS und OpenShift.

Setzen Sie cassandra.hostNetwork auf false für Installationen in einer einzigen Region und für multiregionale Installationen mit Konnektivität zwischen Pods in verschiedenen Clustern, z. B. GKE-Installationen.

Setzen Sie cassandra.hostNetwork auf true für multiregionale Installationen, bei denen keine Kommunikation zwischen Pods in verschiedenen Clustern stattfindet, z. B. Google Distributed Cloud auf VMware oder Bare Metal, GKE on AWS, AKS, EKS und OpenShift-Installationen. Weitere Informationen finden Sie unter Multiregionale Bereitstellung: Voraussetzungen.

Wenn true, wird die DNS-Richtlinie automatisch auf ClusterFirstWithHostNet gesetzt.

cassandra.image.pullPolicy Erweitert Eingeführt in Version: 1.0.0

Standardwert: IfNotPresent

Legt fest, wann kubelet das Docker-Image des Pods abruft. Zulässige Werte:

  • IfNotPresent: Rufen Sie kein neues Image ab, das bereits vorhanden ist.
  • Always: Das Image wird immer abgerufen, unabhängig davon, ob es bereits vorhanden ist.

Weitere Informationen finden Sie unter Images aktualisieren.

cassandra.image.tag Erweitert Eingeführt in Version: 1.0.0

Standardwert: 1.13.4

Das Versionslabel für das Docker-Image dieses Dienstes.

cassandra.image.url Erweitert Eingeführt in Version: 1.0.0

Standardwert: Keiner

Der Speicherort des Docker-Image für diesen Dienst.

Mit apigee-pull-push --list können Sie die aktuelle Repository-URL für diese Komponente aufrufen.

cassandra.maxHeapSize Erweitert Eingeführt in Version: 1.0.0

Standardwert: 512M

Das obere Limit des JVM-Systemspeichers, der für Cassandra-Vorgänge in Megabyte verfügbar ist.

cassandra.multiRegionSeedHost Einfach Eingeführt in Version: 1.0.0

Standardwert: Keiner

IP-Adresse eines vorhandenen Cassandra-Clusters, mit dem der vorhandene Cluster auf eine neue Region erweitert wird. Seed-Host für mehrere Regionen konfigurieren.

cassandra.nodeSelector.key Erweitert Eingeführt in Version: 1.0.0

Standardwert: Keiner

Erforderlich

Knotenselektorlabelschlüssel, der zur Ausrichtung auf dedizierte Kubernetes-Knoten für cassandra-Datendienste verwendet wird.

Siehe Dedizierte Knotenpools konfigurieren.

cassandra.nodeSelector.value Erweitert Eingeführt in Version: 1.0.0

Standardwert: Keiner

Optionaler Wert für den Knotenselektor, der auf bestimmte Kubernetes-Knoten für cassandra-Datendienste ausgerichtet ist und die nodeSelector.apigeeData-Einstellungen überschreibt.

Siehe nodeSelector.

cassandra.port Erweitert Eingeführt in Version: 1.0.0

Standardwert: 9042

Portnummer zur Verbindung mit Cassandra.

cassandra.rack Einfach Eingeführt in Version: 1.0.0

Standardwert: ra-1

Gibt das Rack des Cassandra-Knotens an.

cassandra.readinessProbe.failureThreshold Erweitert Eingeführt in Version: 1.0.0

Standardwert: 2

Die Häufigkeit, mit der Kubernetes überprüft, ob die Bereitschaftsprüfungen fehlgeschlagen sind, bevor der Pod als nicht bereit markiert wird. Der Mindestwert beträgt 1.

cassandra.readinessProbe.initialDelaySeconds Erweitert Eingeführt in Version: 1.0.0

Standardwert: 0

Die Anzahl der Sekunden nach dem Start eines Containers, bevor eine Bereitschaftsprüfung gestartet wird.

cassandra.readinessProbe.periodSeconds Erweitert Eingeführt in Version: 1.0.0

Standardwert: 10

Bestimmt, wie oft eine Bereitschaftsprüfung in Sekunden durchgeführt werden soll. Der Mindestwert beträgt 1.

cassandra.readinessProbe.successThreshold Erweitert Eingeführt in Version: 1.0.0

Standardwert: 1

Die mindestens aufsteigenden Erfolge, die für eine Bereitschaftsprüfung erforderlich sind, um nach einem Fehler als erfolgreich zu gelten. Der Mindestwert beträgt 1.

cassandra.readinessProbe.timeoutSeconds Erweitert Eingeführt in Version: 1.0.0

Standardwert: 5

Die Anzahl der Sekunden, nach denen eine Aktivitätsprüfung abläuft. Der Mindestwert beträgt 1.

cassandra.replicaCount Einfach Eingeführt in Version: 1.0.0

Standardwert: 1

Cassandra ist eine replizierte Datenbank. Dieses Attribut gibt die Anzahl der Cassandra-Knoten an, die als StatefulSet verwendet werden.

cassandra.resources.requests.cpu Erweitert Eingeführt in Version: 1.0.0

Standardwert: 500m

Die CPU, die für den normalen Betrieb der Ressource in einem Kubernetes-Container in Millicore erforderlich ist.

cassandra.resources.requests.memory Erweitert Eingeführt in Version: 1.0.0

Standardwert: 1Gi

Der erforderliche Arbeitsspeicher für die Ressource in einem Kubernetes-Container in Mebibyte.

cassandra.restore.cloudProvider Erweitert Eingeführt in Version: 1.0.0

Standardwert: GCP

Der Name eines Wiederherstellungsanbieters. Unterstützte Werte: GCP, HYBRID und CSI. Legen Sie den Wert fest auf:

  • GCP, um Daten aus einer Sicherung wiederherzustellen, die in Google Cloud Storage gespeichert ist.
  • HYBRID, um Daten aus einer Sicherung wiederherzustellen, die auf einem Remote-SSH-Server gespeichert ist.
  • CSI (empfohlen), um Kubernetes-CSI-VolumeSnapshots für die Wiederherstellung zu verwenden. Informationen zum Sichern und Wiederherstellen in CSI für Cloud-Plattformen wie Google Cloud, AWS und Azure finden Sie unter