Zum Inhalt springen

Dokumentation

WISP

Verbinden Sie ein WISP-Panel, und Provibr baut, betreibt und entfernt Gameserver darauf. WISP ist ein Fork von Pterodactyl, das Modell ist also dasselbe; diese Seite behandelt die Stellen, an denen es sich unterscheidet.

Ein gehostetes Panel, Ihr eigener Node

WISP wird als gehosteter Dienst verkauft: wisp.gg betreibt das Panel, und der Node, der Ihre Gameserver trägt, läuft auf Ihrer eigenen Hardware. Der Agent spricht über die API mit dem Panel und für die Konsole mit dem Daemon des Nodes. Beides ist ausgehend, es muss also nichts ins Internet geöffnet werden.

Weil das Panel nicht Ihnen gehört, gibt es nichts zu aktualisieren und nichts zu pinnen: WISP kann seine API ändern, ohne dass ein Release dazwischenliegt, über das Sie bestimmen. Provibr ist gegen v3.7.5 getestet und liest die laufende Version beim Panel selbst aus, sodass sich eine Abweichung im Verbindungstest zeigt und nicht in einer fehlgeschlagenen Bestellung.

Zwei API-Keys

WISP behält die Aufteilung von Pterodactyl in zwei API-Hälften bei, und kein einzelner Key erreicht beide. Legen Sie sie auf einem Administratorkonto an und fügen Sie beide zusammen mit der Adresse des Panels ein.

  • Adresse des Panels: die vollständige URL, zum Beispiel https://panel.example.com. Geben Sie nur dann einen Port an, wenn das Panel tatsächlich darauf läuft; hinter einem Reverse Proxy antwortet es auf dem Standardport seines Schemas.
  • Application-API-Key: er verwaltet Server: anlegen, sperren, neu installieren, entfernen.
  • Client-API-Key: er trägt Ein- und Ausschalten, Live-Statistiken und die Konsole.
  • TLS-Fingerprint (optional): bei einem gehosteten WISP-Panel bleibt das Feld leer; dessen Zertifikat stammt von einer öffentlichen Zertifizierungsstelle, es gibt also nichts zu pinnen.
WISP-Keys tragen kein Präfix, anders als ptla_ bei Pterodactyl und papp_ bei Pelican. Nichts kann Ihnen sagen, dass Sie die beiden vertauscht haben: Provibr kann es nicht prüfen, und das Panel beantwortet einen falschen Key mit einem leeren 403, das sich wie „zu wenig Berechtigungen“ liest. Schlägt der Verbindungstest fehl, probieren Sie die beiden Keys andersherum, bevor Sie im Panel etwas ändern.
Der Application-Key ist mehr als Serververwaltung: Dieselbe Node-Liste, die Provibr ausliest, gibt auch den Lizenzschlüssel und das Daemon-Token Ihres Nodes preis. Behandeln Sie ihn als Zugangsdaten für das ganze Panel und widerrufen Sie ihn in WISP, wenn Sie die Integration jemals trennen.

Transport

Ein gehostetes WISP-Panel ist über https mit einem öffentlich vertrauenswürdigen Zertifikat erreichbar, das Fingerprint-Feld bleibt also leer. Tragen Sie hier nur dann etwas ein, wenn Sie WISP selbst hinter einem selbstsignierten Zertifikat betreiben; der Agent vertraut dann genau diesem einen Zertifikat, statt die Prüfung abzuschalten. Lesen Sie ihn aus mit:

shell
openssl s_client -connect <host>:443 </dev/null 2>/dev/null | \
  openssl x509 -noout -fingerprint -sha256
Befehle und Terminal-Ausgaben sind überall auf Englisch, im Panel und auf diesen Seiten. Ein Text, eine Wahrheit: Was Sie hier lesen, ist wörtlich das, was Ihr Host zurückschreibt.

Lassen Sie das Feld leer bei einem Zertifikat einer öffentlichen Zertifizierungsstelle und ebenso dann, wenn das Panel nur über http erreichbar ist. Ein Fingerprint neben einer http-Adresse wird abgelehnt, weil es kein Zertifikat gibt, auf das sich pinnen ließe. Ein Panel auf schlichtem http funktioniert zwar, aber beide Keys reisen dann unverschlüsselt.

Eggs

Ein Server wird aus einem Egg gebaut, genau wie bei Pterodactyl. WISP listet all seine Eggs samt ihren Variablen in einem einzigen Aufruf auf, die Auswahlliste füllt sich also selbst, und ein Plan kann jede Variable überschreiben, die das Egg als bearbeitbar kennzeichnet.

Bleibt eine erforderliche Variable leer, lehnt WISP die Bestellung nicht ab: Es setzt stillschweigend den Standardwert des Eggs ein. Sie bekommen einen funktionierenden Server, nur nicht den, den Sie bestellt haben. Provibr prüft erforderliche Variablen vor dem Senden, die Bestellung bricht also stattdessen mit einer Meldung ab, die die Variable benennt.

Pläne

Ein Game-Plan trägt das Egg, die Ressourcengrenzen und etwaige überschriebene Variablen. Bestellt wird über einen Plan: Der Plan entscheidet, welches Egg verwendet wird und was der Server verbrauchen darf, und ein Plan lässt sich mit mehr als einem Panel verknüpfen.

Platzierung

Ein WISP-Node meldet seine Kerne, seinen Arbeitsspeicher und seine Festplatte, aber nicht, wie viel davon bereits vergeben ist. Provibr addiert das aus den Servern auf dem Node zusammen, wie es das auch bei einem Hypervisor tut.

Den Node selbst wählt der Agent und nicht die Platzierungs-Engine: Er nimmt den Node mit dem meisten freien Arbeitsspeicher und darauf die erste freie Port-Allocation. Die Nodes eines WISP-Panels aus Provibr heraus zu reihen gibt es noch nicht.

Lebenszyklus

Erstellen, Starten, Stoppen, Neustarten, Kill, Sperren, Freigeben, Neuinstallieren und Löschen funktionieren alle. Ein gesperrter Server lässt sich weiterhin entfernen, und beim Entfernen wird seine Port-Allocation wieder frei.

WISP meldet keine fehlgeschlagene Installation. Ein Server ist entweder als installiert markiert oder nicht, und „noch dabei“ und „es ist schiefgegangen“ sehen von außen gleich aus. Bleibt ein neuer Server deutlich länger auf nicht installiert stehen, als ein Egg üblicherweise braucht, öffnen Sie seine Konsole in WISP und lesen Sie dort die Installationsausgabe.

Konsole und Messwerte

Die Konsole ist ein Live-Terminal auf dem Daemon des Nodes, im selben Panel wie der Rest Ihrer Infrastruktur, und die Verbrauchsgrafiken stammen aus den eigenen Messungen des Panels. Prozessor, Arbeitsspeicher, Festplatte und Netzwerk werden bei jeder Abfrage ausgelesen; eine Uptime meldet WISP nicht, ein Container, der zwischen zwei Abfragen neu startet, wird also nicht immer als Neustart erkannt.

Was Provibr nicht tut

Provibr verwaltet weder das Panel noch seine Nodes, Dateien, Backups, Datenbanken oder Benutzer. Auch die WISP-eigenen Zugaben gehören nicht zur Integration: der Splitter, Subdomains, Wipe-Zeitpläne, Mod-Stores. Was Provibr bereitstellt, zählt und berechnet, ist ein Gameserver auf dem Panel; Server, die Sie nicht über Provibr angelegt haben, bleiben unangetastet.