Einleitung
Über NetCord
NetCord ist eine Web-Applikation für Kabelmanagement und IT-Dokumentationen.
Fallbeispiel
Ein Real World Szenario, welches die Nutzung von NetCord anhand eines fiktiven Beispiels zeigt.
Quickstart
Start in die User Dokumentation mit dem Thema "Anmeldung".
FAQ
Häufige Fragen und deren Antworten
Admin Guide
Informatinen für Administratoren von NetCord.
Wie funktioniert NetCord?
NetCord beginnt mit der Erfassung der Infrastruktur, zu der Liegenschaften, Racks und Geräte gehören. Nachdem die Geräte und ihre Ports miteinander verbunden sind, können diese Verbindungen für Informationsabfragen herangezogen werden.
Über Geräte
In NetCord wird fast alles als "Gerät" betrachtet. Dazu zählen sowohl Aktivkomponenten wie Switches und Server als auch Passivgeräte wie Panels und Netzwerkdosen. Selbst ein Rangierpanel wird in NetCord als Gerät definiert. Welche Gerätetypen dem Benutzer zur Verfügung stehen, lässt sich individuell durch einen NetCord-Administrator einrichten. Für eine bessere Übersicht können diese Gerätetypen in Kategorien eingeordnet werden.
Über Ports
Jedes Gerät in NetCord besitzt Ports. Die bei der Geräteerstellung wählbaren Porttypen werden vom NetCord-Administrator festgelegt. Ein Porttyp ist einer bestimmten Technologie zugeordnet, welche neben Porttypen auch Kabeltypen umfasst. NetCord garantiert, dass Ports nur mit Kabeltypen derselben Technologie verbunden werden können. Sowohl die Porttypen als auch die Technologien und Kabeltypen sind vom NetCord-Administrator anpassbar.
Über Verbindungen
Sobald Geräte und Ports erstellt sind, können sie miteinander verbunden werden. NetCord unterscheidet hierbei zwischen Patchverbindungen und Installationsverbindungen. Ein Port eines Aktivgeräts kann mit einem anderen Port derselben Technologie durch eine Patchverbindung verknüpft werden. Ein Port eines Passivgeräts kann entweder eine Patch- oder eine Installationsverbindung haben. Ein Port eines Geräts aus der Platzhalter-Kategorie kann hingegen weder eine Patch- noch eine Installationsverbindung zu einem anderen Port haben.
Abfragen
Die erstellten Verbindungen bilden die Grundlage für alle Abfragen in NetCord. Dies beinhaltet sowohl die Darstellung kompletter Verbindungspfade als auch die Backbone-Ansicht.
REST API
Mit der NetCord REST API können Sie das gesamte NetCord-Tool vollständig über automatisierte Schnittstellen bedienen. Diese leistungsfähige API ermöglicht es Ihnen, Daten effizient zu erfassen, zu verwalten und abzurufen, ohne manuell über die Benutzeroberfläche arbeiten zu müssen. Ob Sie Informationen zu Geräten einpflegen oder detaillierte Abfragen zu Verbindungen durchführen möchten, die REST API bietet Ihnen die nötigen Funktionen.
Spezifikationen
Technologie-Stack
- Programmiersprache(n): Go, JavaScript
- Frameworks/Bibliotheken: Keine
- Datenbank: PostgreSQL
- Frontend-Technologien: HTML, CSS, JavaScript
- Backend-Technologien: Go
- API: REST
Architektur
- Architekturtyp: Monolithisch, zwei Binaries (Web und API)
- Deployment: Binary Deployment bei Digitalocean
- Containerisierung: Keine, Binaries laufen barebone
- Continuous Integration/Deployment (CI/CD): Terraform und Ansible
Datenbank-Design
- Datenbanktyp: Relational (SQL)
Sicherheitsmassnahmen
- Authentifizierung/Autorisierung: OAuth2, JWT, Go Cryptography
- Verschlüsselung: HTTPS (mit SSL/TLS)
Versionierung
- Versionskontrolle: Git
- Branching-Strategien: GitFlow
Logging und Monitoring
- Protokollierung: systemd-basierte Protokollierung über Journalctl
Dokumentation
- Benutzerdokumentation: https://docs.netcord.ch/