Checkmk-Erweiterungspakete (MKPs)

Auf der Checkmk Exchange können Plugin-Programmierer Pakete für andere Checkmk-Benutzer bereitstellen und untereinander austauschen. Von dort können Sie kostenlos Erweiterungen herunterladen und verwenden. Beachten Sie bei Paketen von der Exchange, dass diese durch andere Benutzer freiwillig und ohne jede Garantie bereitgestellt werden.

Unsauber programmierte Plugins können zu erhöhter Last und erhöhtem Arbeitsspeicherbedarf führen. Zudem ist es möglich, dass MKPs für ältere Versionen von Checkmk entwickelt wurden und so keine vollständige Kompatibilität vorhanden ist (von Version 1.6.0 auf 2.0.0 z.B. wechselte Checkmk von Python 2 auf Python 3). In Extremfällen droht Datenverlust. Wir empfehlen daher vor dem produktiven Einsatz fremder MKPs die Installation in einer Testinstanz.

Zur Verwaltung von MKPs gibt es zwei Werkzeuge:

Beide sind miteinander kompatibel, sodass Sie mal den Befehl und mal Extension Packages verwenden können, ohne dass dabei etwas „durcheinander gerät“.

Ein MKP, das Sie z.B. von der Exchange heruntergeladen haben, können Sie mit dem Knopf Upload package in Checkmk hochladen und so verfügbar machen. Dafür muss die Datei auf dem Rechner vorhanden sein, auf dem auch Ihr Webbrowser läuft. Die Dateiendung des Pakets muss .mkp sein.

Nach der Installation ist das Erweiterungspaket zunächst verfügbar, jedoch nicht aktiv. Es befindet sich unter All packages (enabled or disabled):

Erst mit dem Klick auf den Knopf mit dem Steckersymbol wird ein verfügbares Paket auch aktiviert. Bei der Aktivierung werden die Dateien in einer Ordnerhierarchie unterhalb von ~/local/ installiert und eine Paketbeschreibungsdatei in ~/var/check_mk/packages/ abgelegt. Das Paket erscheint dann auch in der Liste der freigeschalteten und aktiven MKPs – Enabled (active on this site):

Nun führen Sie noch eine Aktivierung der Änderungen durch und alle Funktionen aus dem Paket sind im System verankert und stehen Ihnen bereit.

Auch die vollständige Löschung eines Paketes erfolgt zweistufig. Mit dem deaktivieren Sie es zunächst in der Liste der aktiven Pakete. In diesem Schritt werden die installierten Dateien entfernt, aber das MKP wird weiter vorgehalten – dieser Schritt macht lediglich die Aktivierung rückgängig.

Über das Symbol in der Liste aller Pakete können Sie installierte und nicht verwendete Pakete wieder löschen. Beim Löschen wird das Paket gelöscht und somit die Erweiterung komplett entfernt – also das Gegenteil des Hinzufügens eines Paketes.

Bei einem verteilten Monitoring mit zentralem Setup reicht es, wenn Sie die Pakete auf der Zentralinstanz verfügbar machen. Für jede der Zentralinstanz zugeordnete Remote-Instanz können Sie dann separat bestimmen, ob die Anpassungen an diese Instanz übertragen werden sollen. Sie müssen dazu lediglich die Option Replicate extensions aktivieren. Danach werden bei der Synchronisation auch die MKPs und alle anderen Änderungen unterhalb des Verzeichnisses ~/local übertragen.

Ist die Übertragung nicht gewünscht, schalten Sie die Option für diese oder alle Instanzen einfach ab.

Wichtig: Die Anpassungen für das zentrale Setup werden nur übertragen, wenn die Option Enable replication auf Push configuration to this site eingestellt ist.

Einen Sonderfall stellt der Aktivierungsversuch eines Paketes dar, das nicht zur verwendeten Checkmk-Version passt. Ein solches Paket, das zwar freigeschaltet ist, aber dessen Aktivierung wegen einer inkompatiblen Checkmk-Version fehlschlägt, landet in der Liste Enabled (inactive on this site).

Warum aber sollte man Pakete installieren, die nicht zur verwendeten Checkmk-Version passen? Dafür gibt es zwei gute Gründe:

Aus den Versionsnummern im Screenshot können Sie entnehmen, dass es sich um eine Checkmk 2.1.0 Zentralinstanz handelte, die Pakete für Remote-Instanzen bereithält, welche bereits auf 2.2.0 aktualisiert wurden.

Das Hinzufügen eines Pakets geschieht mit mkp add. Dazu müssen Sie die MKP-Datei natürlich zunächst auf den Checkmk-Server bringen (z.B. mit scp). Anschließend führen Sie den folgenden Befehl aus:

Die Liste der vorhandenen Pakete rufen Sie mit mkp list ab. Nach der Installation ist das Erweiterungspaket zunächst verfügbar, jedoch nicht aktiv. Es hat den Zustand State: Disabled:

Erst mit dem Sub-Befehl enable wird ein verfügbares Paket auch aktiviert. Die Angabe der Versionsnummer ist nur in dem Fall erforderlich, dass der Name alleine nicht eindeutig ist:

Prinzipiell können Sie — auch auf der Befehlszeile — nur MKPs aktivieren, die zur Version Ihrer Checkmk-Installation passen. Wenn Sie die Versionsbeschränkungen übergehen und das MKP unter allen Umständen installieren (freischalten und aktivieren) wollen, nutzen Sie --force-install. Dies ist in erster Linie für Entwickler relevant, die in verteilten Umgebungen Pakete schrittweise an neue Checkmk-Versionen anpassen müssen.

Bei der Aktivierung – egal ob mit oder ohne force-install – werden die Dateien in einer Verzeichnishierarchie unterhalb von ~/local/ installiert und die Paketbeschreibungsdatei in ~/var/check_mk/packages/ abgelegt. Das Paket erhält dadurch den Zustand Enabled (active on this site):

Details über ein einzelnes Paket erfahren Sie mit mkp show, der Aktivierungszustand spielt dabei keine Rolle:

Die Deinstallation eines Pakets geschieht in zwei Stufen. Zunächst wird das Paket mit mkp disable deaktiviert. Dies löscht installierte Dateien, hält das Paket aber – beispielsweise für eine spätere erneute Aktivierung – weiterhin vor. Die Angabe der Versionsnummer ist auch hier nur in dem Fall erforderlich, dass der Name alleine nicht eindeutig ist:

In der Paketliste sehen Sie nun den Zustand Disabled, wenn Sie ein weiteres Mal mkp list aufrufen:

Erst mkp remove löscht das Paket unwiderruflich:

Einen Sonderfall stellt die Installation eines Paketes dar, das nicht zur verwendeten Checkmk-Version passt:

Ein solches Paket können Sie zwar freischalten. Dessen Aktivierung schlägt dann aber wegen der inkompatiblen Checkmk-Version fehl und erhält den Zustand Enabled (inactive on this site).

Die Gründe für die Installation inkompatibler Pakete – Updates und verteilte Umgebungen – erklären wir oben im entsprechenden Setup-Schritt. Ebenso analog zum Vorgehen im Setup verwenden Sie mkp enable paketname version, um ein Paket freizuschalten, respektive mkp disable paketname version, um eine vorhandene Freischaltung aufzuheben.