Como você documenta uma rede?

Question

Não sei como fazer essa pergunta, já que não estou no campo. Digamos que você seja um administrador de rede e saia do seu trabalho. Como o novo cara sabe por onde começar?

    

Answer 1

Depende do tamanho da rede, do número de usuários, do número de nós (computadores, servidores, impressoras etc.) e do tamanho da sua equipe de TI, entre outras coisas.

Também depende do seu objetivo. Você está documentando a rede para fins de treinamento e manutenção, prevenção de seguro / perda, etc?

Pessoalmente, eu documentei minhas redes de tal forma que sei que posso derivar qualquer informação ausente com base no que é documentado. De uma postura prática, há um ponto de retorno decrescente quando a documentação fica muito granular.

Uma boa regra que eu uso é que deve haver documentação em um local conhecido que seja minucioso o suficiente para que, se eu for atropelado por um ônibus hoje à noite, outro administrador possa manter a rede principal funcionando enquanto ele preenche os dados faltantes. peças nos próximos dias / semanas.

Aqui está uma visão geral do que eu acho mais importante sobre uma das minhas redes. Para o registro, esta é uma loja apenas para Windows com cerca de 100 usuários e 5 escritórios.

• Credenciais de administrador para todos os servidores. Obviamente, isso deve ser mantido seguro.
• Endereços IP e nomes NetBIOS para qualquer nó na rede com um endereço IP estático, incluindo servidores, estações de trabalho, impressoras, firewalls, roteadores, switches, etc.
• Informações básicas de hardware do servidor, como tags de serviço ou equivalente, capacidade total do disco, RAM total, etc.
• Principais funções de cada servidor, como Controlador de Domínio, Servidor de Arquivos, Servidor de Impressão, Terminal Server, etc.
• Localização das fitas / unidades de backup.
• Informações sobre os números de contas e credenciais para serviços como provedores de voz e dados do escritório remoto.
• DNS externo para sites e roteamento.

Se houvesse algo estranho sobre uma configuração ou fluxo de trabalho que não seria imediatamente óbvio para um novo administrador, eu escreveria um breve "breve" sobre isso também.

    

Answer 2

Acho melhor incorporar todos os itens a seguir:

• Prosa: uma visão geral em forma de parágrafos, que ajuda na visão geral inicial e também pode descrever a evolução ao longo do tempo
• Tabelas: listas tabulares, com chave de endereço, de ambiente ou de máquina (de preferência todas as opções acima)
• Diagramas: Definitivamente, precisam de diagramas com vários níveis de detalhes. Em qualquer rede de tamanho decente, é simplesmente impossível capturar tudo em uma página e torná-lo facilmente digerível. Você deseja um diagrama no nível global, com dispositivos de infraestrutura (roteadores, comutadores, terminais de encapsulamento etc.) e outro para os recursos de computação liderados por cada um desses roteadores ou terminais.

Notas adicionais sobre diagramas ... A distribuição geográfica é uma maneira fácil de segmentar, mas você também precisa de visualizações lógicas com base na função de instalação. Além disso, rotular como louco, fazendo pleno uso de fontes e cores.

    

Answer 3

A maneira mais eficaz e completa de iniciar esse processo é criá-lo a partir de um cenário de recuperação de desastre - por exemplo, o prédio pegou fogo e tudo o que temos são os backups externos. O que precisaremos comprar primeiro e como ele precisará ser configurado?

Kyle já deu grandes detalhes, mas acho que a abordagem DR ajuda-me a levar as coisas uma peça de cada vez.

    

Answer 4

A resposta de Kyle é um ótimo conselho. No mínimo, você provavelmente poderia sair com a lista:

• Servidores (incluem nomes de host, IPs e funções)
• Hardware de rede (switches, roteadores, firewalls)
• Arquivos de senha mestra (senhas de domínio, senhas de administrador)
• Um documento bruto descrevendo políticas de rede e quaisquer configurações estranhas (inclua aqui quaisquer valores discrepantes, como máquinas que não fazem parte do (s) domínio (s))

Answer 5

Onde eu trabalho - enfrentamos o mesmo problema quando comecei aqui. À medida que o número de servidores e serviços aumenta, você encontra documentação cada vez mais desatualizada, e com isso vem a atitude inevitável dos funcionários em não confiar na documentação, pelo menos na documentação técnica sobre nomes de servidores, grupos de servidores, redes etc.

Começamos a desenvolver um projeto de código aberto chamado hotwire para resolver isso ...

• Sistema de Inventário (Servidores, Redes, etc)
• Server Builds - RHick Kickstart, SuSE AutoYaST, (TODO: Debian Preseed, Solaris Jumpstart)

