Spherifyer-Dokumentation

Überblick

Spherifyer zeigt Ihnen auf einen Blick, wie es um Ihre VMware-Umgebung steht: wie voll die Datastores sind, welche VMs wie viel belegen und wo es Probleme gibt. Dazu fragt das Programm regelmäßig Ihr vCenter ab und merkt sich die Werte. So sehen Sie auch, wie sich die Belegung über Wochen und Monate entwickelt.

Spherifyer läuft auf einem Ihrer eigenen Server. Es ist eine einzelne Programmdatei, die nichts weiter braucht. Ihre Daten bleiben bei Ihnen. Nur für Updates und die Lizenz nimmt das Programm Kontakt zu www.wedigo.net auf.

Sie bedienen Spherifyer auf zwei Wegen:

• Im Browser: Das Dashboard mit allen Ansichten. Hier arbeiten Sie im Alltag.
• Im Konsolenfenster: Beim Start in einer Konsole erscheint eine einfache Text-Oberfläche. Sie zeigt den Zustand des Programms und richtet den Dienst ein. Läuft Spherifyer als Dienst im Hintergrund, brauchen Sie sie nicht.

Voraussetzungen

• Ein Server mit Windows oder Linux (64 Bit). Eine eigene VM reicht völlig.
• Ein Benutzer im vCenter, der nur lesen darf. Legen Sie dafür am besten einen eigenen Benutzer an und geben Sie ihm die Rolle Nur lesen (Read-only). Vergeben Sie die Rolle ganz oben im vCenter und setzen Sie den Haken *An untergeordnete Objekte weitergeben*. Spherifyer ändert im vCenter nie etwas.
• Netzwerkverbindungen:
  • vom Spherifyer-Server zum vCenter (HTTPS, Port 443)
  • vom Spherifyer-Server zu www.wedigo.net (HTTPS, Port 443) für Updates und die Lizenz. Ein Proxy ist möglich.
  • von Ihrem Arbeitsplatz zum Dashboard. Anfangs ist es nur auf dem Server selbst erreichbar, siehe Zugriff von anderen Rechnern.

Installation

Legen Sie die Programmdatei in einen eigenen Ordner, zum Beispiel C:\Program Files\Spherifyer oder /opt/spherifyer. Alles, was Spherifyer anlegt, landet in diesem Ordner: Einstellungen, gesammelte Daten und das verschlüsselt gespeicherte Passwort.

Starten Sie Spherifyer beim ersten Mal von Hand in einem Konsolenfenster. Dabei fragt das Programm die Zugangsdaten zum vCenter ab (siehe Einrichtung).

cd "C:\Program Files\Spherifyer"
.\spherifyer.exe

cd /opt/spherifyer
./spherifyer

Als Dienst einrichten

Damit Spherifyer dauerhaft läuft, auch nach einem Neustart des Servers, richten Sie es als Dienst ein. Dazu brauchen Sie Administratorrechte (unter Linux sudo).

.\spherifyer.exe service install
.\spherifyer.exe service start

sudo ./spherifyer service install
sudo ./spherifyer service start

Stürzt der Dienst einmal ab, startet ihn Windows von selbst neu.

Alternativ geht das im Konsolenfenster: Reiter Service (Taste 2), dann i zum Einrichten und s zum Starten. Auch dafür muss das Konsolenfenster mit Administratorrechten geöffnet sein.

Einrichtung

Beim allerersten Start fragt Spherifyer im Konsolenfenster nach drei Dingen:

1. der Adresse Ihres vCenters (Name oder IP-Adresse),
2. dem Benutzernamen,
3. dem Passwort.

Das Passwort speichert Spherifyer verschlüsselt. Den Schlüssel dazu legt es in einer eigenen Datei daneben ab (vsphere.key). Ohne diese Datei lässt sich das Passwort nicht lesen. Heben Sie sie bei einer Sicherung also mit auf.

Danach holt Spherifyer sofort die ersten Daten. Das Dashboard öffnen Sie auf dem Server im Browser unter http://127.0.0.1:8080, oder Sie drücken im Konsolenfenster die Taste o.

