Documentação da Infra-estrutura de Rede

A tarefa de documentar a infra-estrutura de rede é encarada muitas vezes como uma atividade burocrática e tediosa. Entretanto, a documentação é uma boa prática e contribui para melhorar o gerenciamento da rede e para que os profissionais sejam mais produtivos.

O ideal seria que a documentação fosse elaborada e atualizada automaticamente por alguma ferramenta. Caso isto não seja possível, inicie com uma documentação básica e vá incrementando até atender as suas necessidades.

No meu trabalho iniciei a documentação utilizando Openoffice e o software Dia para criar os diagramas (caso você conheça um Software Livre mais apropriado para desenho dos diagramas de topologia, favor compartilhe nos comentários).

Com o crescimento da rede o modelo de documentação inicial mostrou-se inviável. Procurei ferramentas mais adequadas e optei por implantar um wiki como respositório de documentação da rede e defini que cada membro da equipe DEVE registrar todas as alterações realizadas. Um wiki facilita a tarefa de realizar uma modificação e torná-la imediatamente disponível para toda a equipe.

Existem inúmeras ferramentas de wiki… Optei por utilizar o Trac, que possui um wiki básico integrado, recursos como controle de mudanças em projetos de desenvolvimento de software e também funciona como um brower do repositório Subversion.

O que documentar?
Não é simples elaborar e, principalmente, manter atualizada a documentação da rede. Os itens que compõe a documentação variam muito de acordo com a complexidade do ambiente de  rede e da metodologia de trabalho adotada.

A seguir sugestão de um modelo de documentação de rede contendo uma lista mínima de itens que, em minha opinião, deveriam constar em uma boa documentação de rede:

DOCUMENTAÇÃO DA INFRA-ESTRUTURA DE TI

Topologia de rede

  • Diagrama da topologia lógica
  • Diagrama de Vlans
  • Diagramas da topologia física
  • Estrutura da árvore LDAP (ou Active Directory, ser for o caso)
  • Topologia do Storage
  • Layout do datacenter e dos racks.

Ativos de rede

  • Roteadores (nome, IP, marca, modelo, localização)
  • Switches (nome, IP, marca, modelo, localização)
  • Firewalls (nome, IP, marca, modelo, localização)
  • Centrais telefônicas

Endereçamento IP e roteamento

  • Mapa de endereços IPs (Ex: classe C com IPs válidos da empresa)
  • Subredes utilizadas (endereço de rede, máscara, default gateway)
  • Esquema de roteamento

Internet

  • Qual o provedor do seu link Internet
  • Tecnologia utilizada (MPLS, Frame Relay)
  • Número de circuito, telefone de suporte, SLA
  • Lista dos domínios que sua empresa registrou e qual a data de expiração
  • Servidores DNS e registros DNS existentes (A, Mx, etc)

Documentação dos servidores

  • Nome do servidor, IP, Finalidade, SO instalado
  • Informações de hardware do servidor (processador, memória, disco, partições)
  • Serviços instalados
  • Documentação da instalação

Políticas e procedimentos

  • Política de Segurança
  • Checklist de instalação de servidores
  • Padrões para criação de contas de usuários e grupos
  • Padrões de nomenclatura para equipamentos de rede e servidores

Lista dos serviços críticos

Softwares adquiridos

  • Número de licenças, versões
  • Modalidade de licenciamento

Hardware adquirido

  • Marca, modelo, especificações
  • Data de aquisição
  • Detalhes de garantia

Imagens de instalação dos PCs (Ex: local onde baixar as imagens criadas com G4L)

Scripts base de configuração dos switches

Telefones de contato

  • 0800 do fornecedor do link Internet
  • Telefones dos prestadores de serviços e fornecedores
  • Telefones para acionar a garantia de equipamentos

Além do wiki, agregamos informações da infra nos softwares de monitoramento Nagios e Cacti. No Nagios, todos os servidores são monitorados e para cada servidor foi adicionado link apontando para a sua respectiva página de documentação no wiki.

Não esqueça de definir uma Política de Atualização da documentação para que esta não se torne desatualizada e inútil. Liste quem são os responsáveis pela atualização, periodicidade mínima de revisão e padrões que devem ser utilizados.

Em caso de falhas em serviços críticos, as informações de configuração contidas no repositório podem ajudar a minimizar o tempo de recuperação destes serviços.

Conscientize sua equipe sobre a importância da documentação e com o passar do tempo o wiki da rede se tornará um verdadeiro repositório de informações sobre o ambiente de TI.

Caso algum profissional deixe a empresa o conhecimento acumulado estará registrado nessa base de conhecimento e a tarefa de treinar um novo profissional será bem mais fácil, economizando tempo e dinheiro.

E você? utiliza quais ferramentas e metodologias para manter a documentação da sua rede?

Sua sugestão é bem vinda!

UPDATE: Publiquei um novo artigo onde disponibilizo para download um modelo de documentação de Infra de Rede.