Combinando o sistema de inventário com o sistema de construção, garantimos que o que está no banco de dados é consistente com o que está em nossos data centers, porque agora temos que inserir os dados no inventário primeiro para podermos construa os servidores.

Um programa cliente (funcwire) é então instalado em todos os servidores (como parte do processo de compilação) que, então, dinamicamente fica de olho no hardware do servidor, conforme relatado por python-dmidecode , e o que está no inventário, portanto, se algo mudar, os administradores saberão imediatamente.

Em seguida, integramos nosso sistema wiki para que cada servidor, rack, projeto, modelo de hardware, etc, no hotwire se conecte diretamente à página da wiki apropriada.

Nós, portanto, "documentamos" nossos servidores / rede / etc usando o hotwire + um wiki (nós usamos confluência aqui, mas qualquer wiki decente servirá). (Observe, no entanto, que uma vez que os servidores são construídos - o hotwire não os modifica de forma alguma - o gerenciamento contínuo é feito via cfengine).

    

Answer 6

Eu uso o MikroTik Dude para mapear as coisas automaticamente, este é um aplicativo incrível, considerando que é gratuito. Também pode monitorar o status atual. Página da web

    

Answer 7

Geralmente, você tem alguns níveis diferentes de detalhes, semelhantes às abstrações na documentação de design de software. Você também documenta as práticas / procedimentos / configurações gerais do dispositivo. Senhas administrativas, conforme aplicável.

Em uma situação ideal, quase tudo que a próxima pessoa pode precisar é facilmente acessível e documentado entre seus documentos de diretrizes e procedimentos + diagramas de layout de rede.

Os documentos de diretrizes e procedimentos devem, em minha opinião, ser centralizados onde quer que estejam todos os documentos de TI, e os diagramas de rede podem ter sua própria estrutura de pastas para vários locais.

No caso de muitos sites satélites, como um Walmart / Targer / Home Depot, você teria um documento genérico para todas as filiais e, em seguida, alguns documentos corporativos detalhados das interconexões da matriz e então você poderia mergulhar no escritório LAN documentos.

    

Answer 8

Abordar a documentação de uma rede como desenvolvedor aborda o desenvolvimento de um sistema ...

• Considere os requisitos - isso foi bem observado acima, mas considere que a OMS consultará o documento e para QUALQUER FINALIDADE. Os auditores procurarão e lerão artefatos diferentes de um SysAdmin de mesmo nível.

• Fazendo a manutenção do doc - muitas pessoas mencionaram o valor de diagramas e mapas, e como um pensador visual eu concordo de coração. MAS essas coisas podem ser invalidadas com um único ato de adicionar / remover um host. Pense no "nível certo" de doc-o - um que seu grupo pode realmente manter.

• Data de tudo e inclua notas de POR QUE você configurou a rede da maneira que você fez. Muitas, muitas pessoas esquecem de incluir uma data - mas a DATA fornece um ponteiro para o histórico da rede. Inestimável para solução de problemas e atenua a falta de datação inerente da maioria dos diagramas de rede.

• Descarregue a documentação em "processos" - muitas vezes, procedimentos sólidos e bem construídos de compilação / implantação acabam simplificando a "documentação de rede" porque os detalhes de configuração e nomenclatura da máquina são melhor descritos nos procedimentos.

Principal objetivo: abordar a documentação como um 'sistema'; deve fornecer valor a partir do dia 1 e traz consigo uma responsabilidade inerente de mantê-lo.

    

Answer 9

No nosso site, usamos vários sistemas para documentar nossas próprias redes e clientes. Nós tentamos e falhamos com muitas técnicas / ferramentas que não foram escalonadas, mas agora estamos bem definidos com o seguinte:

• DokuWiki para dicas, descrições detalhadas de configurações e
• Tabelas (Patchport / MAC / IP / Nome do host / Função / Admin-Lookup para todos os dispositivos, Redes / VLANs / VPNs, Visão geral do hardware, etc)
• RSS para espalhar mudanças de páginas wiki
• Visio (melhor empresa que M $ comprou ...) para desenhar diagramas de tudo
• KeePass for Passwords, incluindo logins para sistemas de ticket de fornecedores
• RackTables para documentar onde os dispositivos estão localizados e corrigidos
• Ticket System, acessível para clientes
• WhatsUp Gold e outras ferramentas para monitoramento e relatórios
• Listas de discussão para manter as pessoas atualizadas

Se alguém lida com muitas redes IP, o phpIP pode ser uma solução adequada para o IPAM.

    

Answer 10

Para mais alguns tutoriais sobre como / o que documentar, há networkdocumentation.com .

