Wie dokumentiert ihr voneinander abhängige Dienste und deren Schnittstellenkonfigurationen? Mit welchen Tools lässt sich so eine Doku sowohl übersichtlich darstellen, als auch gut langfristig pflegen, ändern und erweitern?
LikeC4 scheint mir am attraktivsten, aber eure Erfahrungen was im Tagesgeschäft wirklich effizient ist würden mich interessieren.
Danke & Liebe Grüße
LikeC4 scheint interessant zu sein.
Praktisch kann ich aber nicht viel sagen, da ich bisher für die paar Kleinigkeiten mit draw.io zurecht kam.
Ich schreib alles einfach als Text in markdown Dateien. So ist die Dokumentation überall lesbar und durchsuchbar.
Wenn ich es schöner will, benutze ich mermaid Diagramme weil die meistens unterstützt und ge-rendered werden.
Ich würde bei der Auswahl des Tools auch darauf achten, wie gut sich Änderungen an den Schnittstellen dokumentieren lassen.
Ein Diagramm zeigt zwar schön, welcher Dienst mit welchem verbunden ist. Im Alltag sind aber oft die Details entscheidend: Protokoll, Port, Authentifizierung und wer für den jeweiligen Dienst zuständig ist.
Deshalb finde ich die Kombination aus Markdown und Mermaid durchaus sinnvoll. Die eigentlichen Konfigurationsdetails bleiben als Text durchsuchbar, während das Diagramm die Abhängigkeiten zeigt.
Bei größeren Umgebungen könnte LikeC4 natürlich übersichtlicher werden.
Wie groß ist denn eure Infrastruktur ungefähr? Geht es um ein paar selbst gehostete Dienste oder um mehrere Systeme, die von unterschiedlichen Leuten betreut werden?