> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualização da documentação Helm v5.x

> A documentação de deploy do Helm agora reflete o Midaz Helm Chart v5.x, com o serviço Ledger unificado, CRM integrado, mudanças de dependências e guias de migração.

<Badge stroke icon="calendar-days" iconType="regular">21 de janeiro de 2026</Badge> <Badge stroke icon="file-code" iconType="regular">Atualização de documentação</Badge> <Badge color="red" size="lg" stroke icon="triangle-exclamation" iconType="regular">Ação necessária</Badge>

## Afeta

***

Times que fazem deploy ou upgrade do Midaz com Helm, especialmente times que estão migrando para o Helm Chart v5.x.

Esta atualização se aplica ao portal de documentação pública. Não altera o comportamento da API em runtime, a menos que a documentação do produto vinculada indique o contrário.

## O que mudou

***

Revisamos completamente a documentação de deploy do Helm para refletir as últimas mudanças no **Midaz Helm Chart v5.x**. Esta atualização introduz uma nova arquitetura unificada, serviços integrados e guias de migração abrangentes.

### Principais mudanças no Helm v5.x

***

### Novo serviço Ledger (mudança principal)

A mudança mais significativa na v5.x é a introdução do **serviço Ledger unificado**, que combina a funcionalidade dos módulos separados `onboarding` e `transaction` em um único deploy.

* **Serviço único**: Um deploy em vez de dois serviços separados
* **Configuração unificada**: Variáveis de ambiente unificadas com prefixos específicos por módulo
* **Roteamento automático de ingress**: Configurações de DNS existentes continuam funcionando sem alterações
* **Novo Balance Sync Worker**: Processamento em background para sincronização de saldos

<Warning>
  Os serviços separados Onboarding e Transaction agora são **legacy** e serão descontinuados em uma versão futura. Recomendamos fortemente planejar sua migração para o serviço Ledger unificado.
</Warning>

### CRM integrado ao chart principal

O **plugin CRM** agora está integrado diretamente ao chart Helm principal do Midaz:

* Antes era deployado como um chart separado (`plugin-crm`) no namespace `midaz-plugins`
* Agora está disponível como componente opcional no namespace `midaz`
* Deploy e configuração simplificados
* Conexão compartilhada com MongoDB junto com outros serviços do Midaz

### Console removido

O componente **Console** foi removido do chart Helm como parte da migração para o **Lerian Console**. Para gerenciamento via web, consulte a [documentação do Lerian Console](/pt/midaz/about-midaz-console).

### Mudanças de dependências

* **RabbitMQ**: Migrado do Bitnami para o chart Groundhog2k (desde a v4.x)
* **Erlang Cookie**: Agora requer configuração explícita para o RabbitMQ
* **Imagens BitnamiSecure**: PostgreSQL, MongoDB e Valkey agora usam imagens hardened

### Novas variáveis de ambiente

O serviço Ledger introduz prefixos específicos por módulo para configuração de banco de dados:

| Variável antiga (Legacy) | Nova variável (Ledger)                                    |
| :----------------------- | :-------------------------------------------------------- |
| `DB_PASSWORD`            | `DB_ONBOARDING_PASSWORD`, `DB_TRANSACTION_PASSWORD`       |
| `MONGO_PASSWORD`         | `MONGO_ONBOARDING_PASSWORD`, `MONGO_TRANSACTION_PASSWORD` |

### Atualizações de documentação

\--

Reestruturamos e expandimos a seção de documentação do Helm:

### Novas páginas

* [**Visão geral do Helm**](/pt/platform/helm/helm-overview): Hub central para toda a documentação relacionada ao Helm
* [**Upgrade do Helm**](/pt/platform/helm/midaz/midaz-upgrade-guide): Guia abrangente de migração cobrindo as transições v3.x → v4.x → v5.x com breaking changes e procedimentos de rollback

### Páginas atualizadas

* [**Usando o Helm**](/pt/platform/helm/midaz/midaz-installation): Totalmente reescrita para incluir:

* Configuração do serviço Ledger (recomendado)

* Configuração legacy de Onboarding/Transaction

* Configuração de integração com CRM

* Bootstrap jobs para PostgreSQL e RabbitMQ externos

* Tabelas detalhadas de parâmetros para todos os serviços

* [**Upgrade do Midaz e plugins via Helm**](/pt/platform/helm/midaz/midaz-upgrade-guide): Atualizado com:

* Suporte para a arquitetura Ledger (v5.x)

* Abas para comandos Ledger vs Legacy

* Números de versão atualizados

* [**Compatibilidade de versões**](/pt/platform/helm/helm-version-compatibility): Atualizado com:

* Nova tabela de compatibilidade da arquitetura Ledger

* Versões da integração do CRM

* Versões atualizadas dos plugins

* [**Visão geral das estratégias de deploy**](/pt/midaz/deployment): Atualizado para refletir a nova estrutura do Helm

### Compatibilidade de versões

***

| Versão do Helm Chart | Ledger | CRM   | Recomendado |
| :------------------- | :----- | :---- | :---------- |
| 5.3.0                | 3.5.1  | 3.5.0 | Sim         |
| 5.2.0                | 3.5.0  | 3.5.0 | Sim         |
| 5.0.0                | 3.5.0  | 3.5.0 | Sim         |

### Caminhos de migração

***

Fornecemos guias detalhados de migração para todos os cenários de upgrade:

* **v4.x → v5.x**: Habilitar o serviço Ledger, migrar secrets para prefixos específicos por módulo
* **v3.x → v4.x**: Configurar Erlang cookie para o RabbitMQ, fazer backup dos dados de PVC
* **v3.x → v5.x**: Migração combinada cobrindo ambos os conjuntos de breaking changes

### Recursos relacionados

***

* [Visão geral do Helm](/pt/platform/helm/helm-overview)
* [Usando o Helm](/pt/platform/helm/midaz/midaz-installation)
* [Upgrade do Helm](/pt/platform/helm/midaz/midaz-upgrade-guide)
* [Compatibilidade de versões](/pt/platform/helm/helm-version-compatibility)
* [Repositório Helm](https://github.com/LerianStudio/helm)

## Impacto

***

Esta atualização de documentação inclui informações que os times devem revisar antes de alterar a integração ou deploy afetados.

## O que você precisa fazer

***

<Steps>
  <Step>
    Revise as orientações de migração do Helm v5.x antes do próximo deploy ou upgrade do Midaz.
  </Step>

  <Step>
    Planeje a migração para o serviço Ledger unificado e para o modelo de deploy atualizado do CRM onde aplicável.
  </Step>
</Steps>

### Prazo

Antes da sua próxima mudança relacionada de integração, deploy ou upgrade.

### Por quê

O Helm v5.x altera a arquitetura de deploy documentada e o caminho de migração. Times que operam o Midaz com Helm precisam das orientações atualizadas antes de alterar ambientes.
