Updates

Der Update-Pfad bestimmt, welche Pakete Sie herunterladen müssen und gegebenenfalls, ob eine Aktualisierung der Linux-Distribution vor dem Checkmk-Update notwendig oder nach dem Checkmk-Update möglich ist.

Mit lokalen Dateien können Sie die von Checkmk bereitgestellte Funktionalität anpassen und erweitern. Diese Dateien befinden sich im lokalen Teil der Instanzverzeichnisstruktur, d. h. in ~/local. Lokale Dateien können bei einem Update Probleme bereiten, da sie eventuell nicht mehr zur neuen Checkmk-Version passen.

Da es für Checkmk bei einem Update nicht möglich ist, die lokalen Anpassungen und jede von einem Drittanbieter hergestellte Erweiterung abzufangen und zu behandeln, sollten Sie Ihre Checkmk-Instanz vor einem Update daraufhin überprüfen, ob lokale Dateien bei Ihnen verwendet werden und gegebenenfalls welche.

Verschaffen Sie sich einen Überblick über die lokalen Dateien Ihrer Checkmk-Instanz, indem Sie als Instanzbenutzer den folgenden Befehl ausführen (bei dem die Option -L dafür sorgt, dass auch symbolischen Links gefolgt wird):

In einer frischen Checkmk-Installation ist die Ausgabe leer. Werden Dateien gefunden, gleichen Sie die Liste mit der Ausgabe von mkp find ab. Im Idealfall sind lokale Dateien bereits vollständig in MKPs gebündelt.

Ist dies nicht der Fall, bündeln Sie zusammengehörende Dateien jeweils in Checkmk-Erweiterungspaketen (MKPs). Einmal zu einem Paket zusammengefasst, kann eine Erweiterung als ganzes deaktiviert oder erneut aktiviert werden.

Beim Update auf eine höheres Patch-Version innerhalb einer Major-Version sind bezüglich der Kompatibilität von MKPs selten Überraschungen zu erwarten. Auszuschließen sind Inkompatibilitäten jedoch nie. Beispielsweise setzen manche Entwickler von Erweiterungen die höchste Kompatibilität auf eine bestimmte Patch-Version von Checkmk, wenn ein Anbieter einer REST-API eine Version zu einem bestimmten Datum abkündigt.

Größer ist die Wahrscheinlichkeit von Inkompatibilitäten bei Updates der Major-Version. Prüfen Sie bei inkompatiblen Erweiterungen, die Sie von Dritten (beispielsweise aus der Checkmk Exchange) bezogen haben, ob eine neue Version vorliegt. Ist das nicht der Fall – oder die Erweiterung selbst entwickelt –, finden Sie im Artikel Erweiterungen für Checkmk entwickeln alle nötigen Informationen, um Ihre Erweiterungen anzupassen.

Die Selbstverständlichkeit, ein Backup unmittelbar vor dem Update zu erstellen, um im Falle eines Fehlschlags nicht allzu viel Ihrer Monitoring-Historie zu verlieren, müssen wir Ihnen nicht erklären. Detaillierte Beispiele zum Backup mit omd backup finden Sie im Artikel zur Instanzverwaltung mit omd.

Zusätzlich zum dateibasierten Backup ist es sinnvoll, die Versionierung der Konfiguration mit Git in den Global settings zu aktivieren. Diese erlaubt es, im Falle der Notwendigkeit eines Rollback keine Lücken in den Monitoring-Daten zu haben.

Wie in der Einleitung beschrieben, ist der erste Schritt beim Update die Installation der gewünschten neuen Version von Checkmk. Dies erfolgt genau wie bei der ersten Installation  —  allerdings wird es wohl etwas schneller gehen, weil die meisten benötigten Pakete jetzt schon installiert sind. Im folgenden Beispiel wird ein Paket für Ubuntu 24.04 (Noble Numbat) installiert:

Ist ein Update der Major-Version geplant, die zu aktualisierende Instanz aber noch nicht auf der letzten Patch-Version, müssen Sie zudem das entsprechende Paket installieren:

Die Liste der installierten Checkmk-Versionen können Sie jederzeit mit dem Befehl omd versions abrufen:

Eine dieser Versionen ist mit (default) markiert. Diese Standardversion wird automatisch beim Anlegen von neuen Instanzen verwendet. Beim Verwalten bestehender Instanzen spielt die Standardversion keine Rolle. Der omd-Befehl startet immer mit der Version, die zur Instanz passt, für die der Befehl aufgerufen wird.