Die meisten vCenter nutzen ein selbst ausgestelltes Zertifikat. Spherifyer akzeptiert das von Haus aus. Hat Ihr vCenter ein offizielles Zertifikat, können Sie die Prüfung strenger stellen: vcenter.insecure auf false.

Zugriff von anderen Rechnern

Zunächst ist das Dashboard nur auf dem Server selbst erreichbar. So kommt niemand ungewollt von außen darauf. Wenn Sie es von Ihrem Arbeitsplatz aus öffnen möchten:

• drücken Sie im Konsolenfenster die Taste l, oder
• tragen Sie in der Einstellung web.listen den Wert 0.0.0.0:8080 ein und starten Sie den Dienst neu.

Geben Sie den Port 8080 außerdem in der Firewall des Servers frei. Dann erreichen Sie das Dashboard unter http://<servername>:8080.

Das Dashboard selbst ist unverschlüsselt (HTTP). Soll es über ein größeres Netz erreichbar sein, stellen Sie einen Webserver mit HTTPS davor, zum Beispiel IIS oder nginx.

Port und Proxy

Einen Proxy, der in Windows eingerichtet ist, übernimmt Spherifyer von selbst: zuerst den von netsh winhttp show proxy, sonst den fest eingetragenen Proxy aus den Internetoptionen. Ausnahmen wie *.firma.de übernimmt es mit. Automatische Erkennung und PAC-Skripte wertet Spherifyer nicht aus. Einen eigenen Proxy brauchen Sie nur, wenn Windows keinen kennt oder Spherifyer einen anderen nehmen soll.

Den Port des Dashboards und den Proxy für das Internet ändern Sie im Konsolenfenster im Reiter Einstellungen (Taste 4):

• Port der Weboberfläche: zum Beispiel 8443 statt 8080. Die Adresse davor (nur lokal oder für alle) bleibt, wie sie ist. Ist der Port auf dem Server schon belegt, warnt Spherifyer.
• Proxy (URL): Braucht der Server einen Proxy für das Internet, tragen Sie ihn hier ein, zum Beispiel http://10.10.75.1:8080. Mit Anmeldung: http://benutzer:passwort@10.10.75.1:8080. Das Passwort speichert Spherifyer verschlüsselt in proxy.creds, nicht in der config.yaml. Leer heißt: kein eigener Proxy, dann gilt der Proxy aus Windows oder aus HTTPS_PROXY.
• Ausnahmen: Namen und Netze, die nicht über den Proxy gehen, durch Kommas getrennt, zum Beispiel firma.de,10.20.0.0/16. Der Server selbst, die privaten Netze und Ihr vCenter gehen immer direkt.

Wählen Sie ein Feld mit den Pfeiltasten und drücken Sie Enter zum Ändern. Enter übernimmt, Esc bricht ab. Mit t prüfen Sie sofort, ob www.wedigo.net über den eingetragenen Proxy erreichbar ist, noch bevor Sie speichern. Mit s speichern Sie in die config.yaml. Die Änderung wirkt nach einem Neustart von Spherifyer oder des Dienstes (spherifyer service restart).

Der Reiter zeigt außerdem, welcher Proxy gerade wirkt und woher er stammt (config.yaml, Umgebungsvariable oder Windows). Stammt ein Wert aus einer Umgebungsvariablen, sehen Sie ihn dort nur und können ihn nicht ändern.

Anmeldung und Passwort

Spherifyer legt beim ersten Start den Benutzer admin mit einem zufälligen Startpasswort an. Das Passwort wird nur einmal angezeigt: im Konsolenfenster und in der Logdatei spherifyer.log im Programmordner.

• Nach der ersten Anmeldung vergeben Sie ein eigenes Passwort (mindestens 10 Zeichen).
• Später ändern Sie es im Benutzermenü oben rechts.
• Nach mehreren falschen Versuchen wartet Spherifyer kurz, bevor es einen neuen Versuch zulässt.

Passwort vergessen? Stoppen Sie den Dienst, löschen Sie die Datei auth.json im Programmordner und starten Sie den Dienst wieder. In spherifyer.log steht dann ein neues Startpasswort.

Ansichten

