This section covers everything you need to deploy and manage Midaz on Kubernetes using Helm. From initial installation to version upgrades, you’ll find guides tailored for both new deployments and existing environments.
New to Midaz? Start with Using Helm for a complete walkthrough of the installation process. 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.yaml file.
- 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:
- Using Helm: Install and configure Midaz on Kubernetes, including ingress setup, observability, and dependency management.
- Upgrading Helm: Migrate between Helm chart versions with breaking changes, migration paths, and rollback procedures.
- Upgrading Midaz and plugins via Helm: Step-by-step instructions for upgrading Midaz Core and plugins via Helm, including best practices, checklists, and rollback procedures.
- 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:
helm install midaz oci://registry-1.docker.io/lerianstudio/midaz-helm --version <version> -n midaz --create-namespace
<version> with the desired Helm chart version. Check available versions with:
helm search repo oci://registry-1.docker.io/lerianstudio/midaz-helm --versions
We recommend using the latest stable version for production deployments to ensure you have the latest features and security patches.
Resources
