Назад | Перейти на главную страницу

Что я использую для хранения документации сервера?

Мне пришлось задокументировать серверы, которые я использую, и я не знаю, что использовать для хранения данных. Не могли бы вы предложить лучший способ сохранить документацию по серверу? Должен ли я создать базу данных, содержащую документацию по аппаратному и программному обеспечению, или я могу использовать вики-страницы или SVN? Или, если есть инструмент, содержащий документацию, не могли бы вы предоставить ссылку.

На самом деле нет единственного лучшего способа сделать это. Это сильно зависит от окружающей среды, людей, систем, бюджета и индивидуальных предпочтений.

Прежде чем вы сможете выбрать «лучший» вариант, вам необходимо понять свои требования. Конкретные требования, а не просто «где разместить документацию?». Какое оборудование / программное обеспечение доступно сейчас? Сколько людей будут этим пользоваться? Какой у меня бюджет на оборудование и / или программное обеспечение? Это только для документации по серверу или будет включена другая техническая документация? Потребуется ли доступ к документации другим группам? Насколько защищенной должна быть документация? После того, как вы ответите на некоторые из них, вы можете проверить свои варианты.

Если вы являетесь магазином Microsoft, вы, вероятно, будете склоняться к их инструментам. Если вы продаете инструменты с открытым исходным кодом, вы, вероятно, будете склоняться к чему-то с открытым исходным кодом. Если вам нравится возможность быстро вносить изменения, Wiki - отличный способ. Если вам нравится, что ваша документация разделена на наборы файлов, то общий файловый ресурс или SharePoint могут быть правильным решением. Если вам нравится много снимков экрана в документации, OneNote может быть правильным ответом. Если вам нужно что-то похожее на Wiki, но самодостаточное (Wiki-in-a-file), то TiddlyWiki - отличный инструмент.

Среди множества вариантов (неполный список):

Самое главное, что вы используете что-то. Документация - ключ к успеху. Кроме того, убедитесь, что он достаточно прост и не требует дополнительных затрат. Поддерживать актуальность документации так же важно, как и писать ее заранее. Если обновить вашу документацию не так просто (и завернуто в политику, чтобы гарантировать, что она обновлена), люди не будут этого делать. Вы же не хотите, чтобы люди пропускали обновления документации, потому что обновлять их - заноза в заднице.

Я лично использую небольшую программу под названием Гид, который я считаю намного быстрее, чем использование вики (которую я тоже использую). Вы даже можете встраивать файлы Excel прямо на страницы, а также файлы многих других типов.

Eсть портативная версия, так что вы можете брать его с собой куда угодно на USB-накопителе. Я просто хотел бы, чтобы был клиент Linux, который мог читать те же файлы.

Однако для совместной работы лучше использовать вики или Документы Google.

Что ж, я не знаю подробно, каковы ваши конкретные требования, но я могу посоветовать вам, чего следует избегать (на основе моего личного опыта).

Не используйте офисные костюмы для документации, такие как OpenOffice или Word, поскольку они хранят свои данные в своих собственных форматах, таких как .doc или .odt. Это может быть очень болезненно, когда вы позже переключитесь на другую систему документации.

Я также могу посоветовать вам не хранить вашу документацию в файлах .txt. Хотя с ними легко обращаться (их можно перемещать без особых усилий, можно искать и т. Д.), Это очень неэффективный способ организовать ваши вещи. Особенно, если вы хотите вставлять изображения или видео в свои документы.

SVN - неплохой способ хранения ваших данных, но имеет недостатки, когда вы хотите разрешить другим пользователям доступ к вашим данным. Кроме того, вам нужно постоянно обновлять svn, проверять и т. Д. Это может раздражать (у меня самого есть репозитории документации SVN ..).