Storage: Wie voll ist jeder Datastore, wie viel ist den VMs zugesagt, und wie schnell arbeitet er? Spitzenwerte der letzten sieben Tage inklusive, dazu wann er voraussichtlich voll ist und welche VMs dort die höchste Latenz haben.

VMs: Alle VMs in einer Tabelle zum Filtern und Sortieren. Ein Klick auf eine Zeile zeigt Netzwerkkarten und Laufwerke der VM. Mit den Filtern finden Sie zum Beispiel VMs, die in mehreren Netzen hängen oder deren Netzwerkkarte getrennt ist.

Hosts: Auslastung von Prozessor, Arbeitsspeicher und Netzwerk je Host und welche VMs darauf laufen. Dazu je Host die VMs, die am längsten auf freie Prozessorkerne warten (CPU-Ready).

Topologie: Ihre Umgebung als Baum, und welche VM in welchem Netz (VLAN) hängt.

Warnungen: Was Spherifyer auffällt, jeweils mit einer Empfehlung, siehe Warnungen und Empfehlungen. Über die Kategorien oben lässt sich die Liste filtern, etwa auf Compliance (Punkte aus dem vSphere Security Configuration Guide) oder Kapazität.

Verlauf: Wie sich die Belegung entwickelt hat, über einen Zeitraum Ihrer Wahl. Dazu, wer im vCenter was geändert hat, und die Netzwerklast der Hosts.

Planung: Vier Ansichten für die nächsten Entscheidungen:

• Prognose: Auslastung je Cluster (CPU, RAM, Speicher, vCPU je Kern), ob der Cluster den Ausfall seines größten Hosts abfängt, und wann der Speicher beim Wachstum der letzten 30 Tage voll ist. Darunter alle Datastores nach Restlaufzeit; die Restlaufzeit steht auch auf den Datastore-Karten im Reiter Storage.
• Rückforderung (Freiräumen): VMs, die lange ausgeschaltet sind, VMs ohne Last und Snapshots, die älter als 30 Tage sind, mit der Summe an Speicher, vCPUs und RAM. Mit Monatspreisen in den Einstellungen (planning.price_*) auch die geschätzte Einsparung.
• Was-wäre-wenn: Eine Ausfallsimulation als Karte: Hosts mit ihren VMs, Katastrophen-Beispiele (größter Host, zwei Hosts, halber Cluster, Wartung Host für Host, Datastore fällt aus) oder frei gewählte Hosts. Die VMs ausgefallener Hosts wandern sichtbar auf die übrigen, so wie HA sie neu starten würde; was keinen Platz findet, steht unter „Nicht startbar“. Dazu neue VMs, ein Urteil mit Begründung, Grenzwerte und wie viele VMs dieser Größe danach noch passen.
• Lizenzbedarf: Wie viele Prozessoren und Kerne in jedem Datacenter stecken. Das brauchen Sie für die Planung Ihrer VMware-Lizenzen.

Alle Ansichten gibt es auf Deutsch und Englisch, hell und dunkel.

Warnungen und Empfehlungen

Nach jeder Abfrage prüft Spherifyer die Daten und meldet, was auffällt, jeweils mit einem Vorschlag, was zu tun ist. Die Platzhalter in geschweiften Klammern stehen im Dashboard durch echte Werte ersetzt.

Lizenz und Aktivierung

Ohne Lizenzschlüssel zeigt Spherifyer einen einzelnen Host, damit Sie das Programm ausprobieren können. Mit Lizenzschlüssel sehen Sie Ihre ganze Umgebung.

• Den Lizenzschlüssel bekommen Sie nach dem Kauf sofort per E-Mail. Er gehört zu der E-Mail-Adresse, mit der Sie gekauft haben.
• Für die Aktivierung braucht der Server eine Verbindung zu www.wedigo.net, auch über einen Proxy (siehe Port und Proxy). Danach meldet sich Spherifyer alle 30 Tage kurz dort. Fällt die Verbindung aus, läuft die Lizenz noch bis zu 60 Tage weiter.
• Eine Lizenz gilt für eine Installation und für alle Updates der gekauften Version, also zum Beispiel für alle 1.x-Versionen. Erscheint eine neue Hauptversion, weist Spherifyer darauf hin, installiert sie aber nicht von selbst.

