Update README design and documentation

This commit is contained in:
dbildhauer committed 2026-08-16 20:28:28 +02:00
1 parent f3e3ff0282
commit 3148acc2df
3 files changed
+220 -55

No files matched your search

+67 -28
View File
@@ -5,56 +5,104 @@
![API](https://img.shields.io/badge/Check%20API-V2-informational)
![License](https://img.shields.io/badge/License-GPL--2.0-lightgrey)
MKP-Erweiterung für **Checkmk Community 2.5.x**, die pro überwachten Host einen Service **„Betriebssystem“** bereitstellt.
MKP-Erweiterung für **Checkmk Community 2.5.x**, die auf überwachten Hosts einen eigenen Service **„Betriebssystem“** bereitstellt.
⬅️ [Zurück zur Plugin-Übersicht](../README.md)
## ✨ Funktionen
Der Service zeigt:
- Betriebssystem bzw. Linux-Distribution
- Betriebssystem-Version / Windows-Build
- Architektur und Kernel-Version
- Architektur
- Kernel-Version
- OS-ID und Version-ID
- 🐧 Linux · 🪟 Windows · 🍎 macOS
### Unterstützte Plattformen
<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/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>
## 📂 Repository-Struktur
```text
os-info/
├── src/
│ ├── agents/
│ │ ├── plugins/
│ │ │ └── os_info
│ │ └── windows/
│ │ └── plugins/
│ │ └── os_info.ps1
│ └── cmk_addons_plugins/
│ └── os_info/
│ ├── agent_based/
│ │ └── os_info.py
│ └── checkman/
│ └── os_info
├── dist/
│ └── os_info-1.0.0.mkp
├── CHANGELOG.md
├── PROJECT.md
├── LICENSE
└── README.md
```
## 📥 Installation des MKP
Paket: `dist/os_info-1.0.0.mkp`
Das fertige Paket befindet sich unter `dist/os_info-1.0.0.mkp`.
```bash
mkp add /tmp/os_info-1.0.0.mkp
mkp enable os_info 1.0.0
cmk -R
```
Kontrolle:
```bash
mkp list
```
## 🐧 Agent-Plug-in für Linux / macOS
Der Eintrag `os_info` sollte als `Enabled (active on this site)` erscheinen.
Nach Aktivierung:
## <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/linux.svg" width="24" height="24" alt="Linux"> Agent-Plug-in für Linux / macOS
Nach Aktivierung des MKP liegt das Plug-in unter:
```text
~/local/share/check_mk/agents/plugins/os_info
```
Auf den Zielhost kopieren und testen:
Auf den Zielhost kopieren:
```bash
scp ~/local/share/check_mk/agents/plugins/os_info \
root@HOST:/usr/lib/check_mk_agent/plugins/os_info
```
Danach auf dem Zielhost:
```bash
scp ~/local/share/check_mk/agents/plugins/os_info root@HOST:/usr/lib/check_mk_agent/plugins/os_info
chmod 755 /usr/lib/check_mk_agent/plugins/os_info
/usr/lib/check_mk_agent/plugins/os_info
```
Die Ausgabe muss mit `<<<os_info:sep(9)>>>` beginnen.
## 🪟 Agent-Plug-in für Windows
## <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/windows.svg" width="24" height="24" alt="Windows"> Agent-Plug-in für Windows
Quelldatei:
Quelldatei auf dem Checkmk-Server:
```text
~/local/share/check_mk/agents/windows/plugins/os_info.ps1
```
Ziel:
Ziel auf dem Windows-Host:
```text
C:\ProgramData\checkmk\agent\plugins\os_info.ps1
@@ -68,7 +116,7 @@ cmk -vI HOSTNAME
cmk -R
```
Anschließend erscheint der Service **Betriebssystem**.
Anschließend erscheint beim Host der Service **Betriebssystem**.
## 🧰 Fehlersuche
@@ -78,24 +126,15 @@ mkp list
cmk -d HOSTNAME | grep -A2 '^<<<os_info'
```
## 📂 Repository-Struktur
```text
os-info/
├── src/
│ ├── agents/
│ └── cmk_addons_plugins/os_info/
├── dist/
│ └── os_info-1.0.0.mkp
├── CHANGELOG.md
├── PROJECT.md
├── LICENSE
└── README.md
```
## 🛠️ Kompatibilität
Checkmk Community 2.5.x · Check API V2 · Linux-Agent · Windows-Agent · macOS grundsätzlich unterstützt
- Checkmk Community 2.5.x
- Check API V2
- Linux-Agent
- Windows-Agent
- macOS grundsätzlich unterstützt
**Aktuelle Paketversion:** `1.0.0`
## ⚖️ Lizenz