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!