Automatisch Hosts erstellen

Die Berechtigungen, die zur Registrierung des Agenten beim Checkmk-Server (für die TLS-verschlüsselte Datenübertragung) und zur Erstellung von Hosts benötigt werden, sind in der Rolle Agent registration user enthalten. Dabei sind in dieser Rolle die Berechtigungen zur Registrierung neuer Hosts nur ab Checkmk Cloud verfügbar.

Diese Rolle ist dem Automationsbenutzer agent_registration zugewiesen, der in jeder Checkmk-Instanz eingerichtet ist und dessen Eigenschaften Sie sich über Setup > Users > Users anzeigen lassen können:

Es bietet sich an, für die Autoregistrierung diesen Automationsbenutzer zu verwenden, der nichts anderes darf, als Hosts zu registrieren.

Die automatisch erstellten Hosts sollen in einem neuen Ordner angelegt werden. Sie können alternativ auch einen bestehenden Ordner verwenden, wenn Sie ihn so konfigurieren, wie es im Folgenden beschrieben ist.

Starten Sie die Erstellung eines Ordners mit Setup > Hosts > Hosts > Add folder. Geben Sie dem Ordner im Kasten Basic settings einen Namen.

Im Kasten Network address geht es um die Option IP address family. Sollen die Checkmk-Agenten der zu erstellenden Hosts den Pull-Modus verwenden, können Sie den Standardwert IPv4 only unverändert lassen. Für den Push-Modus wählen Sie den Wert No IP aus. Damit verhindern Sie, dass die Erreichbarkeit des Hosts per Smart Ping überprüft wird.

Im folgenden Kasten Monitoring agents setzen Sie zwei wichtige Optionen für die Autoregistrierung. Mit Checkmk agent connection mode entscheiden Sie, ob der Checkmk-Agent im Pull-Modus oder (wie im folgenden Bild) im Push-Modus arbeiten soll. Diese Option gibt es nur ab Checkmk Cloud. Aktivieren Sie schließlich bei Bake agent packages die Checkbox Bake a generic agent package for this folder. Damit nutzen Sie die Möglichkeit der Agentenbäckerei, eine Agentenkonfiguration für einen Ordner und alle darin enthaltenen und hinzukommenden Hosts zu erstellen.

Schließen Sie die Erstellung des Ordners mit Save ab.

Die Entscheidung darüber, welche Hosts sich automatisch registrieren dürfen, welche Namen sie erhalten und was sonst noch nach der Registrierung mit ihnen geschieht, wird in Checkmk — wenig überraschend — mit Regeln getroffen. Dabei spielen die Labels, mit denen sich der Agent des Hosts bei der Registrierung meldet, eine entscheidende Rolle. Doch der Reihe nach.

Den Regelsatz Agent registration gibt es nur ab Checkmk Cloud. Sie finden ihn unter Setup > Agents (sofern der Show-more-Modus aktiv ist) oder über die Suche im Setup-Menü. Starten Sie mit Add rule die Erstellung einer neuen Regel und vergeben Sie im ersten Kasten Properties, wie bei Checkmk gewohnt, zuerst eine ID und einen Titel.

Im folgenden Kasten Matching criteria bestimmen Sie, welche Labels akzeptiert werden, wenn der Checkmk-Server eine Anfrage zur Registrierung von einem Agenten erhält. Diese Agenten-Labels werden ausschließlich für die Autoregistrierung verwendet und sind andere als die Labels, die sonst in Checkmk zur Kennzeichnung von Hosts und Services verwendet werden. Zwei Agenten-Labels werden vom Checkmk-Agenten geliefert und können in der Liste ausgewählt werden: cmk/hostname-simple enthält den Host-Namen ohne Domain-Anteil (daher simple) und ist für die Bestimmung eines eindeutigen Host-Namens in Checkmk gedacht. cmk/os-family liefert das Betriebssystem des Hosts und kann z.B. für die Ablage der Hosts in unterschiedlichen Ordnern verwendet werden. Sie können mit Custom label aber auch Ihre eigenen Labels eintragen.

Dabei wird das durch Doppelpunkt getrennte Schlüssel-Wert-Paar, aus dem sich ein Label zusammensetzt (z.B. cmk/os-family:linux) separat ausgewertet. So können Sie gezielt festlegen, dass ein Schlüssel (z.B. cmk/os-family) vorhanden sein muss (Exists), nicht vorhanden sein darf (Does not exist) oder nur mit einem vorgegebenen Wert (Equals) akzeptiert wird. Als Wert können Sie auch einen regulären Ausdruck (Regex) eingeben. Wenn Sie mehrere Agenten-Labels festlegen, werden diese logisch mit UND verknüpft. Im folgenden Beispiel soll neben dem vordefinierten Label cmk/hostname-simple auch noch das benutzerdefinierte Label my_autoregister_label geprüft werden:

Hinweis: Jeder Host, der erfolgreich automatisch registriert wurde, erhält von Checkmk das Host-Label cmk/agent_auto_registered:yes angehängt. Dieses Label können Sie aber hier nicht verwenden, da es kein Agenten-Label ist und erst nach der Registrierung vergeben wird.

Im nächsten Kasten Action bestimmen Sie, was passieren soll, wenn die Auswertung der Labels greift: Den Host erstellen oder eben nicht. Bei Auswahl von Stop and do not create hosts ist die Regelauswertung abgeschlossen und die beiden folgenden Kästen werden nicht mehr betrachtet. In unserem Beispiel sollen aber Hosts erstellt werden:

