Feature: add external database support #177
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add support for external MySQL/MariaDB databases with the following changes: - Add database.mode setting to switch between internal and external modes - Add database.external section with host, port, name, user, password, timeout - Support existingSecret for secure credential management - Add JSON schema validation for database configuration This allows users to use existing database instances instead of the bundled MySQL.
Add 7 new helper functions to abstract database configuration: - librenms.dbHost: Returns database hostname (strips port if included) - librenms.dbPort: Returns database port (extracts from host string if needed) - librenms.dbName: Returns database name - librenms.dbUser: Returns database username - librenms.dbTimeout: Returns connection timeout with default - librenms.dbPasswordEnv: Renders password from literal or secret - librenms.validateExternalDB: Validates required external DB parameters Helpers support both internal (bundled MySQL) and external database modes.
Replace hardcoded MySQL values with helper function calls: - DB_HOST: Now rendered without port for proper mariadb client usage - DB_PORT: Added as separate environment variable - DB_USERNAME: Uses dbUser helper - DB_DATABASE: Uses dbName helper This ensures database configuration is correctly injected regardless of internal or external database mode.
Update deployment, cron, and poller StatefulSet templates: - Use dbPasswordEnv helper for secure password injection - Fix poller readiness probe to use separate host/port parameters - Ensure all workloads properly reference configmap for DB settings These changes enable external database connectivity across all LibreNMS components while maintaining backward compatibility with internal mode.
Add extensive documentation to README template covering: - Internal vs external database mode selection - External database configuration examples - Flexible connection string formats (host:port or separate port) - Kubernetes secret integration for credentials - Database pre-requisites and requirements - Example kubectl commands for secret creation Documentation is clear and production-ready.
Regenerate README.md from updated template using helm-docs. Includes comprehensive external database configuration guide with examples, prerequisites, and best practices.
PcInfamy
force-pushed
the
external-db-support
branch
from
2ec2f32 to
f0c6d69
Compare
jacobw
reviewed
Jan 3, 2026
Collaborator
jacobw
left a comment
jacobw
left a comment
There was a problem hiding this comment.
Great PR! Couple of small comments.
Comment on lines
+38
to
+39
| # -- Database configuration for LibreNMS | ||
| database: |
Collaborator
There was a problem hiding this comment.
Did you consider merging the existing mysql section so all database configuration was under on e section, possibly as external and internal?
Comment on lines
+85
to
+88
| {{- if contains ":" $host -}} | ||
| {{- $host | splitList ":" | first -}} | ||
| {{- else -}} | ||
| {{- $host -}} |
Collaborator
There was a problem hiding this comment.
The values description didn't say you could define host:port. Was it your intention to support both formats? This sounds maybe unnecessary given you'd only really set this once.
Collaborator
There was a problem hiding this comment.
Oh I see you adding this in the README, but not in the values.yaml comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Testing/Validation
I wrote some test scripts to validate both an internal DB and an external DB with this chart.
Testing script output: