Tema
DNS por-tenant e remoção de empresa
Cada empresa é alcançada no seu próprio subdomínio (ex.: bem-estar-clino.findgroup.xyz). No servidor online, a API cria e remove esse registro DNS automaticamente no ciclo de vida da empresa, via API da Cloudflare. Esta página cobre o que acontece ao provisionar e ao remover uma empresa, e as variáveis de ambiente que o operador precisa configurar.
Spec de engenharia:
docs/multi-tenancy.md(seção Infra — dynamic subdomains via the cloudflared tunnel) e o código emapps/api/src/companies/dns/.
Como o host é montado
O host do tenant é o slug + sufixo: <slug><TENANT_HOST_SUFFIX>. Com TENANT_HOST_SUFFIX=-clino.findgroup.xyz, a empresa de slug bem-estar fica em bem-estar-clino.findgroup.xyz.
É um host de nível único (não *.app.…) porque o túnel cloudflared só suporta wildcard de label inteira. Por isso cada empresa precisa do seu próprio registro — daí a automação por-tenant.
Ao provisionar — cria o CNAME (proxied)
Durante Criar empresa e node, depois de criar o banco e seedar o admin, a API cria um CNAME proxied apontando para o túnel cloudflared:
- Registro:
CNAME <slug><TENANT_HOST_SUFFIX> → <CLOUDFLARE_TUNNEL_CNAME>(ex.:bem-estar-clino.findgroup.xyz → <tunnel-id>.cfargotunnel.com). - Proxied:
true(controlado porTENANT_DNS_PROXIED) — a TLS de borda usa o certificado wildcard da zona, sem certificado por-host. - Idempotente: se o registro já existir, a API o reutiliza em vez de duplicar.
- Id guardado: o id do registro retornado pela Cloudflare é salvo na coluna
dns_record_idda empresa (no bancoplatform), junto dodns_hostname.
Falha de DNS não descarta uma empresa já provisionada: o erro é logado e o host pode ser recriado depois (a operação é reconciliável).
Ao remover empresa — apaga o registro exato
A remoção (DELETE /api/admin/companies/:id, platform-admin, só no servidor online) é o inverso do provisionamento:
- DNS — remove o subdomínio criado no provisionamento. A deleção usa o
dns_record_idsalvo na empresa, então apaga exatamente aquele registro (sem busca por nome). Se o id estiver ausente, cai num lookup por nome como fallback; se nada for encontrado, segue em frente (idempotente). - Banco — fecha o pool e roda
DROP DATABASE … WITH (FORCE)do banco isolado da empresa. - Platform — apaga as linhas da empresa (roteamento, memberships, licenças, nodes, company).
bash
curl -X DELETE https://api-clino.findgroup.xyz/api/admin/companies/<companyId> \
-H "authorization: Bearer <accessToken>"Destrutivo e irreversível. O
DROP DATABASEapaga todos os dados clínicos da empresa. Os passos externos (DNS, banco já inexistente) são best-effort e idempotentes, então uma empresa provisionada pela metade ainda pode ser limpa.
Variáveis de ambiente do operador
A automação é selecionada por TENANT_DNS_PROVIDER. O default é none — ideal para dev e instalações locais, onde nenhum DNS é tocado (os subdomínios, se houver, são geridos fora de banda).
| Variável | Para que serve |
|---|---|
TENANT_DNS_PROVIDER | cloudflare liga a automação; none (default) desliga tudo. |
TENANT_HOST_SUFFIX | Sufixo do host do tenant, ex.: -clino.findgroup.xyz. |
TENANT_DNS_PROXIED | true (default) cria o registro proxied (TLS de borda pela zona). |
CLOUDFLARE_API_TOKEN | Token com escopo de zona para criar/apagar registros DNS. |
CLOUDFLARE_ZONE_ID | Id da zona Cloudflare onde os registros vivem. |
CLOUDFLARE_TUNNEL_CNAME | Alvo do CNAME: <tunnel-id>.cfargotunnel.com. |
Quando TENANT_DNS_PROVIDER=cloudflare, as três variáveis CLOUDFLARE_* passam a ser obrigatórias — o boot falha se faltar alguma.
bash
# Exemplo (servidor online)
TENANT_DNS_PROVIDER=cloudflare
TENANT_HOST_SUFFIX=-clino.findgroup.xyz
TENANT_DNS_PROXIED=true
CLOUDFLARE_API_TOKEN=...
CLOUDFLARE_ZONE_ID=...
CLOUDFLARE_TUNNEL_CNAME=<tunnel-id>.cfargotunnel.comscripts/setup-tenant-dns-env.sh
No servidor, o token e o zone id já existem na credencial local do cloudflared (~/.cloudflared/cert.pem, usada pelo tunnel route dns). O script copia esses valores para o .env da raiz sem nunca imprimir o segredo:
bash
scripts/setup-tenant-dns-env.sh # popula CLOUDFLARE_API_TOKEN + CLOUDFLARE_ZONE_ID no .env
docker compose up -d --build api # reinicia a API com a config novaPré-requisitos: ter rodado cloudflared tunnel login (gera o cert.pem) e ter um .env na raiz (copie de .env.example). O script não preenche CLOUDFLARE_TUNNEL_CNAME — esse valor vem do seu túnel e deve ser definido manualmente no .env.
Para dev/local, não rode nada disto: deixe TENANT_DNS_PROVIDER=none.