> ## 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.

# Deploy do Pix via Helm

> Faça o deploy do plugin Pix de participante direto no Kubernetes com o chart plugin-br-pix-direct-jd-helm, incluindo os secrets obrigatórios e a restrição de nome do release.

O plugin Pix processa pagamentos instantâneos Pix brasileiros como participante direto. O nome do chart é `plugin-br-pix-direct-jd-helm`.

<Note>
  O plugin Pix exige uma licença Enterprise. Entre em contato com a Lerian para obter acesso às imagens do plugin e às credenciais de deploy.
</Note>

## O que o chart instala

***

O chart instala três componentes:

* **Pix**: o serviço de pagamento, com um Deployment, um Service, um ConfigMap, um Secret, um HorizontalPodAutoscaler, um PodDisruptionBudget e um Ingress opcional.
* **QR Code**: um Deployment separado com o mesmo conjunto de recursos, para a geração de QR code.
* **Job**: um CronJob com o próprio ConfigMap, Secret e Service.

O chart empacota um subchart PostgreSQL e o habilita por padrão. Defina `postgresql.enabled: false` para usar um PostgreSQL gerenciado externamente.

## Pré-requisitos

***

* Um deploy do Midaz em execução.
* Conectividade com a infraestrutura de pagamentos brasileira pelo canal de participante direto.
* Licença Enterprise e credenciais de registry.
* Helm 3.8 ou posterior para o suporte a registry OCI.

## Instalação

***

Leia primeiro a versão atual do chart e depois instale:

```bash theme={null}
helm show chart oci://registry-1.docker.io/lerianstudio/plugin-br-pix-direct-jd-helm
```

```bash theme={null}
helm install plugin-br-pix-direct-jd \
  oci://registry-1.docker.io/lerianstudio/plugin-br-pix-direct-jd-helm \
  --version <version> -n midaz-plugins --create-namespace -f my-values.yaml
```

<Warning>
  Instale o release como `plugin-br-pix-direct-jd` no namespace `midaz-plugins`, ou defina você mesmo o host do banco de dados. Com o PostgreSQL empacotado, `DATABASE_HOST` assume por padrão um nome de service montado a partir desse nome de release e do namespace. Com qualquer outro nome, defina `pix.configmap.DATABASE_HOST` e o `DATABASE_HOST` do job para o service do PostgreSQL.
</Warning>

## Values que você deve definir

***

Coloque cada credencial em `pix.secrets`, ou aponte o release para o seu próprio Secret com `pix.useExistingSecret`. Defina estas chaves:

| Chave                                       | Finalidade                                    |
| :------------------------------------------ | :-------------------------------------------- |
| `LICENSE_KEY`                               | Validação da licença Enterprise.              |
| `MIDAZ_CLIENT_ID` e `MIDAZ_CLIENT_SECRET`   | Acesso máquina a máquina ao Midaz.            |
| `JD_CLIENT_ID` e `JD_SECRET`                | Acesso ao canal de participante direto.       |
| `JD_PIX_CLIENT_ID` e `JD_PIX_CLIENT_SECRET` | Acesso ao serviço Pix nesse canal.            |
| `SECRET_KEY_BASE`                           | Assina os dados de sessão do próprio serviço. |

Deixe `DATABASE_PASSWORD` e `POSTGRES_PASSWORD` vazios enquanto o subchart empacotado estiver habilitado. O subchart gera a senha no próprio Secret, e tanto o Deployment quanto o CronJob a leem de lá. Defina-os apenas para um PostgreSQL externo que não tenha um Secret próprio.

## Upgrade e desinstalação

***

```bash theme={null}
helm upgrade plugin-br-pix-direct-jd \
  oci://registry-1.docker.io/lerianstudio/plugin-br-pix-direct-jd-helm \
  --version <new-version> -n midaz-plugins -f my-values.yaml
```

```bash theme={null}
helm uninstall plugin-br-pix-direct-jd -n midaz-plugins
```

## Recursos

***

* [Documentação do Pix](/pt/interfaces/pix/pix-overview)
* [Charts Helm dos plugins](/pt/platform/deploy/plugins/plugins-helm-overview)
* [Repositório de charts Helm](https://github.com/LerianStudio/helm)