15 Comentários até agora »

  1. Dani comentou:

    Wrote on December 3, 2008 @ 11:18

    Ferramenta online interessante para criação de diagramas:
    http://www.gliffy.com/

    Exemplo de diagrama de rede: http://www.gliffy.com/examples/network-diagrams/

  2. Everton comentou:

    Wrote on January 16, 2009 @ 16:27

    Muito bom o material apresntado. Estava com a idéia de documentar a rede de onde trabalho porem nao sabia por onde começar, este material serviu como base para buscar as ferrametas que irei precisar.

    A propósito conheço uma ferramenta interessante e gratuita. o CACIC. ele monitora todo o patrimonio de informatica na rede tanto hardware como softwares de cada maquina. muito interessante. disponivel no Portal do Software publico.

    VALEU

  3. silvio comentou:

    Wrote on January 16, 2009 @ 16:45

    Everton,
    fico contente em saber que o artigo foi útil para você.

    aqui na empresa estamos testando duas alternativas para fazer o inventário de hardware e software: o CACIC e o OCS-NG (http://www.ocsinventory-ng.org)

    Abraço

  4. Everton comentou:

    Wrote on January 16, 2009 @ 16:54

    O Cacic eu ja utilizei como teste. Apesar de ainda apresentar alguns erros nos scripts do banco de dados ele cumpre bem os requisitos que propoe-se a fazer, para quem nao conhece vale apena testar. O OCS-NG não conheço vou pesquisar a respeito.

    Valeu por mais essa dica

  5. Jéfer comentou:

    Wrote on June 5, 2009 @ 11:28

    Sobre seu pedido de Software Livre mais apropriado para desenho dos diagramas de topologia se encontrar gostaria de conhecer tb.

    Uso o OCS+GLPI, solução muito interessante.
    Julguei melhor que o CACIC nos testes que eu fiz.

  6. Richard Frank comentou:

    Wrote on June 29, 2009 @ 14:55

    silvio, mto bom post, eu tbm estava atraz de alguma solucao para documentar a infra aqui na empresa, mais tbm como Everton não sabia por onde começar, e esse post foi de grande ajuda. Agora uma dúvida, por exemplo nós que lidamos com varios usuários automaticamente, temos milhoes de Logins e Senhas para guardar como funciona o seu sistema hoje de armazenamento de Logins e Senhas dos usuários?, voce ultiliza algum software, alguma coisa do genero? outra coisa vc podeira mostrar uma prévia de como ficaria a documentação no wiki, so para termos uma base de como montar?

  7. silvio comentou:

    Wrote on July 8, 2009 @ 13:03

    Richard, na empresa usamos solução composta de OpenLdap + SAMBA para centralizar os logins e senhas… LDAP permite que seja utilizado o mesmo login e senha para vários serviços.

    Configuramos os seguintes serviços para usar o mesmo login e senha armazenados no LDAP: proxy, email, ftp, portal (Drupal), login de acesso à estações de trabalho (Ubuntu – fazendo o GDM autenticar no LDAP) e login do Windows (loga via PDC Samba)

    Vou verificar se consigo disponibilizar uma prévia da documentação (só não posso me aprofundar muito em detalhes de como fiz na empresa… política da empresa…)

  8. cesar comentou:

    Wrote on October 13, 2009 @ 13:03

    Silvio, excelente material postado!
    A grande maioria dos profissionais de TI encontram-se nesses paradigmas: Por onde começar? Seu material ajuda bastante neste “up” inicial.

    Fiquei em uma dúvida de como funciona o seu repositório em wiki. Não consegui ter uma idéia de como pode funcionar. Você publica a fonte dos documentos e o pessoal atualiza em cima?

    Valeu a dica
    Abraço!!

  9. wagner comentou:

    Wrote on November 23, 2010 @ 15:46

    muito bom o seu artigo. me ajudou pra caramba. abraço

  10. marcelo comentou:

    Wrote on February 22, 2011 @ 14:36

    Muito bom.
    Abs

  11. Edson Soares comentou:

    Wrote on July 9, 2011 @ 15:05

    Excelente artigo, obrigado.

  12. carlos coelho comentou:

    Wrote on October 22, 2011 @ 21:47

    excelente artigo, me ajudou muito do trabalho da faculdade, obrigado

  13. Samuel comentou:

    Wrote on November 17, 2011 @ 18:17

    Este conteúdo irá ajudar na criação do TCC. Obrigado!

  14. Paulo Fegueredo comentou:

    Wrote on June 18, 2012 @ 19:59

    Silvio, ajudou bastante a melhorar minha documentaçao. Como outros usuários, também uso o GLPI integrado com o OCS e o Active Directory. Costumamos, também, documentar a maioria dos problemas de informática já ocorridos na empresa e como resolver. Também temos um documento .doc com assuntos mais confidenciais, como senhas de e-mails, hospedagens, ftps, servidores, etc.

  15. Alex comentou:

    Wrote on November 23, 2012 @ 08:25

    Existe uma ferramenta opensource bastante útil chamada i-doit (http://www.i-doit.org/)

    São varias as funcionalidades para gestão do inventário, inclusive com opção de integração com OCS. Possui um CMDB interessante onde você estabelece o vinculo entre os devices de forma a analisar o impacto em caso de uma manutenção, por exemplo, ao parar o banco de dados X quais são aplicações afetadas e seus respectivos usuários.

Comment RSS · TrackBack URI

Deixe seu comentário

Nome: (Required)

E-mail: (Required)

Website:

Comentário: