Afeta
Equipes que fazem deploy ou atualizam o Midaz com Helm, principalmente as que estão migrando para o Helm Chart v5.x. Esta atualização se aplica ao portal público de documentação. Não muda o comportamento da API em runtime, a menos que a documentação do produto vinculada diga o contrário.
O que mudou
Reformulamos por completo a documentação de deploy com Helm para refletir as mudanças mais recentes no Midaz Helm Chart v5.x. Esta atualização traz uma nova arquitetura unificada, serviços integrados e guias de migração completos.
Principais mudanças no Helm v5.x
Novo serviço Ledger (mudança principal)
A mudança mais significativa no v5.x é a introdução do serviço Ledger unificado, que combina a funcionalidade dos módulos separadosonboarding e transaction em um único deploy.
- Serviço único: um deploy em vez de dois serviços separados
- Configuração simplificada: variáveis de ambiente unificadas com prefixos específicos por módulo
- Roteamento de ingress automático: as configurações de DNS existentes continuam funcionando normalmente
- Novo Balance Sync Worker: processamento em segundo plano para a sincronização de saldos
CRM integrado ao chart principal
O plugin de CRM agora está integrado direto no Helm chart principal do Midaz:- Antes, o deploy era feito como um chart separado (
plugin-crm) no namespacemidaz-plugins - Agora está disponível como um componente opcional no namespace
midaz - Deploy e configuração simplificados
- Conexão MongoDB compartilhada com os outros serviços do Midaz
Console removido
O componente Console foi removido do Helm chart como parte da migração para o Lerian Console. Para gestão pela web, consulte a documentação do Lerian Console.Mudanças de dependências
- RabbitMQ: migrado do chart Bitnami para o Groundhog2k (desde a v4.x)
- Erlang Cookie: agora exige 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 traz prefixos específicos por módulo para a configuração de banco de dados:Atualizações na documentação
— Reestruturamos e ampliamos a seção de documentação do Helm:Novas páginas
- Visão geral do Helm: hub central de toda a documentação relacionada ao Helm
- Atualizar o Helm: guia de migração completo que cobre as transições v3.x → v4.x → v5.x com breaking changes e procedimentos de rollback
Páginas atualizadas
- Usar o Helm: reescrita por completo para incluir:
- Configuração do serviço Ledger (recomendada)
- Configuração legada de Onboarding/Transaction
- Configuração da integração de CRM
- Jobs de bootstrap para PostgreSQL e RabbitMQ externos
- Tabelas detalhadas de parâmetros para todos os serviços
- Atualizar o Midaz e os plugins via Helm: atualizada com:
- Suporte à arquitetura Ledger (v5.x)
- Abas para os comandos Ledger vs Legacy
- Números de versão atualizados
- Compatibilidade de versões: atualizada com:
- Nova tabela de compatibilidade da arquitetura Ledger
- Versões da integração de CRM
- Versões de plugins atualizadas
- Visão geral das estratégias de deploy: atualizada para refletir a nova estrutura do Helm
Compatibilidade de versões
Caminhos de migração
Fornecemos guias de migração detalhados para todos os cenários de atualização:
- v4.x → v5.x: habilite o serviço Ledger e migre os secrets para prefixos específicos por módulo
- v3.x → v4.x: configure o Erlang cookie para o RabbitMQ e faça backup dos dados do PVC
- v3.x → v5.x: migração combinada que trata os dois conjuntos de breaking changes
Recursos relacionados
Impacto
Recomenda-se que as equipes revisem as informações desta atualização de documentação antes de mudar a integração ou o deploy afetado.
O que você precisa fazer
1
Revise a orientação de migração do Helm v5.x antes do seu próximo deploy ou atualização do Midaz.
2
Planeje a mudança para o serviço Ledger unificado e para o modelo atualizado de deploy do CRM onde se aplicar.