MKPs für Entwickelnde

Verwenden Sie zur Erstellung und Anpassung von MKPs eine Instanz zum Testen und kopieren Sie die MKPs für die Verteilung auf die produktiv genutzte Instanz. Dies wird Ihnen vor allem zwei potentielle Probleme ersparen, die entstehen, wenn geänderte Dateien nicht rechtzeitig zu MKPs gepackt werden:

Zudem ist das Risiko, versehentlich etwas bereits Vorhandenes zu überschreiben, weit geringer, wenn eine Instanz primär zum Testen eigener Entwicklungen eingesetzt wird und keine produktiv genutzten Erweiterungen aus anderer Quelle nutzt.

Zur Verwaltung von MKPs gibt es zwei Werkzeuge:

Beide Wege sind kompatibel, und mit der einen Methode vorgenommene Änderungen sind sofort in der anderen Methode sichtbar. Aber: auf der Befehlszeile stehen zusätzliche Optionen zur Verfügung, die künftig weiter ausgebaut werden. Daneben ist der Einsatz in Skripten möglich.

Für die Entwicklungsarbeit raten wir daher zur Verwendung der Befehlszeile.

Damit ein Paket aufgelöst werden kann, muss dieses zunächst den Zustand Enabled (active on this site) haben. Dies überprüfen Sie mit dem folgenden Befehl:

Ist das Paket nicht aktiv, aktivieren Sie es:

Im Falle, dass ein Paket mit Ihrer Checkmk-Version inkompatibel ist, sie das Paket aber dennoch aktivieren wollen – eben gerade um es auf die neuere Checkmk-Version anzupassen – verwenden Sie den zusätzlichen Parameter --force-install.

Das Auflösen geschieht dann mit dem folgenden Befehl:

Im Setup der kommerziellen Editionen steht alternativ das Symbol eines Klemmbausteins () zur Verfügung.

Nun passen Sie vorhandene Dateien an oder fügen neue hinzu. Falls Ihre Arbeit nicht auf einem vorhandenen MKP basiert, sondern sozusagen „von Null“ beginnt, werden Sie zunächst eine Verzeichnisstruktur anlegen und diese beispielsweise befüllen, wie es in den Artikeln zur Programmierung von agentenbasierten Check-Plugins, Spezialagenten oder SNMP-Plugins beschrieben ist.

Hat Ihre Entwicklungsarbeit einen Stand erreicht, mit dem Sie zufrieden sind, bereiten Sie das erneute Verpacken vor. Der erste Schritt hierfür ist, sich einen Überblick zu verschaffen, welche unpaketierten Dateien im Instanzverzeichnis liegen. Mit dieser Information können Sie entscheiden, ob Sie Dateien löschen oder frühere Experimente zuerst paketieren wollen.

Der hierfür verwendete Befehl ist mkp find:

Die angezeigte Liste ist rein informativ. Bei den kommerziellen Editionen können Sie auf der Seite Extension packages den Knopf List unpackaged files verwenden. In der angezeigten Seite können Sie nicht mehr benötigte Dateien einfach löschen.

Mit dem Befehl mkp template erstellen Sie eine Vorlage für eine Paketkonfiguration. Als weiterer Parameter ist der Name des Pakets anzugeben. Da der Befehl auf die Standardausgabe schreibt, müssen Sie die Ausgabe entweder umleiten oder Sie kopieren Sie einfach aus dem Terminal:

Wollen Sie stattdessen die Paketkonfiguration eines zuvor aufgelösten Paketes verwenden, extrahieren Sie diese einfach aus dem ursprünglichen Paket:

Passen Sie die Paketkonfiguration jetzt mit Ihrem Lieblingseditor an. Wie bei vielen anderen Konfigurationsdateien in Checkmk handelt es sich hier um eine Python-Datei. Achten Sie daher auf korrekte Python-Syntax.

Unter dem Schlüssel files können Sie Dateien entfernen, welche nicht paketiert werden sollen. Tragen Sie unter version.min_required die Mindestversion von Checkmk ein, die erforderlich ist, um das Paket zu verwenden. Unter version.usable_until können Sie die höchste Checkmk-Version angeben, für die das Paket nutzbar ist. Wenn Sie ausschließlich die stabilen öffentlichen Plugin-APIs nutzen, wird Ihr Paket die ganze Spanne von 2.3.0 bis 3.0.99 abdecken. Die verwendete Versionsnummer (Schlüssel version) muss den Konventionen des Semantic Versioning entsprechen. Inkrementieren Sie bei kleinen Änderungen wie Bugfixes nur die letzte Stelle.

Wenn Sie eine kommerzielle Edition verwenden, finden Sie auf der Seite Setup > Maintenance > Extension packages den Knopf Create package. Dieser Knopf führt Sie zu einem Formular, in dem Sie alle in der Vorlage für die Paketkonfiguration enthaltenen Parameter eintragen können – ohne auf korrekte Python-Syntax achten zu müssen.

Ist das Bearbeiten der Konfigurationsdatei abgeschlossen, packen Sie mit mkp package gefolgt vom Namen der Konfigurationsdatei:

Bei diesem Vorgang wird nicht nur das MKP erzeugt, welches Sie dann in ~/var/check_mk/packages_local/ vorfinden oder im Paketmanagement der kommerziellen Editionen herunterladen können. Das Paket wird zusätzlich direkt aktiviert (hat also den Zustand Enabled (active on this site)), was exakt dem Verhalten vor dem Paketieren entspricht.

Beachten Sie, dass beim Packen auf einer produktiv genutzten Instanz bei aktiviertem zentralem Setup das neue Paket direkt an die Remote-Instanzen verteilt wird. Diese Tatsache sollte ein weiterer Anlass für die Nutzung dedizierter Testinstanzen sein.