Ferramenta gratuita

Docker Compose para diagrama

Cole um docker-compose.yml e veja seus serviços, redes, volumes e dependências como um diagrama. Não é preciso ter conta para testar.

Resultado de exemplo

Diagrama de exemplo desenhado a partir de um exemplo de Docker Compose

Tem manifestos do Kubernetes? Experimente a ferramenta de YAML do Kubernetes

Como funciona

  1. Cole ou solte seu arquivo do Compose

    Um docker-compose.yml ou compose.yaml, o mesmo arquivo que você executa com docker compose up. Âncoras YAML e campos de extensão x- funcionam normalmente.

  2. Veja o diagrama

    Os serviços viram cartões com imagem, portas e réplicas. As redes viram molduras, e os volumes nomeados, secrets e configs são ligados aos serviços que os usam.

  3. Abra no Archboard

    Salve como um novo diagrama para reorganizar, anotar, compartilhar um link ou exportar em SVG e PNG. Para se cadastrar basta uma conta Google ou GitHub.

O que é desenhado a partir de um arquivo do Compose

O diagrama é montado a partir destas chaves do seu arquivo:

  • services

    Cada serviço como um cartão, com o nome da sua chave

  • imagebuild

    A imagem, ou o contexto de build nos serviços construídos a partir do código-fonte

  • ports

    As portas como 8080:80 ou 80, sem o IP do host; a sintaxe longa aparece como published:target, com o protocolo quando não é TCP

  • deploy.replicasscale

    O número de réplicas de deploy.replicas ou scale

  • volumes

    Os volumes nomeados, ligados aos serviços que os montam

  • secretsconfigs

    Secrets e configs apenas pelo nome, ligados aos serviços que os usam

  • networks

    As redes como molduras, com cada serviço dentro da moldura da sua primeira rede

  • depends_on

    Ligações de um serviço para os serviços dos quais ele depende

Sem a chave networks, o projeto inteiro é desenhado como uma única moldura. Com redes, cada serviço fica na moldura da sua primeira rede e é ligado às molduras das outras redes de que participa.

O que o diagrama não mostra

  • Quais serviços chamam uns aos outros em tempo de execução: depends_on define a ordem de inicialização, e um arquivo do Compose descreve como os serviços estão ligados, não o tráfego real
  • Valores de variáveis de ambiente, o conteúdo de env_file e o que há dentro de secrets e configs (só os nomes são lidos)
  • Contêineres em execução, estado de saúde, logs ou uso de recursos
  • Campos herdados com extends (mesmo de um serviço do mesmo arquivo) e serviços de arquivos incluídos com include: só os campos escritos em cada serviço são desenhados

Perguntas

Quais arquivos do Compose funcionam?

Qualquer docker-compose.yml ou compose.yaml com uma chave services na raiz, incluindo arquivos antigos que começam com uma linha version. Cole um arquivo por vez.

O que acontece com variáveis e arquivos .env?

As variáveis não são substituídas: uma imagem ou porta escrita com uma variável aparece exatamente como foi escrita. Os valores em environment e os arquivos listados em env_file não são lidos.

Posso colar um arquivo override ou vários arquivos?

Cole um arquivo por vez. Um arquivo override como docker-compose.override.yml é lido sozinho: cole o arquivo com os serviços que você quer ver ou junte os arquivos em um só antes. Arquivos de include não são seguidos e extends não é resolvido. Mesmo no mesmo arquivo, só os campos escritos naquele serviço são desenhados.

O que acontece quando abro o diagrama no Archboard?

O diagrama que você vê (formas, nomes e conexões) é salvo como um novo diagrama no seu espaço de trabalho, onde dá para reorganizar, adicionar notas, compartilhar ou exportar. É um ponto de partida: mudanças posteriores no seu arquivo do Compose não atualizam o diagrama.

A ferramenta é gratuita?

Sim. Colar um arquivo do Compose e ver o diagrama não exige conta. Para abrir no Archboard, basta uma conta gratuita.

Abra um canvas em um minuto

Entre com Google ou GitHub. Grátis para um assento. Faça upgrade quando a equipe entrar.