Para alguns bons exemplos, consulte ratemynetworkdiagram.com . por exemplo. Este é muito bom , e este é impressionante ;).

    

Answer 11

Kyle Noland e outros pôsteres cobriram muito sobre como documentar. Estamos trabalhando na criação de um software padrão baseado na Web (hospedado internamente por você) que facilita para os administradores de rede e de sistema documentar sua rede.

Temos os seguintes aspectos abordados no software até o momento da redação (abril de 2012):

• Documentação do centro de dados.
• Detalhes do dispositivo (incluindo detalhes do HW / OS)
• Gerenciamento de endereços IP
• Mapeamento de dependência do aplicativo
• Relacionamentos de dispositivos - de edifícios a virtuais / blades.

Você pode ler mais aqui e agradecemos sua opinião.

    

Answer 12

Geralmente não é documentado, mas se você está sendo gentil, geralmente faz isso em um programa como o Visio ou um equivalente de código aberto. As informações mais importantes são quais equipamentos estão conectados a quais e as senhas de qualquer console de gerenciamento. O resto geralmente pode ser adivinhado.

    

Answer 13

Em minha carreira anterior como Gerente de TI, meu fichário de documentação incluía um diagrama do Visio de todos os dispositivos, uma lista de alocações de intervalo de endereços IP, todas as chaves de produto do Windows / Office / Acrobat, instruções sobre o que precisa ser instalado em novos computadores com instruções passo a passo como, inventário de hardware completo até o nível do componente e por último mas não menos importante a lista de números de telefone de emergência: suporte técnico ISP, suporte técnico do fabricante do roteador, etc.

    

Answer 14

Como mencionado, isso depende de vários fatores ...

Meu objetivo era ter documentação suficiente para que eu pudesse (conceitualmente, pelo menos) entregar tudo a um colega de trabalho e dizer "até 3 semanas" e saber que todos os detalhes importantes estavam lá.

• Senhas para todos os servidores e dispositivos (switches, impressoras, etc.)
• Senhas para quaisquer sites requeridos para registro - ISP, registro de nome de domínio, garantias de hardware, autoridades de certificação, etc.
• Mapa de endereços IP usados - internos, externos, dmz, blocos de DHCP, etc.
• Detalhes de cada servidor: itens padrão, como número de série, quantidade de disco, memória ram, etc., mas também mantínhamos um registro de tudo que foi feito na caixa, começando com as notas de configuração (o / s e app. instalação), depois a configuração e as alterações subsequentes.

Eu nunca consegui fazer isso completamente, mas tive como objetivo documentar todos os principais processos de rotina - como os servidores foram configurados, como e o que foi monitorado, configuração e remoção de contas, backup, etc.

    

Answer 15

Vou sugerir o link . Faz muitas das coisas que as pessoas sugeriram em outros comentários.

    

Answer 16

Mapeie e documente sua rede pode ser uma boa maneira de transferir as informações necessárias. O MS Visio é uma ferramenta de diagramas, mas é estático e você tem que gastar muito tempo com isso. Eu encontrei NetBrain é uma ferramenta de diagrama de rede ideal para fazer isso. Ele pode documentar a rede instantaneamente e a documentação pode ser exportada para o Visio ou o Word. Eu posso personalizar o conteúdo que eu quero enquanto documente minha rede. Os conteúdos customizados incluem: 

1. Conteúdos relacionados ao inventário, como número de série, versão do SO etc. 
2. Conteúdos relacionados ao design, como roteamento dinâmico, QoS, filtragem de tráfego 
3. Conteúdo relacionado ao caminho de tráfego… 
4. Conteúdo relacionado ao arquivo de configuração 
5. Diagrama

Você pode tentar documentar sua rede no site.

    

Answer 17

Eu uso ferramentas como o Microsoft Visio ou o WhatsUp Gold para mapear a topologia da rede, se isso ajudar.

    

Answer 18

O MS Visio é uma boa maneira de documentar uma rede, mas não é uma solução gratuita. Gliffy é um bom produto se você quiser manter seus custos baixos.

Os diagramas de rede típicos mostram como a informação flui através de seus dispositivos (e geralmente para a Internet). Portanto, você deve ter informações em seu diagrama sobre onde seus computadores, impressoras, WAPs, telefones IP (se aplicável), switches e roteadores estão localizados e como estão conectados. Endereços IP também podem ser incluídos com o nome do seu dispositivo. Isso é útil se você quiser dar uma olhada rápida no seu diagrama para obter informações.

    

Answer 19

O NodeSystems é exatamente isso - uma ferramenta de documentação de rede. Como um bom efeito colateral, ele criará um diagrama interativo para você.

Confira a demonstração on-line: link