Welcher Host ohne Lizenz? Spherifyer wählt ihn bei der ersten Abfrage zufällig aus und bleibt dabei. Einen anderen wählt es nur, wenn es den Host im vCenter nicht mehr gibt. Sie sehen diesen Host mit seinen VMs und Datastores in allen Ansichten. Die übrigen Hosts zählt das Dashboard nur mit („7 weitere Hosts – mit Lizenzschlüssel sichtbar“). Gesammelt werden trotzdem alle Daten: Sobald die Lizenz gilt, sehen Sie die ganze Umgebung, auch rückwirkend im Verlauf.

Lizenzschlüssel eingeben: Im Dashboard im Benutzermenü oben rechts unter *Lizenz*. Fügen Sie den Schlüssel ein, tragen Sie die E-Mail-Adresse des Kaufs ein und klicken Sie auf *Speichern*. Spherifyer prüft den Schlüssel sofort online und schreibt ihn in die config.yaml. Dort können Sie ihn auch selbst eintragen (license.key und license.email, siehe Einstellungen), danach den Dienst neu starten.

Im Dialog *Lizenz* sehen Sie, für wen und für welche Version die Lizenz gilt, wann sie zuletzt geprüft wurde und bis wann sie gilt. Mit *Jetzt prüfen* fragen Sie sofort nach, zum Beispiel nachdem Sie die Verbindung zu www.wedigo.net freigegeben haben.

Umzug auf einen anderen Server: Tragen Sie den Schlüssel auf dem neuen Server ein. Die Lizenz wechselt dann dorthin, der alte Server zeigt wieder nur einen Host. Wollen Sie die Lizenz zurückholen, klicken Sie dort auf *Lizenz auf diese Installation übertragen*.

Gibt es ein Problem mit der Lizenz, zeigt das Dashboard oben einen Hinweis: wenn www.wedigo.net seit über 45 Tagen nicht erreichbar war, die Lizenz auf einen anderen Server übertragen, gesperrt oder abgelaufen ist oder die Uhr des Servers nachgeht. Spherifyer läuft in jedem Fall weiter, und es gehen keine Daten verloren.

Mehr zu Kauf und Rückgabe: Preise und Lizenzbedingungen.

Updates

Spherifyer hält sich selbst aktuell. Es schaut regelmäßig auf www.wedigo.net nach, ob es eine neue Version gibt, prüft, dass sie wirklich von uns stammt, und installiert sie.

Wie das abläuft, legen Sie in der Einstellung update.mode fest:

• auto (Standard): Neue Versionen werden installiert, der Dienst startet danach kurz neu.
• notify: Spherifyer meldet eine neue Version nur. Sie installieren sie selbst im Dashboard.
• off: Keine Prüfung auf Updates.

Mit update.window legen Sie eine Uhrzeit fest, zu der installiert werden darf, zum Beispiel "02:00-05:00". Im Dashboard sehen Sie den Stand im Benutzermenü unter *Software-Update* und können dort auch von Hand prüfen und installieren.

Automatisch installiert wird nur, wenn Spherifyer als Dienst läuft und in seinen Programmordner schreiben darf. Starten Sie es von Hand im Konsolenfenster, meldet es neue Versionen nur.

Updates bleiben immer innerhalb Ihrer Hauptversion, zum Beispiel 1.x. Erscheint eine neue Hauptversion, zeigt Spherifyer einen Hinweis unter der Kopfzeile, im *Software-Update*, bei der Lizenz und im Konsolenfenster: Ihre Lizenz gilt für die neue Hauptversion nicht, dafür ist ein Upgrade nötig. Ihre Version erhält weiter Updates. Den Hinweis unter der Kopfzeile können Sie ausblenden; er erscheint erst bei der nächsten Hauptversion wieder.

Zurück zur vorigen Version

Spherifyer hebt die vorige Version auf. Startet eine neue Version nicht richtig, kehrt es von selbst zur alten zurück. Sie können das auch von Hand tun:

.\spherifyer.exe rollback
.\spherifyer.exe service restart

sudo ./spherifyer rollback
sudo ./spherifyer service restart

Sicherung

