terravision

TerraVisão

TerraVision é uma ferramenta CLI que converte o código Terraform em diagramas profissionais de arquitetura de nuvem e resolve o problema de manter atualizado o documento mais importante em projetos de nuvem, o documento de arquitetura. Com lançamentos de alta velocidade sendo a norma agora, os diagramas de arquitetura gerados por máquina são mais precisos do que confiar no diagrama de estilo livre desenhado pelo arquiteto da nuvem, que não corresponde mais à realidade. O Terravision executa 100% do lado do cliente com segurança, sem qualquer dependência do Terraform ou acesso ao seu ambiente Cloud, para analisar dinamicamente seus recursos e variáveis ​​criados condicionalmente e gerar um visual automático de sua arquitetura. Terravision foi projetado para ser uma ferramenta 'Docs as Code' (DaC) que pode ser incluída em seu pipeline de CI/CD para atualizar diagramas de arquitetura após as fases de construção/teste/lançamento do pipeline e complementar outros geradores de documentos como readthedocs.io junto com ele. Atualmente suporta AWS e em breve nuvem Google e Azure.

Vire isso...

nisso...

Este software ainda está em teste alfa e o código é compartilhado "COMO ESTÁ", SEM GARANTIAS OU CONDIÇÕES DE QUALQUER TIPO , expressas ou implícitas. Use por sua conta e risco.

Benefícios do Terravision

1. Custo
   • Salvar licenças de software Visio/Drawing - Terravision é gratuito e de código aberto
   • Não requer nenhum custo que incorra em recursos de nuvem, ele funciona instantaneamente em sua máquina local
   • Atualizar diagramas regularmente, alinhar, conectar pontos e definir ícones não é o melhor uso dos custos de pessoal do arquiteto
2. Acelere e Automatize
   • Use arquivos de variáveis ​​TF como entradas para criar diagramas de múltiplas variantes a partir do mesmo código TF
   • Automatize a criação de diagramas de arquitetura executando o terravision como parte de pipelines de CI/CD
   • Diagramas baseados em YAML como código permitem anotar diagramas gerados com rótulos e recursos personalizados adicionais, por exemplo, recursos não gerenciados ou sistemas externos não capturados no código TF
3. Consistência em toda a organização
   • Baixa automaticamente seus módulos organizacionais/externos para garantir a visualização mais recente dos módulos downstream do Terraform
   • Design consistente de diagramas de arquitetura usando ícones padrão do setor e estilo aprovado pela AWS/GCP/Azure entre equipes
4. Visibilidade precisa
   • O estado do diagrama em tempo real mostra a infraestrutura atual que corresponde exatamente ao que está implantado na produção hoje
   • Ajuda em revisões de arquitetura de terceiros, auditoria, monitoramento, relatórios e depuração da pilha de forma visual
   • O código do diagrama personalizado e as imagens de saída podem ser colocados no controle de origem/versão para melhor manutenção e descoberta
5. Segurança
   • Não é necessário conceder acesso à sua conta AWS ou CLI para desenhar o diagrama
   • Não cria recursos de nuvem intrusivos, por exemplo, verificação de instâncias ou tabelas de metadados que as empresas precisariam aprovar
   • Todo o código-fonte permanece em seu ambiente local, os diagramas são gerados em suas máquinas sem recorrer a APIs externas

Instalação e uso

Dependências externas para todas as versões

• Graphviz https://graphviz.org/download/
• git https://git-scm.com/downloads
• terraform https://developer.hashicorp.com/terraform/downloads

Início rápido

1. Instale todas as dependências externas conforme listado acima
2. Clone o repositório git clone https://github.com/patrickchugh/terravision.git
3. Obtenha o diretório de trabalho (caminho completo) fazendo cd terravision e fazendo pwd .
4. Adicione a pasta terravision ao seu valor PATH , por exemplo, export PATH=$PATH:/Users/<PATH TO TERRAVISION> para que você possa executá-lo de qualquer lugar. <PATH TO TERRAVISION> seria a saída da linha 3.
5. Instale os requisitos do python cd terravision && pip install -r requirements.txt
6. Certifique-se de que seu script terravision python seja executável com chmod +x terravision
7. Execute terravision e especifique seus arquivos de origem do Terraform no formato:

$ terravision draw --source ~ /src/my-terraform-code

Para pilhas do Terraform com espaços de trabalho, você pode usar o parâmetro --workspace :

$ terraform draw --source ~ /src/my-terraform-code --workspace development

Para o código-fonte do Terraform em um repositório Git, você também pode usar o formulário:

$ terravision draw --source https://github.com/your-repo/terraform-examples.git

Use o caractere // para subpastas nos repositórios Git se o código desejado estiver em uma hierarquia de pastas.

$ terravision draw --source https://github.com/your-repo/terraform-examples.git//mysubfolder/secondfolder/

Anotando diagramas gerados

Nenhum diagrama gerado automaticamente terá todos os detalhes que você precisa; na melhor das hipóteses, você chegará de 80 a 90% do caminho até lá. Para adicionar anotações personalizadas, como título de diagrama principal, rótulos adicionais em setas ou recursos adicionais criados fora do Terraform, inclua um arquivo terravision.yml na pasta do código-fonte e ele será carregado automaticamente. Alternativamente, especifique um caminho para o arquivo de anotações como parâmetro para terravision.

terravision --source https://github.com/your-repo/terraform-examples.git --annotate /Users/me/MyDocuments/annotations.yml

O arquivo .yml é um arquivo de configuração YAML padrão semelhante ao exemplo abaixo com um ou mais títulos chamados title , connect , disconnect , add , remove ou update . Os nomes dos nós seguem as mesmas convenções dos nomes de recursos do Terraform https://registry.terraform.io/providers/hashicorp/aws/latest/docs e suportam curingas. Você pode adicionar um rótulo personalizado a qualquer recurso TF modificando os atributos do recurso e adicionando o atributo label (não existe no Terraform). Para linhas/conexões, você pode modificar os atributos do recurso adicionando edge_labels específicos do terravision para adicionar texto à linha de conexão para um nó de recurso específico. Veja o exemplo abaixo:

 format : 0.1
# Main Diagram heading
title : Serverless Wordpress Site
# Draw new connection lines that are not apparent from the Terraforms
connect :
  aws_rds_cluster.this :
    - aws_ssm_parameter.db_master_user : Retrieve credentials from SSM
# Remove connections between nodes that are currently shown
disconnect :
  # Wildcards mean these disconnections apply to any cloudwatch type resource called logs
  aws_cloudwatch*.logs :
    - aws_ecs_service.this
    - aws_ecs_cluster.this
# Delete the following nodes
remove :
  - aws_iam_role.task_execution_role
# Add the following nodes
add :
  aws_subnet.another_one :
    # Specify Terraform attributes for a resource like this 
    cidr_block : " 123.123.1.1 "
# Modify attributes of existing node
update :
  aws_ecs_service.this :
    # Add custom labels to the connection lines that already exist between ECS->RDS
    edge_labels :
      - aws_rds_cluster.this : Database Queries
  # Wildcards save you listing multiple resources of the same type. This edge label is added to all CF->ACM connections.
  aws_cloudfront* :
    edge_labels :
      - aws_acm_certificate.this : SSL Cert
 # Add a custom label to a resource node. Overrides default label
  aws_ecs_service.this :
   label : " My Custom Label "

Ajuda detalhada

Digite terravision --help para obter uma lista completa de comandos ou para obter ajuda com um comando específico