Komponenten der Laufzeitebene verwalten

In diesem Thema wird erläutert, wie Sie die hybriden Komponenten der Laufzeit von Apigee konfigurieren und verwalten.

Informationen zu Überschreibungen

Wenn Sie die Hybridlaufzeit zum ersten Mal in einem Cluster installieren, müssen Sie eine Überschreibungsdatei für die Konfiguration erstellen. Mit dieser Datei können Sie die erforderlichen Attributwerte bereitstellen, die für die Installation von Hybrid erforderlich sind, z. B. den Namen Ihres Google-Projekts, den Namen der Organisation, Umgebungsdetails, Zertifikatsdateien usw. Für die meisten Hybridkomponenten können Sie in der Überschreibungsdatei auch bestimmte Standardwerte überschreiben. Eine vollständige Liste der konfigurierbaren Attribute finden Sie in der Referenz des Konfigurationsattributs.

Bei den hybriden Installationsschritten werden die Schritte zum Erstellen einer Überschreibungsdatei und die Konfiguration auf einen Cluster angewendet. Wenn Sie die Konfiguration später ändern möchten, ändern Sie die erstellte Datei mit den Einstellungen und wenden Sie sie noch einmal an. Siehe Konfigurationsänderung vornehmen.

Konfigurationsänderung vornehmen

Wenn Sie eine Konfigurationsänderung an einer Komponente der Hybrid-Laufzeitebene vornehmen möchten, bearbeiten Sie die Überschreibungsdatei und wenden Sie die Änderungen mit apigeectl an. Eine vollständige Liste der konfigurierbaren Attribute finden Sie in der Referenz des Konfigurationsattributs.

Wenn Sie beispielsweise die Komponente logger aktivieren möchten, aktualisieren Sie die Überschreibungsdatei und wenden Sie sie noch einmal an:

Öffnen Sie die Überschreibungsdatei. Achten Sie darauf, dieselbe Überschreibungsdatei zu verwenden, mit der die Hybrid-Laufzeit im Cluster installiert wurde.
Suchen Sie in der Datei das Element logger. Beispiel:
```
...
logger:
  enabled: false
...
```
Ändern Sie den Attributwert in true:
```
...
  logger:
  enabled: true
...
```
Verwenden Sie apigeectl, um die Änderung auf den Cluster anzuwenden:
```
$APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry
```
Das Flag --telemetry weist apigeectl an, nur die Logger-Komponente zu aktualisieren. Informationen zu Bereichsparametern wie --telemetry finden Sie unter Bereiche für die Anwendung von apigeectl.

Welche Konfigurationsattribute können Sie ändern?

Eine vollständige Liste der konfigurierbaren Attribute finden Sie in der Referenz des Konfigurationsattributs. In der Referenz werden nur die Attribute aufgeführt, die Sie ändern können. Wenn Sie versuchen, ein Attribut zu ändern, das nicht in der Referenz enthalten ist, wird die Änderung ignoriert.

Konfigurationsreferenz verwenden

In der Konfigurationsattributreferenz werden Konfigurationselemente durch Punktschreibweise beschrieben. Das erste Element ist der Name des Elements auf oberster Ebene, gefolgt von Attributen und untergeordneten Eigenschaften. Beispiel:

authz.image.pullPolicy

In der Überschreibungsdatei sind die Attribute in der richtigen YAML-Datei formatiert. Für das obige Beispiel ist das Element authz der obersten Ebene links einrücken. Die untergeordneten Elemente werden darunter eingerückt. Außerdem ist am Ende jedes Elements und des Unterelements ein Doppelpunkt erforderlich.

Wenn Sie beispielsweise das Attribut authz.image.pullPolicy auf Always setzen möchten, suchen Sie die folgende YAML-Stanza in der Überschreibungsdatei und legen Sie sie so fest:

authz:
  image:
    pullPolicy: Always

In einem anderen Beispiel wird das Attribut cassandra.auth.admin.password (wie in der Konfigurationsattributreferenz aufgeführt) verwendet, um das Cassandra-Administratorpasswort festzulegen. Um es zu ändern, suchen Sie die folgende YAML-Datei in der Überschreibungsdatei und legen Sie sie so fest:

cassandra:
  auth:
    admin:
      password: abc123

Denken Sie daran, dass in der Konfigurationsattributreferenz alle Eigenschaften beschrieben werden, die Sie für Komponenten der Hybrid-Laufzeitebene festlegen können. Folgen Sie dem oben beschriebenen Muster, um diese Elemente in Ihrer Überschreibungsdatei zu ändern, bevor Sie die Änderungen auf den Cluster anwenden.

Informationen zu Standardeinstellungen für die Konfiguration

Apigee behält seine Standardkonfiguration der Datei $HYBRID_FILES/config/values.yaml bei. Diese Datei gibt nach Möglichkeit Standardwerte für jede Hybridkomponente an.

Ihre Überschreibungen für Dateien entsprechen derselben YAML-Struktur wie values.yaml. Eine Überschreibungsdatei enthält jedoch nur einen Teil der in values.yaml gefundenen Konfigurationsattribute. Beachten Sie, dass nicht alle Attribute bearbeitet werden können. Wenn Sie eine Konfiguration auf einen Cluster anwenden, werden die Überschreibungen mit den Standardeinstellungen zusammengeführt, um die vollständige Konfiguration des Kubernetes-Clusters zu erstellen.