Лучший способ, который я видел до сих пор, - это использование Wiki или комбинации CRM (мы используем Sugar CRM) и файловой системы. Я предпочитаю вики-системы, когда в них есть система управления версиями и пользователями. Это позволяет легко сотрудничать, вы можете делать почти все, и вы свободны в способах самоорганизации.

Мы использовали Устройство42 для документации серверов и центров обработки данных. Отличный инструмент, и эти ребята постоянно добавляют функции. Не очень дорого, около 250 долларов за 100 устройств.

Дам свою личную рекомендацию по OneNote. Это возможность быстро делать снимки экрана с процессами установки и изменениями (а затем фактически иметь возможность искать текст НА ИЗОБРАЖЕНИЯХ) с win-S - убойная функция.

Мы используем Вики здесь. Отличный инструмент, особенно если вы делитесь документами для внутреннего редактирования

Папки с электронными таблицами с информацией о каждом сервере, документами / PDF-документами с руководствами пользователя, контактной информацией для OEM / VAR / поддержки и т. Д.

Затем получите что-то вроде dropbox / sugarsync / etc. и убедитесь, что вы синхронизируете все это с Интернетом, чтобы все, что вы обновляете, было реплицировано. Вам это понравится в ситуации аварийного восстановления.

Я сделал следующее:

Документировал каждый сервер в MS Word:

Документация включает: a) Сведения об аппаратном обеспечении сервера (количество сетевых адаптеров, контроллеров Raid, версии прошивки каждой карты, версию BIOS, количество физических дисков и версии прошивки.

b) Схема рейда: тип уровня (уровней) рейда, членство физических дисков в виртуальных дисках, номера дисков Windows (это помогает мне определить, какой диск Windows является тем, что на моем сервере, и уровень рейда).

c) Конфигурация сети: настройки IP, настройки брандмауэра, входящие порты разрешены, исходящие разрешены / запрещены.

г) Установленная операционная система: версия, используемый ключ, дата установки, расположение файла подкачки, любые другие дампы драйверов или приложения, которые я сохранил на нем, установленные приложения и их веб-сайты (при необходимости).

e) Поддержка сервера / поставщика: тип поддержки, контактный номер, сервисный код.

Я использовал диаграмму топологии AD для визуализации нашей инфраструктуры AD и сохранил ее в формате PDF.

Затем у меня установлен скрипт под названием «Racktables» с открытым исходным кодом, использующий базу данных mysql - очень легко настроить.

Который я использую для построения СТОЙКИ серверной комнаты и серверов, затем конвертирую файлы MS Word в PDF и прикрепляю к этим стойкам.

Вы также можете использовать сценарий проекта документации SYDI для документирования ваших серверов: http://ogenstad.net/2006/10/18/how-to-document-servers-with-sydi-part-1-of-3/

Надеюсь, что поможет Рихатум

Что касается открытого исходного кода, то он предназначен для хранения документации по компьютерам, программному обеспечению, принтерам (и тому, как она менялась со временем). GLPI.

Для дополнительных функций есть также база знаний, система, позволяющая отслеживать, какие компьютеры и где подключены (на уровне сети). Он включает систему тикетов для сообщения / решения проблем и службу поддержки.

NodeSystems предназначена для хранения серверной документации. В качестве побочного эффекта он также создает интерактивную диаграмму.

Посмотрите онлайн-демонстрацию здесь: http://www.nodesystems.org/demo/

Проверьте SCC (сборщик конфигурации сервера) http://scc.qnh.eu/ у которых есть клиенты для Win32, большинства Linux и других Un * x, чтобы получать информацию о конфигурации и обновлять ее с помощью контроля версий для аудита и т. д.

В предыдущей компании мы добавили основанный на этом текстовый файл на сервер, который затем анализируется, чтобы помочь в «документировании» конкретной функции / владельца сервера и т. Д.

Но да, по-прежнему существует потребность в общем ресурсе вики / документа для таких вещей, как инструкции по добавлению / удалению дисков в той или иной системе для операторов и обслуживающего персонала.