Im Kasten Hostname computation legen Sie nun fest, welchen Namen der Host erhalten soll. Im Feld Hostname template geben Sie die Vorlage ein. Hier können Sie per Makro auf die Werte derjenigen Agenten-Labels zugreifen, die Sie im obigen Kasten Matching criteria ausgewählt haben, z. B. mit $cmk/hostname-simple$ auf den vom Checkmk-Agenten gelieferten einfachen Host-Namen. Die Vorlage können Sie dann, wenn gewünscht, verändern durch Umwandlung in Klein- oder Großbuchstaben sowie Ersetzungen mit regulären Ausdrücken und mit expliziten Host-Namen. Dies sind übrigens die gleichen Optionen, die es bei der Anpassung der Namen von Piggyback Hosts gibt. Mehr Informationen finden Sie auch in der Inline-Hilfe.

Zum Schluss wählen Sie dann noch im Kasten Host creation den vorbereiteten Ordner aus, in dem die neuen Hosts landen sollen. Zusätzlich können Sie noch Attribute bestimmen, die dem Host mitgegeben werden sollen. Mehr zu diesen Attributen erfahren Sie im Artikel zur Verwaltung der Hosts.

Nach dem Sichern der Regel, kehren Sie zur Seite Agent registration zurück. Hier finden Sie den Agent labels simulator. Wenn Sie viele Regeln definiert haben, hilft Ihnen der Simulator dabei, den Überblick zu behalten. Sie können Agenten-Labels eingeben und mit Try out simulieren, ob und welche Regel bei der Übermittlung eines Agenten-Labels greift. Im Ergebnis sehen Sie dann die farbigen Ampelsymbole, die im Artikel zu den Regeln beschrieben sind.

Nachdem im vorherigen Abschnitt die Checkmk-Instanz konfiguriert wurde, geht es jetzt um den Agent Controller des Checkmk-Agenten. Hierfür nutzen Sie den Agent controller auto-registration Regelsatz der Agentenbäckerei, der nur ab Checkmk Cloud vorhanden ist. Sie finden den Regelsatz in der Agentenbäckerei unter Agent rules oder am schnellsten über die Suche im Setup-Menü. Erstellen Sie eine neue Regel.

In Kasten Agent controller auto-registration geben Sie dem Agent Controller alle Informationen mit, die dieser für eine Registrierungsanfrage beim Agent Receiver benötigt: den Checkmk-Server (Monitoring server address), gegebenenfalls mit der Portnummer des Agent Receivers (Agent receiver port), die Checkmk-Instanz (Site to register with) und den Automationsbenutzer für die Autoregistrierung.

Sie können auch hier mit Additional agent labels to send during registration eigene Labels definieren. Damit die Autoregistrierung funktioniert, müssen diese Labels zu denen passen, die Sie in der Regel für die Checkmk-Instanz als Custom label eingetragen haben: im Beispiel also das zuvor gesetzte benutzerdefinierte Label mit dem Schlüssel my_autoregister_label.

Mit der letzten Option Keep existing connections bestimmen Sie, ob der Agent Controller bereits existierende Verbindungen löschen (no) oder behalten soll (yes). Wenn Sie neben der automatischen Registrierung einer Verbindung auch manuelle Verbindungen zu anderen Checkmk-Instanzen konfiguriert haben, und diese auch nach einem Neustart des Agent Controllers cmk-agent-ctl behalten wollen, sollten Sie diese Option auf yes setzen.

Wichtig: Im letzten Kasten Conditions dieser Regel wählen Sie als Folder erneut den vorbereiteten Ordner aus.

Nun geht es weiter in der Agentenbäckerei mit Setup > Agents > Windows, Linux, Solaris, AIX. Klicken Sie auf und backen Sie sich einen neuen Agenten. Als Ergebnis erhalten Sie zusätzlich zur Agentenkonfiguration Vanilla (factory settings) eine neue Zeile für die Konfiguration, in der die Regel eingebacken ist, die im vorherigen Abschnitt erstellt wurde:

Das Agentenpaket muss nun auf jedem Host installiert werden, der eine Autoregistrierung starten soll. Laden Sie das für das Betriebssystem des Hosts passende Agentenpaket herunter und installieren Sie es auf dem Host. Das Vorgehen ist genauso, wie in der Agentenbäckerei üblich. Mehr dazu finden Sie in den Artikeln zu den Monitoring-Agenten, dem Linux-Agenten und dem Windows-Agenten.

Nach der Installation des Agentenpakets wertet der Agent Controller die Datei /var/lib/cmk-agent/pre_configured_connections.json aus und setzt für eine darin enthaltene Verbindung den Befehl zur Registrierung ab. Wenn der Agent Receiver akzeptiert, wird die Verbindung eingerichtet und der Host in der Checkmk-Instanz erstellt.

Anschließend wird die Service-Erkennung durchgeführt und die Änderungen aktiviert, damit der Host auch im Monitoring sichtbar ist. Beachten Sie, dass bei der automatischen Aktivierung alle anderen gesammelten Änderungen — auch von anderen Benutzern — mit aktiviert werden.

Es kann insgesamt einige (bis zu 5) Minuten dauern von der Installation des Agentenpakets bis zum Erscheinen des Hosts im Monitoring. Die einzelnen Schritte können Sie in Setup > General > Audit log nach Auswahl der Datei wato_audit.log nachverfolgen.

Auf dem Host können Sie sich den Verbindungsstatus des Agent Controllers per Kommando ausgeben lassen, der nach einer erfolgreichen Registrierung im Push-Modus etwa so aussieht:

Automatisch erstellte Hosts können Sie auch wieder automatisch entfernen lassen. Ab Checkmk Cloud bietet Checkmk damit die beiden wichtigsten Komponenten für das Lifecycle Management von Hosts. Übrigens funktioniert die automatische Entfernung auch für manuell erstellte Hosts — und das in allen Editionen.