Eine Auflistung der aktuellen Instanzen und welche Versionen diese verwenden liefert der Befehl omd sites:

Nachdem die gewünschte neue Version installiert ist, können Sie das Update der Instanz durchführen. Dazu sind keine root-Rechte erforderlich. Machen Sie das Update am besten als Instanzbenutzer:

Stellen Sie sicher, dass die Instanz gestoppt ist:

Das Aktualisieren — also eigentlich das Umschalten auf eine andere Version — geschieht nun einfach mit dem Befehl omd update:

Falls es mehr als eine mögliche Zielversion gibt, bekommen Sie diese zur Auswahl:

Bestätigen Sie in der folgenden Dialogbox das gewählte Update auf die neue Version:

Wenn Sie gleichzeitig zum Versions-Update ein Editions-Upgrade von Checkmk Community auf eine der kommerziellen Editionen durchführen, werden Sie sicherheitshalber noch einmal auf diesen Umstand hingewiesen:

Ein wichtiger Teil des Updates ist das Aktualisieren von mitausgelieferten Konfigurationsdateien. Dabei werden von Ihnen eventuell vorgenommene Änderungen in diesen Dateien nicht einfach verworfen, sondern zusammengeführt. Dies funktioniert sehr ähnlich zu Versionskontrollsystemen, die versuchen, gleichzeitige Änderungen mehrerer Entwickler in der gleichen Datei automatisch zusammenzuführen.

Manchmal — wenn die Änderungen die gleiche Stelle der Datei betreffen — funktioniert das nicht und es kommt zu einem Konflikt. Wie Sie diesen lösen können, zeigen wir weiter unten.

Das Update zeigt eine Liste aller angepassten Dateien und Verzeichnisse (im folgenden Beispiel gekürzt):

Wenn die in der obigen Ausgabe hervorgehobene Zeile Completed verifying site configuration angezeigt wird, ist die Instanz auf die neue Version umgeschaltet:

… und kann gestartet werden:

Während inkompatible Änderungen bei Patch-Versionen seltener sind und meist nur kleinere Nacharbeiten erfordern, kommt es bei Major-Updates häufiger vor, dass neue Check-Plugins bestehende Plugins ersetzen. Falls Sie eines der betroffenen Plugins einsetzen, ist nach dem Update eine erneute Service-Erkennung auf den betroffenen Hosts notwendig.

Eine Übersicht über alle Änderungen in Checkmk, inklusive einer Suchfunktion, finden Sie online in unseren Werks.

Noch praktischer ist aber die in Checkmk eingebaute Funktion zur Recherche. Nachdem Sie sich an der Instanz angemeldet haben, finden Sie oben im Help-Menü einen rot hinterlegten Link mit der Zahl inkompatibler und noch nicht bestätigter Änderungen:

Checkmk verfolgt die beim Update zur aktuellen Version angefallenen inkompatiblen Änderungen und fordert Sie auf, diese zu überprüfen und dann zu bestätigen (acknowledge):

Wenn Sie diese Seite über den rot hinterlegten Link im Help-Menü öffnen, werden Ihnen nur die „Werks“ (d.h. die Änderungen) angezeigt, bei denen etwas zu tun ist, und die daher mit Incompatible - TODO gekennzeichnet sind. Sie können jedes Werk einzeln aufrufen, ansehen, per Mausklick bestätigen — und damit die Zahl der offenen, inkompatiblen Änderungen sukzessive verringern. Zusätzlich haben Sie mit dem Menüeintrag Help > About Checkmk > Change log (Werks) Zugriff auf die komplette Historie der Änderungen in der aktuellen Major-Version.

Der technische Grund für die Vorgehensweise liegt in den verwendeten Protokollen: Die Zentralinstanz greift auf die Daten der Remote-Instanzen primär lesend via Livestatus zu, bei zentralem Setup zudem schreibend über eine nicht-öffentliche HTTP-API. In beiden Fällen gilt, dass neue Versionen echte Obermengen der verwendeten Protokolle einführen. So nutzt eine ältere Zentralinstanz nur eine echte Teilmenge der Funktionalität der neueren Remote-Instanzen. Würde man die Zentralinstanz zuerst aktualisieren, würde sie bei den Remote-Instanzen möglicherweise API-Aufrufe oder Livestatus-Anfragen verwenden, welche diese noch nicht verstehen.

