HeliosDB Configuration Quick Reference¶

Quick access to common configuration patterns

File Locations¶

# Default config file location
/etc/heliosdb/heliosdb.toml

# Example config
/home/claude/HeliosDB/config/heliosdb.example.toml

# Generate example
cp config/heliosdb.example.toml /etc/heliosdb/heliosdb.toml

Quick Configurations¶

GPU Acceleration¶

[gpu]
enabled = true
memory_limit = 8589934592  # 8GB
device_id = 0
fallback_to_cpu = true

Or via environment:

export HELIOSDB_GPU_ENABLED=true
export HELIOSDB_GPU_DEVICE_ID=0

Multi-Region (2 Regions)¶

[multi_region]
enabled = true
primary_region = "us-west"

[[multi_region.regions]]
id = "us-west"
endpoint = "https://us-west.db.com"
is_primary = true

[[multi_region.regions]]
id = "us-east"
endpoint = "https://us-east.db.com"
is_primary = false

Autoscaling¶

[autoscale]
enabled = true
min_cu = 10.0
max_cu = 1000.0
target_cpu_percent = 70.0

CDC to Kafka¶

[cdc]
enabled = true
output_format = "avro"

[cdc.kafka]
bootstrap_servers = ["localhost:9092"]
topic = "heliosdb-cdc"

Environment Variables Cheat Sheet¶

# GPU
HELIOSDB_GPU_ENABLED=true
HELIOSDB_GPU_DEVICE_ID=0
HELIOSDB_GPU_MEMORY_LIMIT=8589934592

# Multi-Region
HELIOSDB_MULTIREGION_ENABLED=true
HELIOSDB_MULTIREGION_PRIMARY_REGION=us-west

# Autoscale
HELIOSDB_AUTOSCALE_ENABLED=true
HELIOSDB_AUTOSCALE_MIN_CU=10
HELIOSDB_AUTOSCALE_MAX_CU=1000

# CDC
HELIOSDB_CDC_ENABLED=true
HELIOSDB_CDC_BUFFER_SIZE=10000

# Storage
HELIOSDB_STORAGE_DATA_DIR=/var/lib/heliosdb

# Network
HELIOSDB_NETWORK_LISTEN_ADDR=0.0.0.0:6543

Common Patterns¶

Development¶

[gpu]
enabled = false

[autoscale]
enabled = false

[multi_region]
enabled = false

[cdc]
enabled = false

Production (Single Region)¶

[gpu]
enabled = true
fallback_to_cpu = true

[autoscale]
enabled = true
min_cu = 50
max_cu = 2000

[security]
tde_enabled = true

Production (Multi-Region HA)¶

[gpu]
enabled = true

[multi_region]
enabled = true
replication_mode = "active_active"
auto_failover = true

[autoscale]
enabled = true
horizontal.enabled = true

[cdc]
enabled = true

Serverless¶

[autoscale]
enabled = true
min_cu = 0  # Scale to zero
max_cu = 500
scale_to_zero_idle_seconds = 300

Configuration Validation¶

# Test configuration
heliosdb config validate /etc/heliosdb/heliosdb.toml

# Show effective configuration (with env overrides)
heliosdb config show

# Generate example
heliosdb config generate > heliosdb.toml

Priority Order¶

Environment Variables (highest)
TOML File
Defaults (lowest)

Troubleshooting¶

# Check config is valid
heliosdb config validate

# View parsed config
heliosdb config show --format json

# Check GPU detection
heliosdb config check-gpu

# Test multi-region connectivity
heliosdb config test-regions

Full Documentation¶

See Configuration Guide for complete details.