Update plugin documentation
This commit is contained in:
dbildhauer committed
1 parent
11ce8a4615
commit
f3e3ff0282
3 files changed
+111
-446
No files matched your search
@@ -1,178 +1,79 @@
|
||||
# Checkmk Plugins
|
||||
# 🔍 Checkmk Plugins
|
||||
|
||||
Sammlung eigener Plugins und Erweiterungen für Checkmk.
|
||||
|
||||
|
||||
|
||||
|
||||
Dieses Repository enthält Checkmk-Erweiterungen, die für meine eigene Monitoring-Umgebung entwickelt und getestet werden. Die einzelnen Plugins werden jeweils mit Source-Code, Dokumentation und einem installierbaren MKP-Paket bereitgestellt.
|
||||
Sammlung eigener Plugins und Erweiterungen für **Checkmk Community 2.5.x**.
|
||||
|
||||
## Umgebung
|
||||
## 📦 Verfügbare Plugins
|
||||
|
||||
Die Plugins werden primär entwickelt und getestet mit:
|
||||
### 🔗 Remote Access
|
||||
Direkter SSH- und RDP-Zugriff aus der Checkmk-Weboberfläche. **Version:** `1.4.4`
|
||||
|
||||
- Checkmk Community Edition
|
||||
- Checkmk 2.5
|
||||
- Linux-Hosts
|
||||
- Windows-Hosts
|
||||
- Checkmk Agent 2.5
|
||||
- 🐧 SSH für Linux-/Unix-Systeme
|
||||
- 🪟 RDP für Windows
|
||||
- automatische Erkennung über Checkmk Host Labels
|
||||
- Integration in `Setup → Hosts` und Monitoring Views
|
||||
- eigene SSH-/RDP-Icons
|
||||
|
||||
> Die Kompatibilität mit anderen Checkmk-Versionen oder der Enterprise Edition ist nicht grundsätzlich ausgeschlossen, wird aber nicht zwingend getestet.
|
||||
➡️ [Dokumentation](remote_access/README.md) · 📦 [MKP](remote_access/packages/remote_access-1.4.4.mkp)
|
||||
|
||||
---
|
||||
### 🖥️ OS Info
|
||||
Zeigt Betriebssysteminformationen als eigenen Checkmk-Service. **Version:** `1.0.0`
|
||||
|
||||
## Verfügbare Plugins
|
||||
- 🐧 Linux · 🪟 Windows · 🍎 macOS
|
||||
- Betriebssystem / Distribution und Version
|
||||
- Windows-Build, Architektur und Kernel-Version
|
||||
|
||||
### remote_access
|
||||
➡️ [Dokumentation](os-info/README.md) · 📦 [MKP](os-info/dist/os_info-1.0.0.mkp)
|
||||
|
||||
Direkter SSH- und RDP-Zugriff auf überwachte Hosts aus der Checkmk-Weboberfläche.
|
||||
## 🛠️ Umgebung und Kompatibilität
|
||||
|
||||
**Aktuelle Version:** `1.4.4`
|
||||
Primär entwickelt und getestet mit Checkmk Community Edition 2.5.x, Checkmk Agent 2.5 sowie Linux- und Windows-Hosts.
|
||||
|
||||
#### Funktionen
|
||||
> Andere Checkmk-Versionen oder Editionen können funktionieren, werden aber nicht zwingend getestet.
|
||||
|
||||
- SSH-Zugriff auf Linux-/Unix-Hosts
|
||||
- RDP-Zugriff auf Windows-Hosts
|
||||
- Automatische Betriebssystemerkennung über Checkmk Host Labels
|
||||
- Verwendung der von Checkmk ermittelten Host-IP
|
||||
- Integration in `Setup → Hosts`
|
||||
- Integration in Checkmk Monitoring Views
|
||||
- Eigene SSH- und RDP-Icons
|
||||
- Direkter SSH-Aufruf über `ssh://`
|
||||
- Direkter RDP-Aufruf über `rdpadmin://`
|
||||
|
||||
Weitere Informationen:
|
||||
|
||||
```text
|
||||
remote_access/README.md
|
||||
```
|
||||
|
||||
Fertiges MKP:
|
||||
|
||||
```text
|
||||
remote_access/packages/remote_access-1.4.4.mkp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Repository-Struktur
|
||||
## 📂 Repository-Struktur
|
||||
|
||||
```text
|
||||
cmk-plugins/
|
||||
├── README.md
|
||||
│
|
||||
├── remote_access/
|
||||
│ ├── README.md
|
||||
│ ├── CHANGELOG.md
|
||||
│ ├── packages/
|
||||
│ │ └── remote_access-1.4.4.mkp
|
||||
│ └── src/
|
||||
│ └── local/
|
||||
│ └── share/
|
||||
│ └── check_mk/
|
||||
│
|
||||
└── weitere_plugins/
|
||||
└── os-info/
|
||||
├── README.md
|
||||
├── CHANGELOG.md
|
||||
├── PROJECT.md
|
||||
├── LICENSE
|
||||
├── dist/
|
||||
└── src/
|
||||
```
|
||||
|
||||
Jedes Plugin erhält einen eigenen Ordner.
|
||||
|
||||
Dabei wird grundsätzlich folgende Struktur verwendet:
|
||||
|
||||
```text
|
||||
plugin_name/
|
||||
├── README.md
|
||||
├── CHANGELOG.md
|
||||
├── packages/
|
||||
│ └── plugin_name-VERSION.mkp
|
||||
└── src/
|
||||
└── local/
|
||||
└── share/
|
||||
└── check_mk/
|
||||
```
|
||||
|
||||
## Installation von MKP-Paketen
|
||||
|
||||
Das gewünschte `.mkp`-Paket auf den Checkmk-Server übertragen.
|
||||
|
||||
Anschließend als Checkmk-Site-Benutzer installieren:
|
||||
## 📥 Installation von MKP-Paketen
|
||||
|
||||
```bash
|
||||
mkp add /pfad/zum/plugin.mkp
|
||||
```
|
||||
|
||||
Plugin aktivieren:
|
||||
|
||||
```bash
|
||||
mkp enable PLUGIN_NAME VERSION
|
||||
```
|
||||
|
||||
Beispiel für `remote_access`:
|
||||
Je nach Plugin anschließend `cmk -R` oder bei Web-Erweiterungen `omd restart apache`. Details stehen in der jeweiligen Plugin-README.
|
||||
|
||||
```bash
|
||||
mkp add remote_access-1.4.4.mkp
|
||||
mkp enable remote_access 1.4.4
|
||||
```
|
||||
## 🏷️ Releases und Versionierung
|
||||
|
||||
Anschließend gegebenenfalls den Apache der Checkmk-Site neu starten:
|
||||
Plugins werden unabhängig versioniert. Git-Tags verwenden das Schema `PLUGIN_NAME-vVERSION`, z. B. `remote_access-v1.4.4` oder `os_info-v1.0.0`.
|
||||
|
||||
```bash
|
||||
omd restart apache
|
||||
```
|
||||
## ⚠️ Hinweise
|
||||
|
||||
Installierte MKP-Pakete anzeigen:
|
||||
Vor dem produktiven Einsatz sollte jede Erweiterung zunächst in einer Testumgebung geprüft werden.
|
||||
|
||||
```bash
|
||||
mkp list
|
||||
```
|
||||
## 👤 Autor
|
||||
|
||||
## Releases und Versionierung
|
||||
Domenik Bildhauer
|
||||
|
||||
Die Plugins werden unabhängig voneinander versioniert.
|
||||
## ⚖️ Lizenz
|
||||
|
||||
Git-Tags verwenden deshalb folgendes Schema:
|
||||
|
||||
```text
|
||||
PLUGIN_NAME-vVERSION
|
||||
```
|
||||
|
||||
Beispiele:
|
||||
|
||||
```text
|
||||
remote_access-v1.4.4
|
||||
os_info-v1.0.0
|
||||
```
|
||||
|
||||
Dadurch können mehrere Plugins mit unterschiedlichen Versionsständen innerhalb desselben Git-Repositories verwaltet werden.
|
||||
|
||||
Fertige MKP-Pakete werden zusätzlich als Download beim jeweiligen Gitea Release bereitgestellt.
|
||||
|
||||
## Entwicklung
|
||||
|
||||
Der eigentliche Checkmk-Source-Code eines Plugins befindet sich unter:
|
||||
|
||||
```text
|
||||
PLUGIN_NAME/src/
|
||||
```
|
||||
|
||||
Die Verzeichnisstruktur unterhalb von `src/` entspricht dabei möglichst der späteren Struktur innerhalb der Checkmk-Site.
|
||||
|
||||
Beispiel:
|
||||
|
||||
```text
|
||||
src/local/share/check_mk/web/plugins/
|
||||
```
|
||||
|
||||
Dadurch lässt sich direkt erkennen, an welcher Stelle die jeweilige Datei auf dem Checkmk-Server installiert wird.
|
||||
|
||||
## Hinweise
|
||||
|
||||
Die Plugins wurden primär für meine eigene Checkmk-Umgebung entwickelt.
|
||||
|
||||
Vor dem Einsatz in produktiven Umgebungen sollte die jeweilige Erweiterung in einer Testumgebung geprüft werden.
|
||||
|
||||
## Autor
|
||||
|
||||
**Domenik Bildhauer**
|
||||
|
||||
## Lizenz
|
||||
|
||||
Sofern im jeweiligen Plugin keine abweichende Lizenz angegeben ist, handelt es sich um eigene Erweiterungen für Checkmk.
|
||||
|
||||
Checkmk ist eine Marke der Checkmk GmbH.
|
||||
Die Lizenz ist im jeweiligen Plugin dokumentiert. Checkmk ist eine Marke der Checkmk GmbH.
|
||||
Reference in new issue
Block a user