We’ve completely revamped the Helm deployment documentation to reflect the latest changes in Midaz Helm Chart v5.x. This update introduces a new unified architecture, integrated services, and comprehensive migration guides.
Major Changes in Helm v5.x
New Ledger Service (Primary Change)
The most significant change in v5.x is the introduction of the unified Ledger service, which combines the functionality of the separateonboarding and transaction modules into a single deployment.- Single service: One deployment instead of two separate services
- Simplified configuration: Unified environment variables with module-specific prefixes
- Automatic ingress routing: Existing DNS configurations continue to work seamlessly
- New Balance Sync Worker: Background processing for balance synchronization
CRM Integrated into Main Chart
The CRM plugin is now integrated directly into the main Midaz Helm chart:- Previously deployed as a separate chart (
plugin-crm) in themidaz-pluginsnamespace - Now available as an optional component in the
midaznamespace - Simplified deployment and configuration
- Shared MongoDB connection with other Midaz services
Console Removed
The Console component has been removed from the Helm chart as part of the migration to Lerian Console. For web-based management, please refer to the Lerian Console documentation.Dependency Changes
- RabbitMQ: Migrated from Bitnami to Groundhog2k chart (since v4.x)
- Erlang Cookie: Now requires explicit configuration for RabbitMQ
- BitnamiSecure Images: PostgreSQL, MongoDB, and Valkey now use hardened images
New Environment Variables
The Ledger service introduces module-specific prefixes for database configuration:| Old Variable (Legacy) | New Variable (Ledger) |
|---|---|
DB_PASSWORD | DB_ONBOARDING_PASSWORD, DB_TRANSACTION_PASSWORD |
MONGO_PASSWORD | MONGO_ONBOARDING_PASSWORD, MONGO_TRANSACTION_PASSWORD |
Documentation Updates
We’ve restructured and expanded the Helm documentation section:New Pages
- Helm Overview: Central hub for all Helm-related documentation
- Upgrading Helm: Comprehensive migration guide covering v3.x → v4.x → v5.x transitions with breaking changes and rollback procedures
Updated Pages
-
Using Helm: Completely rewritten to include:
- Ledger service configuration (recommended)
- Legacy Onboarding/Transaction configuration
- CRM integration setup
- Bootstrap jobs for external PostgreSQL and RabbitMQ
- Detailed parameter tables for all services
-
Upgrading Midaz and plugins via Helm: Updated with:
- Support for Ledger architecture (v5.x)
- Tabs for Ledger vs Legacy commands
- Updated version numbers
-
Version Compatibility: Updated with:
- New Ledger architecture compatibility table
- CRM integration versions
- Updated plugin versions
- Deployment Strategies Overview: Updated to reflect new Helm structure
Version Compatibility
| Helm Chart Version | Ledger | CRM | Recommended |
|---|---|---|---|
| 5.3.0 | 3.5.1 | 3.5.0 | Yes |
| 5.2.0 | 3.5.0 | 3.5.0 | Yes |
| 5.0.0 | 3.5.0 | 3.5.0 | Yes |
Migration Paths
We provide detailed migration guides for all upgrade scenarios:- v4.x → v5.x: Enable Ledger service, migrate secrets to module-specific prefixes
- v3.x → v4.x: Configure Erlang cookie for RabbitMQ, backup PVC data
- v3.x → v5.x: Combined migration addressing both sets of breaking changes