mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-02-18 00:17:39 +01:00
docs: standardize markdown syntax and remove deprecated sensor-proxy docs
This commit is contained in:
rcourtman
@@ -11,19 +11,19 @@ Safely enable dynamic scheduling (v5+).
|
||||
|
||||
## 🟢 Enable
|
||||
Choose one method:
|
||||
* **UI**: Not currently exposed in the v5 UI (use CLI or env vars).
|
||||
* **CLI**:
|
||||
- systemd/LXC: `jq '.adaptivePollingEnabled=true' /etc/pulse/system.json > /tmp/system.json && sudo mv /tmp/system.json /etc/pulse/system.json`
|
||||
- Docker/Kubernetes: edit `/data/system.json` in the volume and restart the container/pod
|
||||
* **Env**: `ADAPTIVE_POLLING_ENABLED=true` (Docker/K8s).
|
||||
- **UI**: Not currently exposed in the v5 UI (use CLI or env vars).
|
||||
- **CLI**:
|
||||
- systemd/LXC: `jq '.adaptivePollingEnabled=true' /etc/pulse/system.json > /tmp/system.json && sudo mv /tmp/system.json /etc/pulse/system.json`
|
||||
- Docker/Kubernetes: edit `/data/system.json` in the volume and restart the container/pod
|
||||
- **Env**: `ADAPTIVE_POLLING_ENABLED=true` (Docker/K8s).
|
||||
|
||||
## 🔍 Monitor (First 15m)
|
||||
Watch for stability:
|
||||
```bash
|
||||
watch -n 5 'curl -s http://localhost:9091/metrics | grep pulse_monitor_poll_queue_depth'
|
||||
```
|
||||
* **Success**: Queue depth < 50, no permanent errors.
|
||||
* **Failure**: High queue depth, open breakers.
|
||||
- **Success**: Queue depth < 50, no permanent errors.
|
||||
- **Failure**: High queue depth, open breakers.
|
||||
|
||||
## ↩️ Rollback
|
||||
If instability occurs > 10m:
|
||||
|
||||
@@ -1,54 +0,0 @@
|
||||
# 🔄 Sensor Proxy Audit Log Rotation
|
||||
|
||||
> **Deprecated in v5:** `pulse-sensor-proxy` is deprecated and not recommended for new deployments.
|
||||
> This document is retained for existing installations during the migration window.
|
||||
|
||||
The proxy writes append-only, hash-chained logs to `/var/log/pulse/sensor-proxy/audit.log`.
|
||||
|
||||
## ⚠️ Important
|
||||
* **Do not delete**: The file is protected with `chattr +a`.
|
||||
* **Rotate when**: >200MB or >30 days.
|
||||
|
||||
## 🛠️ Manual Rotation
|
||||
|
||||
Run as root:
|
||||
|
||||
```bash
|
||||
# 1. Unlock file
|
||||
chattr -a /var/log/pulse/sensor-proxy/audit.log
|
||||
|
||||
# 2. Rotate (copy & truncate)
|
||||
cp -a /var/log/pulse/sensor-proxy/audit.log /var/log/pulse/sensor-proxy/audit.log.$(date +%Y%m%d)
|
||||
: > /var/log/pulse/sensor-proxy/audit.log
|
||||
|
||||
# 3. Relock & Restart
|
||||
chown pulse-sensor-proxy:pulse-sensor-proxy /var/log/pulse/sensor-proxy/audit.log
|
||||
chmod 0640 /var/log/pulse/sensor-proxy/audit.log
|
||||
chattr +a /var/log/pulse/sensor-proxy/audit.log
|
||||
systemctl restart pulse-sensor-proxy
|
||||
```
|
||||
|
||||
## 🤖 Logrotate Config
|
||||
|
||||
Create `/etc/logrotate.d/pulse-sensor-proxy`:
|
||||
|
||||
```conf
|
||||
/var/log/pulse/sensor-proxy/audit.log {
|
||||
weekly
|
||||
rotate 8
|
||||
compress
|
||||
missingok
|
||||
notifempty
|
||||
create 0640 pulse-sensor-proxy pulse-sensor-proxy
|
||||
sharedscripts
|
||||
prerotate
|
||||
/usr/bin/chattr -a /var/log/pulse/sensor-proxy/audit.log || true
|
||||
endscript
|
||||
postrotate
|
||||
/bin/systemctl restart pulse-sensor-proxy.service || true
|
||||
/usr/bin/chattr +a /var/log/pulse/sensor-proxy/audit.log || true
|
||||
endscript
|
||||
}
|
||||
```
|
||||
|
||||
**Note**: Do NOT use `copytruncate`. The restart is required to reset the hash chain.
|
||||
@@ -4,6 +4,7 @@ Manage Pulse auto-updates on host-mode installations.
|
||||
> **Note**: Docker/Kubernetes users should manage updates via their orchestrator.
|
||||
|
||||
## ⚙️ Components
|
||||
|
||||
| File | Purpose |
|
||||
| :--- | :--- |
|
||||
| `pulse-update.timer` | Daily check (02:00 + jitter). |
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
# ⚙️ Sensor Proxy Configuration
|
||||
|
||||
> **Deprecated in v5:** `pulse-sensor-proxy` is deprecated and not recommended for new deployments.
|
||||
> Use `pulse-agent --enable-proxmox` for temperature monitoring.
|
||||
> This document is retained for existing installations during the migration window.
|
||||
|
||||
Safe configuration management using the built-in CLI.
|
||||
|
||||
## 📂 Files
|
||||
* **`config.yaml`**: General settings (logging, metrics).
|
||||
* **`allowed_nodes.yaml`**: Authorized node list (managed via CLI).
|
||||
|
||||
## 🛠️ CLI Reference
|
||||
|
||||
### Validation
|
||||
Check for errors before restart.
|
||||
```bash
|
||||
pulse-sensor-proxy config validate
|
||||
```
|
||||
|
||||
### Managing Nodes
|
||||
**Add Nodes (Merge):**
|
||||
```bash
|
||||
pulse-sensor-proxy config set-allowed-nodes --merge 192.168.0.10
|
||||
```
|
||||
|
||||
**Replace List:**
|
||||
```bash
|
||||
pulse-sensor-proxy config set-allowed-nodes --replace \
|
||||
--merge 192.168.0.1 --merge 192.168.0.2
|
||||
```
|
||||
|
||||
## ⚠️ Troubleshooting
|
||||
|
||||
**Validation Fails:**
|
||||
* Check for duplicate `allowed_nodes` blocks in `config.yaml`.
|
||||
* Run `pulse-sensor-proxy config validate 2>&1` for details.
|
||||
|
||||
**Lock Errors:**
|
||||
* Remove stale locks if process is dead: `rm /etc/pulse-sensor-proxy/*.lock`.
|
||||
|
||||
**Empty List:**
|
||||
* Valid for IPC-only clusters.
|
||||
* Populate manually if needed using `--replace`.
|
||||
@@ -1,35 +0,0 @@
|
||||
# 📝 Sensor Proxy Log Forwarding
|
||||
|
||||
> **Deprecated in v5:** `pulse-sensor-proxy` is deprecated and not recommended for new deployments.
|
||||
> Use `pulse-agent --enable-proxmox` for temperature monitoring.
|
||||
> This document is retained for existing installations during the migration window.
|
||||
|
||||
Forward `audit.log` and `proxy.log` to a central SIEM via RELP + TLS.
|
||||
|
||||
## 🚀 Quick Start
|
||||
Run the helper script with your collector details:
|
||||
|
||||
```bash
|
||||
sudo REMOTE_HOST=logs.example.com \
|
||||
REMOTE_PORT=6514 \
|
||||
CERT_DIR=/etc/pulse/log-forwarding \
|
||||
CA_CERT=/path/to/ca.crt \
|
||||
CLIENT_CERT=/path/to/client.crt \
|
||||
CLIENT_KEY=/path/to/client.key \
|
||||
bash -c "$(curl -fsSL https://raw.githubusercontent.com/rcourtman/Pulse/main/scripts/setup-log-forwarding.sh)"
|
||||
```
|
||||
|
||||
## 📋 What It Does
|
||||
1. **Inputs**: Watches `/var/log/pulse/sensor-proxy/{audit,proxy}.log`.
|
||||
2. **Queue**: Disk-backed queue (50k messages) for reliability.
|
||||
3. **Output**: RELP over TLS to `REMOTE_HOST`.
|
||||
4. **Mirror**: Local debug file at `/var/log/pulse/sensor-proxy/forwarding.log`.
|
||||
|
||||
## ✅ Verification
|
||||
1. **Check Status**: `sudo systemctl status rsyslog`
|
||||
2. **View Mirror**: `tail -f /var/log/pulse/sensor-proxy/forwarding.log`
|
||||
3. **Test**: Restart proxy and check remote collector for `pulse.audit` tag.
|
||||
|
||||
## 🧹 Maintenance
|
||||
* **Disable**: Remove `/etc/rsyslog.d/pulse-sensor-proxy.conf` and restart rsyslog.
|
||||
* **Rotate Certs**: Replace files in `CERT_DIR` and restart rsyslog.
|
||||
Reference in New Issue
Block a user