mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-04-29 20:10:21 +00:00
35adcf104f
Update config.example.yaml with: - Recommendations for very large deployments (30+ nodes) - Formula for calculating optimal rate limits based on node count - Example calculation: 30 nodes with 10s polling = 300ms interval - Security note about minimum safe intervals This helps admins properly configure the proxy for enterprise deployments with dozens of nodes.
47 lines
1.9 KiB
YAML
47 lines
1.9 KiB
YAML
# Pulse Sensor Proxy Configuration
|
|
# This file is optional. If not provided, the proxy will use sensible defaults.
|
|
|
|
# Network Configuration
|
|
# Specify which networks are allowed to connect to the proxy
|
|
# If not specified, the proxy will auto-detect host IP addresses
|
|
allowed_source_subnets:
|
|
- "127.0.0.1/32" # Localhost
|
|
- "192.168.0.0/24" # Local network
|
|
|
|
# Peer Authorization
|
|
# Specify which UIDs/GIDs are allowed to connect
|
|
# Required when running Pulse in a container (use mapped UID/GID from container)
|
|
allowed_peer_uids: [100999] # Container pulse user UID
|
|
allowed_peer_gids: [100996] # Container pulse group GID
|
|
|
|
# ID-Mapped Root Authentication
|
|
# Allow connections from ID-mapped root users (for LXC containers)
|
|
allow_idmapped_root: true
|
|
allowed_idmap_users:
|
|
- root
|
|
|
|
# Metrics Server
|
|
# Address for Prometheus metrics endpoint
|
|
metrics_address: "127.0.0.1:9127"
|
|
|
|
# Rate Limiting (Optional)
|
|
# Control how frequently peers can make requests to prevent abuse
|
|
# Adjust these values based on your deployment size:
|
|
# - Small (1-3 nodes): Use defaults (1000ms, burst 5)
|
|
# - Medium (4-10 nodes): 500ms, burst 10
|
|
# - Large (10-20 nodes): 250ms, burst 20
|
|
# - Very Large (30+ nodes): 100ms, burst 30-50
|
|
#
|
|
# Formula: To poll all nodes in one cycle, set burst >= node_count
|
|
# For optimal performance: per_peer_interval_ms = (polling_interval_ms / node_count)
|
|
# Example: 10 second polling with 30 nodes = 10000ms / 30 ≈ 300ms interval
|
|
rate_limit:
|
|
per_peer_interval_ms: 1000 # Minimum milliseconds between requests per peer (1000ms = 1 qps = 60 requests/min)
|
|
per_peer_burst: 5 # Number of requests allowed in a burst (supports up to 5 simultaneous requests)
|
|
|
|
# Default values if not specified:
|
|
# per_peer_interval_ms: 1000 (1 second = 1 qps = 60 requests/min)
|
|
# per_peer_burst: 5
|
|
#
|
|
# Security note: Lower intervals increase throughput but also increase exposure
|
|
# to potential abuse. For production, keep interval >= 100ms unless necessary.
|