Não sei como fazer essa pergunta, pois não estou em campo. Digamos que você seja um administrador de rede e deixe seu emprego. Como o novo cara sabe por onde começar?
Respostas:
Depende do tamanho da rede, número de usuários, 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 seguros / perdas, etc.?
Pessoalmente, eu documento minhas redes de forma que eu saiba que posso derivar qualquer informação ausente com base no que está documentado. Do ponto de vista prático, há um ponto de retorno decrescente quando a documentação fica muito granular.
Uma boa regra prática 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 em funcionamento enquanto preenche as peças que faltam no próximos dias / semanas.
Aqui está uma visão geral do que eu acho mais importante em uma das minhas redes. Para o registro, esta é uma loja somente para Windows, com cerca de 100 usuários e 5 escritórios.
Se houvesse algo estranho em uma configuração ou fluxo de trabalho que não fosse imediatamente óbvio para um novo administrador, eu também escreveria um breve "resumo".
Acho melhor incorporar todos os seguintes itens:
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, rotule como louco, fazendo pleno uso de fontes e cores.
A maneira mais eficaz e completa de iniciar esse processo é construí-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 backups externos. O que precisamos comprar primeiro e como ele precisa ser configurado?
Kyle já deu ótimos detalhes, mas acho que a abordagem de DR me ajuda a entender as coisas uma por vez.
A resposta de Kyle é um ótimo conselho. No entanto, no mínimo, você provavelmente poderia sair com uma lista:
Onde trabalho - enfrentamos o mesmo problema quando comecei aqui. À medida que o número de servidores e serviços aumenta, você encontra cada vez mais documentação desatualizada, e com isso vem a atitude inevitável de a equipe não confiar na documentação, pelo menos a 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 ...
Ao combinar o sistema de inventário com o sistema de compilação, garantimos que o que está no banco de dados é consistente com o que está em nossos datacenters, porque agora precisamos inserir os dados no inventário primeiro para poder construir os servidores .
Um programa cliente (funcwire) é instalado em todos os servidores (como parte do processo de compilação), que fica de olho dinamicamente no hardware do servidor, conforme relatado por python-dmidecode , e o que há no inventário; portanto, se alguma coisa mudar, os administradores saberá imediatamente.
Em seguida, integramos nosso sistema wiki para que cada servidor, rack, projeto, modelo de hardware etc. nos links hotwire diretamente para a página wiki apropriada.
Por isso, "documentamos" nossos servidores / rede / etc usando hotwire + um wiki (usamos confluência aqui, mas qualquer wiki decente o fará). (Observe, porém, que uma vez criados os servidores - o hotwire não os modifica de nenhuma maneira - o gerenciamento contínuo é feito via cfengine).
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 Cara
Geralmente, você tem alguns níveis diferentes de detalhes semelhantes às abstrações na documentação de design de software. Você também documenta práticas / procedimentos / configurações gerais do dispositivo. Senhas administrativas, conforme aplicável.
Em uma situação ideal, quase tudo o que a próxima pessoa pode precisar é facilmente acessível e documentado entre os documentos de orientação e procedimento + diagramas de layout de rede.
Os documentos de diretrizes e procedimentos devem, na 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 de satélite, como um walmart / targer / home depot, você teria um documento genérico para todas as filiais e, em seguida, alguns documentos detalhados da corporação inteira sobre interconexões da matriz e, em seguida, você poderia mergulhar nos documentos da LAN do escritório.
Abordagem para documentar uma rede como um desenvolvedor se aproxima do desenvolvimento de um sistema ...
Considere os requisitos - isso foi bem observado acima, mas considere a OMS que consultará o documento e para QUALQUER OBJETIVO. Os auditores procurarão e lerão artefatos diferentes de um SysAdmin de mesmo nível.
Fazendo manutenção de documentos - muitas pessoas mencionaram o valor de diagramas e mapas e, como pensador visual, concordo plenamente. 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 possa realmente manter.
Date tudo e inclua notas sobre POR QUE você configurou a rede da maneira que configurou. Muitas pessoas esquecem-se de incluir uma data - mas o DATE fornece um ponteiro para o histórico da rede. Inestimável para a solução de problemas e mitiga a desatualidade inerente da maioria dos diagramas de rede.
Transfira a documentação para os "processos" - muitas vezes procedimentos sólidos de criação / implantação bem planejados acabam simplificando a "documentação de rede" porque os detalhes de configuração e nomeação da máquina são melhor descritos nos procedimentos.
Takeaway chave: abordar a documentação como um 'sistema'; deve fornecer valor a partir do dia 1 e carrega consigo uma responsabilidade inerente de mantê-lo.
Em nosso site, usamos vários sistemas para documentar nossas próprias redes e clientes. Tentamos e falhamos com muitas técnicas / ferramentas que não foram dimensionadas, mas agora estamos bem definidos com o seguinte:
Se alguém lida com muitas redes IP, o phpIP pode ser uma solução IPAM adequada.
Para mais alguns tutoriais sobre como / o que documentar, há networkdocumentation.com .
Para alguns bons exemplos, consulte ratemynetworkdiagram.com . eg Este é muito bom , e este é incrível ;).
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 sistema documentar sua rede.
Temos os seguintes aspectos abordados no software até o momento da redação (abril de 2012):
Você pode ler mais aqui e agradecemos seus comentários.
Geralmente não está documentado, mas se você está sendo gentil, geralmente o faz 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.
Na 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 das alocações de intervalo de endereços IP, todas as chaves do produto para Windows / Office / Acrobat, instruções sobre o que precisa ser instalado nos novos computadores com instruções passo a passo de como, completar o inventário de hardware 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 do ISP, suporte técnico do fabricante do roteador etc.
Como mencionado, depende de vários fatores ...
Meu objetivo era ter documentação suficiente para que eu pudesse (pelo menos conceitualmente) entregá-lo a um colega de trabalho e dizer "vejo você em 3 semanas" e saber que todos os detalhes importantes estavam lá.
Nunca consegui fazê-lo completamente, mas pretendi 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.
Vou sugerir http://opennetadmin.com . Faz muitas das coisas que as pessoas sugeriram em outros comentários.
Mapear e documentar sua rede pode ser uma boa maneira de transferir as informações necessárias. O MS Visio é uma ferramenta de diagrama, mas é estático e você precisa gastar muito tempo com isso. Eu descobri que o 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 Word. Posso personalizar o conteúdo que desejar enquanto documenta minha rede. O conteúdo personalizado inclui:
Você pode tentar documentar sua rede no site.
O MS Visio é uma boa maneira de documentar uma rede, mas não é uma solução gratuita. Gliffy é um bom produto se você deseja manter seus custos baixos.
Os diagramas de rede típicos mostram como as informações fluem através dos seus dispositivos (e geralmente para a Internet). Portanto, você deve ter informações em seu diagrama sobre onde estão localizados seus computadores, impressoras, WAPs, telefones IP (se aplicável), comutadores e roteadores e como estão conectados. Os endereços IP também podem ser incluídos com o nome do seu dispositivo. Isso é útil se você quiser dar uma olhada no diagrama para obter informações rapidamente.
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 online: http://www.nodesystems.org/demo/