Files
cmk-plugins/README.md
T

148 lines
4.1 KiB
Markdown

# 🔍 Checkmk Plugins
![Checkmk](https://img.shields.io/badge/Checkmk-2.5.x-15d1a0)
![Edition](https://img.shields.io/badge/Edition-Community-blue)
![Plugins](https://img.shields.io/badge/Plugins-2-informational)
Sammlung eigener Plugins und Erweiterungen für **Checkmk Community 2.5.x**.
Die Erweiterungen werden für die eigene Monitoring-Umgebung entwickelt und getestet. Jedes Plugin besitzt einen eigenen Ordner mit Dokumentation, Source-Code und installierbarem MKP-Paket.
## 📦 Verfügbare Plugins
### 🔗 Remote Access
Direkter SSH- und RDP-Zugriff auf überwachte Hosts aus der Checkmk-Weboberfläche.
**Aktuelle Version:** `1.4.4`
<p>
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/linux.svg" width="22" height="22" alt="Linux"> SSH für Linux-/Unix-Systeme&nbsp;&nbsp;
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/microsoft-windows.svg" width="22" height="22" alt="Windows"> RDP für Windows-Systeme
</p>
- 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://`
➡️ [Dokumentation](remote_access/README.md)
📦 [MKP-Paket](remote_access/packages/remote_access-1.4.4.mkp)
### 🖥️ OS Info
Zeigt Betriebssysteminformationen eines überwachten Hosts als eigenen Checkmk-Service an.
**Aktuelle Version:** `1.0.0`
<p>
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/linux.svg" width="24" height="24" alt="Linux"> <strong>Linux</strong>&nbsp;&nbsp;
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/microsoft-windows.svg" width="24" height="24" alt="Windows"> <strong>Windows</strong>&nbsp;&nbsp;
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/apple.svg" width="24" height="24" alt="macOS"> <strong>macOS</strong>
</p>
- Betriebssystem bzw. Distribution
- Version / Windows-Build
- Architektur
- Kernel-Version
- OS-ID und Version-ID
➡️ [Dokumentation](os-info/README.md)
📦 [MKP-Paket](os-info/dist/os_info-1.0.0.mkp)
## 🛠️ Umgebung und Kompatibilität
Primär entwickelt und getestet mit:
- Checkmk Community Edition
- Checkmk 2.5.x
- Checkmk Agent 2.5
- Linux-Hosts
- Windows-Hosts
> Die Kompatibilität mit anderen Checkmk-Versionen oder Editionen ist nicht grundsätzlich ausgeschlossen, wird aber nicht zwingend getestet.
## 📂 Repository-Struktur
```text
cmk-plugins/
├── README.md
├── remote_access/
│ ├── README.md
│ ├── CHANGELOG.md
│ ├── packages/
│ └── src/
└── os-info/
├── README.md
├── CHANGELOG.md
├── PROJECT.md
├── LICENSE
├── dist/
└── src/
```
Jedes Plugin wird unabhängig versioniert und dokumentiert.
## 📥 Installation von MKP-Paketen
Das gewünschte `.mkp`-Paket auf den Checkmk-Server übertragen und als Site-Benutzer installieren:
```bash
mkp add /pfad/zum/plugin.mkp
mkp enable PLUGIN_NAME VERSION
```
Je nach Plugin anschließend beispielsweise:
```bash
cmk -R
```
oder bei Web-Erweiterungen:
```bash
omd restart apache
```
Installierte Pakete anzeigen:
```bash
mkp list
```
Die plugin-spezifischen Installationsschritte stehen in der jeweiligen README.
## 🏷️ Releases und Versionierung
Die Plugins werden unabhängig voneinander versioniert. Git-Tags verwenden das Schema:
```text
PLUGIN_NAME-vVERSION
```
Beispiele:
```text
remote_access-v1.4.4
os_info-v1.0.0
```
## 🧑‍💻 Entwicklung
Der Source-Code befindet sich im jeweiligen Plugin-Verzeichnis unter `src/`. Die Verzeichnisstruktur orientiert sich möglichst an der späteren Struktur innerhalb der Checkmk-Site.
## ⚠️ Hinweise
Die Plugins wurden primär für die eigene Checkmk-Umgebung entwickelt. Vor dem Einsatz in produktiven Umgebungen sollte die jeweilige Erweiterung zunächst in einer Testumgebung geprüft werden.
## 👤 Autor
Domenik Bildhauer
## ⚖️ Lizenz
Die Lizenz ist im jeweiligen Plugin dokumentiert. Checkmk ist eine Marke der Checkmk GmbH.