swark Dokumentation
Live-Demo

Dokumentation

Handbuch für swark – Swiss Architecture Knife: Konzepte, Bedienung, Datenimport, Compliance, Inhalte und Diagramme.

swark (Swiss Architecture Knife) ist ein Open-Source-Werkzeug der dreitier GmbH (MIT-Lizenz) zur Dokumentation von IT-Infrastruktur, Software-Architektur, IT-Strategie und Compliance. Nerd-IT (Nils Lappenbusch, Buchs ZH) betreibt swark als Dienst: öffentliche Demo unter https://demo.swark.nerdag.ch, Kundeninstanzen unter KUNDE.swark.nerdag.ch.

Dieses Handbuch beschreibt swark Version 0.2.1. Alle Angaben sind aus dem Quellcode von swark 0.2.1 und dem Betrieb bei Nerd-IT abgeleitet. Funktionen, die im Code angelegt, aber nicht fertig sind, sind als «in Version 0.2.1 noch nicht umgesetzt» oder «unvollständig» gekennzeichnet.

Anwenderhandbuch

  1. EinführungWas swark ist, für wen es gedacht ist, wie es sich von verwandten Werkzeugen abgrenzt und unter welcher Lizenz es steht.
  2. Konzepte und DatenmodellGrundbegriffe von swark – Daten und Content, Configuration Items, Scomp-IDs, Datenmodell mit Beziehungen, C4-Zuordnung sowie Zonen, Stages, Kritikalität, Schutzziele und Datenklassifikation.
  3. Das FrontendAlle Seiten unter /swark mit Inhalt, Datenquelle und bekannten Einschränkungen von Version 0.2.1.
  4. Admin-OberflächenDie acht Filament-Panels unter /admin mit allen Ressourcen, ihrem Zweck und den wichtigsten Feldern.
  5. Compliance-FunktionenRegulierungen, Kapitel, Controls, Findings, Massnahmen, Richtlinien und Kennzahlen in swark sowie die mitgelieferten NIS2-Inhalte.
  6. Daten importierenExcel-Import mit allen Tabellenblättern, Spalten und der Referenz-Syntax, Markdown- und YAML-Import für Regulierungen sowie alle Artisan-Befehle von swark.
  7. Content und CMSWie freie Inhalte (Markdown, HTML, Blade, PlantUML) im Content-Pfad abgelegt werden, welche Slots und Hooks die Seiten anbieten und welche Grenzen Version 0.2.1 hat.
  8. DiagrammeWie swark PlantUML-, Mermaid- und Plotly-Diagramme erzeugt, welche Voraussetzungen nötig sind und wie eigene Diagramme eingebunden werden.
  9. Benutzer, Sprache und KonfigurationAnmeldung und Benutzerverwaltung, Spracheinstellung und alle relevanten Umgebungsvariablen von swark und dem Docker-Betrieb.