Sichern Sie den Programmordner. Wichtig sind diese Dateien:

• config.yaml: Ihre Einstellungen
• vsphere.key und vsphere.creds: das Passwort für das vCenter. Die beiden gehören zusammen.
• proxy.creds: das Passwort für den Proxy, falls Sie eines eingetragen haben. Es lässt sich nur zusammen mit vsphere.key lesen.
• auth.json: die Benutzer des Dashboards
• history.db: die gesammelten Daten und der Stand der Lizenz auf diesem Server. Am sichersten kopieren Sie sie bei gestopptem Dienst.

Zum Wiederherstellen legen Sie die Dateien zurück in den Programmordner und starten den Dienst.

Fehlerbehebung

Spherifyer erreicht das vCenter nicht. Prüfen Sie, ob der Server das vCenter unter dem eingetragenen Namen erreicht und ob eine Firewall Port 443 sperrt. Was genau schiefgeht, steht im Konsolenfenster (Reiter Logs, Taste 3) oder in spherifyer.log.

Das Dashboard geht nur auf dem Server selbst. So ist es voreingestellt. Siehe Zugriff von anderen Rechnern.

Ich komme nicht mehr ins Dashboard. Siehe Passwort vergessen.

Bei Storage fehlen die Leistungswerte. Diese Werte liefert das vCenter erst nach einiger Zeit. Sie erscheinen nach den ersten Abfragen. Im vCenter müssen die Leistungsstatistiken eingeschaltet sein, was sie normalerweise sind.

Ein Update wird nicht installiert. Läuft Spherifyer als Dienst und darf es in seinen Ordner schreiben? Eine Version, die schon einmal zurückgenommen wurde, installiert Spherifyer nicht noch einmal.

Lizenz/Updates: keine Verbindung. Lizenz und Updates brauchen eine Verbindung zu www.wedigo.net (HTTPS, Port 443). Den genauen Fehler zeigen der Dialog *Lizenz* im Benutzermenü und spherifyer.log. Im Konsolenfenster zeigt der Reiter Einstellungen, welcher Proxy gerade wirkt. Ist in Windows ein Proxy eingerichtet (netsh winhttp show proxy oder Internetoptionen), nimmt Spherifyer ihn von selbst. Braucht der Server einen anderen Proxy oder kennt Windows keinen, tragen Sie ihn im Reiter Einstellungen ein, prüfen Sie ihn mit t und speichern Sie mit s. Danach Spherifyer oder den Dienst neu starten. Siehe Port und Proxy. Ohne Konsolenfenster tragen Sie den Proxy in der config.yaml unter proxy.url ein. Die Umgebungsvariable HTTPS_PROXY funktioniert weiterhin.

Hilft das alles nicht, schreiben Sie uns über das Kontaktformular.

Nachschlagen

Dieser Teil ist zum Nachschlagen gedacht, wenn Sie etwas Bestimmtes einstellen möchten.

Einstellungen

Die Einstellungen stehen in der Datei config.yaml im Programmordner. Sie öffnen sie mit einem Texteditor. Nach einer Änderung starten Sie den Dienst neu. Jeden Wert können Sie stattdessen auch über eine Umgebungsvariable setzen, die in der Tabelle unter dem Namen steht. Lizenzschlüssel und E-Mail-Adresse lassen sich zusätzlich aus einer Datei lesen, etwa aus einem Docker-Secret: Hängen Sie dazu _FILE an den Namen an und geben Sie den Pfad der Datei an, zum Beispiel SPHERIFYER_LICENSE_KEY_FILE=/run/secrets/spherifyer_license.

Befehle

Diese Befehle geben Sie im Konsolenfenster im Programmordner ein.

Tasten im Konsolenfenster

Schnittstelle für eigene Auswertungen

Alle Daten des Dashboards können Sie auch als JSON abrufen, etwa für eigene Skripte oder Überwachungssysteme. Bis auf die als öffentlich markierten Adressen müssen Sie dafür angemeldet sein (POST /api/auth/login). Ohne Lizenz liefert die Schnittstelle dasselbe wie das Dashboard, also nur den einen sichtbaren Host mit seinen VMs und Datastores.