Der maximale Versionsunterschied einer Major-Version resultiert wiederum daraus, dass die Entfernung von Schnittstellen mit einer Schonfrist von genau einer Version einhergeht.

Um die phasenweise Aktualisierung zu erleichtern, bietet Checkmk die Möglichkeit, gleichnamige Erweiterungspakete in verschiedenen Versionen – eines passend zur älteren Zentralinstanz, eines passend zu den neueren Remote-Instanzen – zu hinterlegen. Aktiviert wird das jeweils passende. Details beschreibt der Artikel zu Erweiterungspaketen (MKPs).

Bei der Verwendung von Viewer-Instanzen dürfen die Viewer-Instanzen erst nach den Instanzen aktualisiert werden, deren Daten sie anzeigen. Zeigt eine Viewer-Instanz nur Daten von Remote-Instanzen, kann deren Aktualisierung erfolgen, sobald die Remote-Instanzen aktualisiert sind. Zeigt die Viewer-Instanz dagegen auch Daten der Zentralinstanz, darf sie erst als letztes aktualisiert werden.

Falls die neue Version eine Änderung an einer Konfigurationsdatei vorsieht, an der Sie inzwischen selbst Änderungen vorgenommen haben, versucht Checkmk, beide Änderungen automatisch zusammenzuführen (merge). Dies geschieht mit den gleichen Methoden, die auch Versionskontrollsysteme verwenden.

Am wenigsten Probleme gibt es immer dann, wenn Ihre und Checkmks Änderungen räumlich weit genug auseinander liegen (mindestens ein paar Zeilen). Dann erfolgt die Zusammenführung automatisch und ohne Ihre Hilfe.

Wenn zwei Änderungen kollidieren, weil sie die gleiche Stelle der Datei betreffen, kann und will Checkmk nicht entscheiden, welche der beiden Änderungen wichtiger ist. In diesem Fall werden Sie als Benutzer eingeschaltet und können den Konflikt interaktiv auflösen:

Sie haben nun folgende Möglichkeiten:

Neben dem inhaltlichen Zusammenführen von Dateien gibt es noch eine ganze Reihe weiterer Fälle, in denen Checkmk Ihre Entscheidung braucht. Dies sind teils sehr ungewöhnliche Situationen, die aber trotzdem korrekte Behandlung brauchen. Checkmk wird Ihnen in diesen Fällen stets die Auswahl geben, Ihre Version beizubehalten oder die neue Standardversion zu übernehmen. Außerdem haben Sie immer die Möglichkeit eines Abbruchs oder können eine Shell öffnen. Beispiele für solche Fälle sind:

Bei einem Fehlschlag des Updates lohnt es sich, zuerst selbst vorgenommene Änderungen an Konfigurationsdateien zu überprüfen. Des weiteren sollten Sie überprüfen, ob möglicherweise eine unsauber programmierte Erweiterung das Problem verursacht und diese gegebenenfalls deaktivieren. Natürlich ist es nicht ausgeschlossen, dass sich ein Fehler in eine Update-Routine eingeschlichen hat. In diesem Fall bitten wir um Hinweise in einem Support-Ticket (wenn Sie einen Support-Vertrag abgeschlossen haben) oder im Checkmk-Forum.

Die folgenden Optionen steuern das Verhalten der Vorabüberprüfungen und sollten gegenüber --force (kurz -f) bevorzugt benutzt werden:

Die folgenden Optionen steuern das Verhalten beim ersten Schritt der Aktualisierung der Konfiguration, der dateibasierten Aktualisierung:

Die folgenden Optionen werden an das Programm cmk-update-config weitergegeben und steuern das Verhalten beim zweiten Schritt der Aktualisierung der Konfiguration, wo Formatänderungen oder Umstellungen von Listen auf Objekte vorgenommen werden.

Ein Beispiel für den kompletten Befehl für ein automatisches Update der Instanz mysite auf die Version 2.5.0p8.community:

Durch das && vor dem omd start wird ein Starten der Instanz verhindert, falls das omd update bei der Aktualisierung der Konfiguration mit einem Fehler abbricht. Ersetzen Sie das && durch ein Semikolon (;), falls Sie einen Start auch in diesem Fall unbedingt versuchen wollen.