Umgebungsarchitektur dokumentieren

Erstellen Sie als bewährtes Verfahren Architekturdiagramme für Ihre Apps. Diese Diagramme können als Teil der anfänglichen Entwurfsarbeit, der Schulung neuer Teammitglieder oder der Schulung neuer und vorhandener Teammitglieder verwendet werden. Solche Diagramme auf dem neuesten Stand zu halten, spart Zeit, wenn Probleme schnell untersucht werden müssen.

Durch die Dokumentation Ihrer App-Architektur können Sie sicherstellen, dass Sie und Ihr Team alle Komponenten Ihrer Architektur vollständig verstehen.

Sie können ein Architekturdiagramm als Teil Ihrer ursprünglichen Umgebungsplanung erstellen oder nachdem Ihre Umgebung betriebsbereit ist. Überprüfen Sie die folgenden Schritte, um Ihre Umgebung zu dokumentieren. Die bereitgestellten Beispiele basieren auf realen Apps.

Schritt 1: App und Architektur verstehen

Die Fehlerbehebung für Apps in IBM Cloud Kubernetes Service-Clustern kann kompliziert sein, insbesondere wenn das Problem einen Netzfluss betrifft, der verschiedene Cluster, Komponenten, Pods oder Services umfasst. Die Dokumentation Ihrer App-Architektur kann Ihrem Team helfen, alle Komponenten in Ihrem Setup gründlich zu verstehen.

Für eine App mit einem einfachen Netzfluss kann die Architektur im Text beschrieben werden. Für komplexere Szenarios ist ein detailliertes Architekturdiagramm hilfreich, damit verschiedene Teams, die an der Fehlerbehebung beteiligt sind, den Ablauf verstehen können. Stellen Sie außerdem sicher, dass Ihre Architekturdokumentation auf dem neuesten Stand bleibt, wenn sich Ihre Konfiguration ändert.

Die Fehlerbehebung für Apps in IBM Cloud Kubernetes Service-Clustern kann schwierig sein, insbesondere wenn eine oder mehrere der folgenden Bedingungen zutreffen.

  1. Die App ist nicht gut verstanden oder hat keine gute Protokollierung.
  2. Das Problem tritt nur sporadisch oder selten auf.
  3. Das Problem bezieht sich auf einen Netzfluss, der verschiedene Cluster, Komponenten, Pods oder Services umfasst.

Die folgenden Beispielarchitekturdiagramme stammen aus realen Szenarios. Sie können diese Beispiele als Leitfaden für die Erstellung eigener Architekturdiagramme verwenden.

Beispiel 1: Eine einfache App, die in einem einzelnen OpenShift-Cluster ausgeführt wird

In diesem Beispiel wird die gesamte App in einem einzelnen OpenShift-Cluster ausgeführt. Dies ist eine einfache App, bei der ein einzelner Client-Pod eine Anforderung an einen clusterinternen Service stellt, der dann eine Verbindung zu einer etcd-Instanz herstellt, die von drei Pods verarbeitet wird.

Client                Application Service             Etcd Instance
                                             |------> [Etcd Pod 1]
                |---> [Application Pod 1] ---|
                |                            |
[Client pod] ---|                            |------> [Etcd Pod 2]
                |                            |
                |---> [Application Pod 2] ---|
                                             |------> [Etcd Pod 3]

Beispiel 2: Eine Architektur mit mehreren Clustern mit einer globalen Lastausgleichsfunktion und einem Cloudant-Service

Im folgenden Diagramm wird die Verbindung von einem von drei Client-Pods in einem Cluster in der eu-de-Region eingeleitet. Die Client-Pods stellen eine Verbindung zu einer globalen Lastausgleichsfunktion (GLB) her, die dann einen Lastausgleich für die Verbindung mit einer von zwei öffentlichen VPC-Anwendungslastausgleichsfunktionen (ALBs) in eu-de und eu-gb durchführt.

Jeder dieser VPC ALBs ist Teil eines eigenen Clusters in seiner Region. Diese ALBs leiten Datenverkehr an die OpenShift-Router-Pods weiter, die diesen Datenverkehr dann an die Back-End-Pods im Cluster weiterleiten. Diese Back-End-Pods stellen eine Verbindung zu einer Cloudant-Datenbank her, um die Anforderung zu verarbeiten.

Beachten Sie, dass einige dieser Verbindungen über das öffentliche Netz hergestellt werden. Einige befinden sich über ein privates Netz in derselben VPC und einige verwenden das private Netz in IBM Cloud zwischen Komponenten in einer VPC und einem Service in IBM Cloud.

Multicluster-Diagramm
Multicluster-Architektur

Beispiel 3: Ein VSI-Client kontaktiert eine VPC-Netzlastausgleichsfunktion mit einem externen Service-Back-End

Im folgenden Beispiel ist der Client eine klassische VSI in IBM Cloud. Die VSI stellt über das private Netz eine Verbindung zu einer privaten VPC-Netzlastausgleichsfunktion (NLB) her, die für einen VPC-Cluster erstellt wird. Diese NLB verteilt den Datenverkehr über den NodePort für den Cluster-Lastausgleichsservice auf einen der drei VPC-Workerknoten. Der Cluster-Load-Balancer-Service sendet dann den Datenverkehr an einen der App-Pods, die über das öffentliche Netz eine Verbindung zu einem externen Cloud-Service außerhalb von IBM Cloud herstellen.

NLB mit einem externen
mit einem externen

Schritt 2: Tool auswählen

Sie können die folgenden Tools verwenden, um Ihr Architekturdiagramm zu erstellen.

Es sind viele Diagrammtools verfügbar. Wählen Sie das für Sie am besten geeignete Tool aus.

Schritt 3: Erstellen Sie das Diagramm

Sie können eines der zuvor genannten Beispiele als Referenz verwenden oder ein völlig neues Diagramm erstellen.

Weitere Informationen und Referenzarchitekturen finden Sie unter IBM Architekturen.

Nächste Schritte

Bereiten Sie Ihr Konto auf die Clustererstellung vor.