Wenn Sie die Standardeinstellungen einer Komponente ändern möchten und die Komponente noch nicht in der Überschreibungsdatei enthalten ist, können Sie die YAML-Datei aus values.yaml in die Überschreibungsdatei kopieren und dort ändern.

Bearbeiten Sie values.yaml nicht direkt. Verwenden Sie immer eine Überschreibungsdatei, um Ihre Konfigurationsattribute anzugeben.

Vordefinierte Beispiele von Überschreibungsdateien verwenden

Apigee bietet eine Reihe von Beispielüberschreibungen für Dateien, die Sie bei der Einrichtung Ihrer Hybridbereitstellung unterstützen. Es wird empfohlen, die Überschreibungsdatei zu kopieren und zu ändern, die Ihren Installationsanforderungen am ehesten entspricht.

Die folgenden Beispiele sind im Verzeichnis $APIGEECTL_HOME/examples enthalten:

Beispiel für Überschreibungsdateien	Beschreibung
`overrides-small.yaml`	Dieses Beispiel ist ideal für einen schnellen Einstieg. Zum Starten der hybriden Laufzeitkomponenten werden die empfohlenen Mindestanforderungen verwendet. Diese Beispielkonfiguration basiert so weit wie möglich auf Standardeinstellungen und -werten. Die minimale Replikatanzahl ist jeweils auf `1` festgelegt.
`overrides-medium.yaml`	Dieses Beispiel ist ein guter Ausgangspunkt für Test- und QA-Umgebungen. Den einzelnen Komponenten wurden mehr Ressourcen zugewiesen, um zusätzlichen Traffic zu verarbeiten. Cassandra nutzt SSD-Laufwerke zur Leistung. In dieser Umgebung empfiehlt es sich, die zustandsorientierten und zustandslosen Komponenten auf separaten Knoten zu installieren. Siehe Dedizierte Knoten konfigurieren.
`overrides-large.yaml`	Dieses Beispiel ist ein guter Ausgangspunkt für leistungsstarke Umgebungen wie Vor- und Produktion. Das Beispiel enthält Attribute zum Festlegen von Verschlüsselungsschlüsseln, Passwörtern usw. Einzelne Komponenten haben mindestens zwei Replikate.
`private-overrides.yaml`	Dieses Beispiel zeigt, wie Images aus einem privaten Image-Repository verwendet werden. Siehe Privates Image-Repository verwenden.

Benutzerdefinierte Annotationen

Annotationen sind Schlüssel/Wert-Zuordnungen, mit denen Metadaten an Kubernetes-Pods angehängt werden. Sie können benutzerdefinierte Annotationen für die folgenden Hybridkomponentenattribute erstellen, die in der Referenz zu Konfigurationsattributen aufgeführt sind:

Zum Hinzufügen einer benutzerdefinierten Name/Wert-Paar-Annotation öffnen Sie die Überschreibungsdatei und fügen eine annotations-Stanza für die entsprechende Komponente hinzu. Wenden Sie dann die Änderung mit apigeectl an. Beispiel:

runtime:
  annotations:
    businessunit: "bu1"

Konfigurationsänderungen mit Probeläufen testen

Sie können das Flag --dry-run mit apigeectl verwenden, um die Überschreibungskonfigurationsdatei zu testen, ohne sie tatsächlich auf Ihren Cluster anzuwenden. Diese Option ist nützlich, um ein Installationsproblem zu beheben, da Sie genau sehen, was auf den Cluster angewendet wird.

In Apigee Hybrid hängt die Syntax des Flags --dry-run von der ausgeführten Version von kubectl ab. Prüfen Sie die Version von kubectl mit folgendem Befehl:

kubectl version

kubectl-Version 1.17 und niedriger:

$APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=true

kubectl-Version 1.18 und höher:

  $APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=client

Nach Bedarf mehrere Überschreibungen erstellen

Sie können mehrere Überschreibungen erstellen, wobei jede eine bestimmte Anforderung erfüllt. Nehmen wir z. B. an, dass Sie eine Überschreibungsdatei haben, die Ihren Cluster für die Produktion wiedergibt, und eine weitere Datei zum Erstellen eines Clusters für Tests. Sie können diese Dateien dann in Ihrem Versionsverwaltungssystem verwalten.

Verwenden Sie den Befehl apigeectl apply, um eine Überschreibungsdatei auf den Cluster anzuwenden. Beispiel:

$APIGEECTL_HOME/apigeectl apply  -f $HYBRID_FILES/overrides/test_env_override.yaml

Laufzeitkomponenten löschen

Der Befehl apigeectl delete bietet Flags, mit denen Sie alle oder einen Teil der installierten Hybridlaufzeitkomponenten löschen können. Weitere Informationen zur Befehlsnutzung finden Sie auf der Referenzseite von apigeectl. Siehe auch Hybridlaufzeit deinstallieren.

Umgebung löschen

Sie müssen die Laufzeitebene (lokal) und die Verwaltungsebene (Cloud) entfernen, um eine Umgebung vollständig zu löschen. Weitere Informationen finden Sie unter Umgebungen löschen.