Why Helm?
Helm is the recommended way to deploy Midaz on Kubernetes. It provides:
- Simplified deployment: Install Midaz with a single command.
- Consistent configuration: Manage all settings through a centralized
values.yamlfile. - Easy upgrades: Update Midaz versions with minimal downtime.
- Dependency management: Automatically handles PostgreSQL, MongoDB, RabbitMQ, Valkey, and other required services.
Content
In this section, you will find:
- Installing Midaz with Helm: Install and configure Midaz on Kubernetes.
- Configuring ingress: Expose Midaz services outside the cluster with NGINX, AWS ALB, or Traefik.
- Configuring observability: Set up Grafana and OpenTelemetry for monitoring.
- Configuring dependencies: Configure PostgreSQL, MongoDB, RabbitMQ, and Valkey.
- Midaz components reference: Detailed parameters for Ledger, Onboarding, Transaction, and CRM services.
- Upgrade guide: Quick start for upgrading Midaz Core and plugins.
- Migration guides: Step-by-step migration paths between Helm chart versions.
- Configuration reference: Ledger service configuration, external secrets, and deployment flags.
- Upgrade checklist: Best practices and post-upgrade verification steps.
- Rollback and troubleshooting: Rollback procedures and common issue resolution.
- Version compatibility: Check the compatibility matrix between Helm chart versions and Midaz components.
Prerequisites
Before deploying Midaz with Helm, make sure you have:
- Kubernetes (v1.30+): A running cluster.
- Helm 3+: Installed and available (
helm version). - Access to a container registry with Midaz images.
- DNS and TLS certificates for ingress (or cert-manager installed).
Quick start
To install Midaz using Helm, run:
<version> with the desired Helm chart version. Check available versions with: