Add Web Config File Support and Enhanced Helm Chart Features

[zofer1zohargo]

Summary

This PR introduces comprehensive support for web configuration files (TLS and Basic Authentication) in the SQL Exporter Helm chart, along with dynamic configuration generation and extensive deployment examples. These enhancements make it easier to deploy SQL Exporter in production environments with proper security configurations.

Key Features

🔐 Web Config File Support

• Added support for mounting and using web configuration files for TLS and Basic Authentication
• Automatic HTTPS/HTTP scheme detection based on TLS configuration
• Support for custom TLS certificates via Kubernetes secrets
• Built-in bcrypt password hashing via init container for Basic Auth

⚙️ Dynamic Configuration Generation

• New dynamicConfig option to generate sql_exporter.yml at runtime from secrets
• Separates sensitive connection strings (DSN) from collector definitions
• Supports application_name injection into database connection strings
• Template-based configuration with variable substitution

📦 Init Container Integration

• New init container script (helm/scripts/init.sh) for:
  • Dynamic config generation from secret-held DSNs
  • Bcrypt password hashing for Basic Auth
  • ECS-compliant structured logging
  • Flexible configuration mounting

🚀 Smart Service Configuration

• Service port automatically defaults to 80 (HTTP) or 443 (HTTPS) based on TLS settings
• Auto-generated health probes that adapt to TLS configuration
• Customizable probe parameters without overriding the entire probe definition

📚 Comprehensive Examples

Added 7 detailed deployment examples with documentation:

• auth-only: Basic Authentication without TLS
• tls-only: TLS configuration without authentication
• tls-auth-dynamic: Combined TLS + Auth + Dynamic Config (full production setup)
• dynamic-config-only: Dynamic configuration from secrets
• azure-sql-mi: Azure SQL Managed Instance deployment
• mssql: Microsoft SQL Server deployment
• postgres: PostgreSQL deployment

Each example includes complete README with step-by-step instructions, sample Kubernetes secret YAML files, example Helm values configurations, and testing commands.

Changes Overview

Modified Components

• Enhanced deployment template with init container and flexible mounting
• Added TLS detection and web config helpers
• Smart port selection based on TLS configuration
• Added 116+ lines of new configuration options in values.yaml

New Components

• Init container script for dynamic config generation
• ConfigMap for init script
• 7 comprehensive deployment examples with full documentation

Use Cases

This PR enables several important deployment patterns:

1. Secure Production Deployment: TLS + Basic Auth + Dynamic Config from secrets
2. Multi-Database Support: Dynamic config allows different DSNs per environment
3. Certificate Management: Easy integration with cert-manager or custom PKI
4. Cloud-Native Secrets: Leverage Kubernetes secrets for sensitive data
5. Zero-Config Collectors: Reusable collector definitions across deployments

Backward Compatibility

✅ All changes are backward compatible:

• Existing deployments continue to work without modification
• New features are opt-in via dynamicConfig.enabled and webConfig.enabled
• Default behavior unchanged when new options are not specified

Testing

All examples have been tested and include:

• Secret creation commands
• Helm installation with values
• Verification steps (curl commands, log checks)
• Expected output samples

[burningalchemist]

Hey @zofer1zohargo, thank you for your contribution! 👏 Let me go through the change set and I will get back to you. 😃

UPD: Could you please bump up the chart in Chart.yaml to 0.15.0 and run make gen_docs (as per the docs here)?

[zofer1zohargo]

Pushed the changes. Let me know if I need to issue another PR or do anything

[burningalchemist]

Hey @zofer1zohargo, thanks! I still need to review the PR, tbh I'd split it in two. But let me finish the review, and then we discuss. 🙌

[zofer1zohargo]

Hi @burningalchemist, did you have a chance to review the changes? Anything that you need me to explain?

[burningalchemist]

Hey @zofer1zohargo, apologies, I was busy developing other features.

I'd say webConfig feature is definitely appreciated. 👍 I'd like to avoid init containers but I see it's all feature toggled. My main concern is potentially a large amount of GitHub issues I won't have time to support. 😞 But we'll see.

---

I'm not convinced on dynamicConfig feature so far (I wish it was a separate PR so the change set is smaller). The exporter supports driver-native environment variables (e.g. for PostgreSQL), and also a good portion of config settings are exposed as SQLEXPORTER_, e.g. SQLEXPORTER_TARGET_DSN that can be stored as Kubernetes Secret and mounted. In addition, custom environment variables can be injected in parts of DSN to be expanded just fine.