Что я использую для хранения документации сервера?
Мне пришлось документировать серверы, которые я использую, и я не знаю, что использовать для хранения данных. Не могли бы вы предложить лучший способ сохранить документацию сервера? Создаю ли я базу данных, содержащую документацию по аппаратному и программному обеспечению, или я использую вики-страницы или SVN? Или, если это инструмент, который содержит документацию, не могли бы вы предоставить ссылку.
11 ответов
Я лично использую небольшую программу под названием The Guide, которую я нахожу намного быстрее, чем использую вики (которую я также использую). Вы даже можете вставлять файлы Excel прямо на страницы, а также многие другие типы файлов.
Существует портативная версия, так что вы можете брать ее с собой куда угодно на флэш-накопителе USB. Я просто хотел бы, чтобы был Linux-клиент, который мог бы читать те же файлы.
Вики или Google Docs лучше для совместной работы.
Там действительно нет единственного лучшего способа сделать это. Это сильно зависит от окружающей среды, людей, систем, бюджета и индивидуальных предпочтений.
Прежде чем вы сможете выбрать "лучший" вариант, вы должны понять ваши требования. Особые требования, а не просто "где я могу разместить свою документацию?". Какое оборудование / программное обеспечение у вас есть сейчас? Сколько людей будет использовать это? Какой у меня бюджет на аппаратное и / или программное обеспечение? Это только для серверной документации, или будет включена другая техническая документация? Нужны ли другим группам доступ к документации? Насколько безопасна документация? После того, как вы ответили на некоторые из них, вы можете проверить свои варианты.
If you're a Microsoft shop, you're likely going to trend towards their tools. If you're an Open Source tools shop, you'll probably tend towards something Open Source. If you like the ability to make quick changes, a Wiki is a great way to go. If you like your documentation separated out in sets of files, then a file share or SharePoint might be the right solution. If you like lots of screen shots to go with your documentation, OneNote might be the right answer. If you want something Wiki-like but self-contained (Wiki-in-a-file), then TiddlyWiki is a great tool.
Among your many options (not a comprehensive list):
- Wiki
- DokuWiki
- TiddlyWiki
- Foswiki
- Обсуждение MediaWiki
- впадение
- Hundreds of others (free and commercial)
- Microsoft Shop
- Файловый ресурс
- Various other Knowledge Base tools
The most important thing is that you use something. Documentation is key. Also, make sure you keep it fairly simple and low-overhead. It's just as important to keep the documentation up to date as it is to write it up front. If updating your documentation isn't as easy as possible (and wrapped in policies to help ensure it says updated), people won't do it. You don't want people skipping documentation updates because it's a pain in the ass to update.
Мы использовали Device42 для документации сервера и центра обработки данных. Отличный инструмент, и эти ребята постоянно добавляют функции. Не очень дорого, около 250 долларов за 100 устройств.
Ну, я не знаю, каковы ваши конкретные требования в деталях, но я могу посоветовать вам, чего следует избегать (основываясь на моем личном опыте).
Не используйте офисные костюмы для документации, такой как OpenOffice или Word, поскольку они хранят свои данные в своих собственных форматах, таких как.doc или.odt. Это может быть очень болезненно, когда вы переключаетесь на другую систему документации позже.
Я также могу посоветовать вам не хранить вашу документацию в.txt файлах. Хотя с ними легко обращаться (их можно перемещать без особых усилий, можно искать и т. Д.), Это очень неэффективный способ упорядочить ваши вещи. Особенно, если вы хотите встроить изображения или видео в ваши документы.
SVN не является плохим способом хранения ваших данных, но имеет недостатки, когда вы хотите, чтобы другие пользователи имели доступ к вашим данным. Кроме того, вы должны делать svn обновления, проверки и т. Д. Все время. Это может раздражать (у меня есть хранилища документации SVN самостоятельно..).
Лучший способ, который я видел до сих пор, - это использование Wiki или комбинации CRM (мы используем Sugar CRM) и файловой системы. Я предпочитаю системы Wiki, когда у них есть система управления версиями и пользователями. Это позволяет легко сотрудничать, вы можете делать практически все, и вы свободны в том, как вы организовываете себя.
Я дам свою личную рекомендацию для OneNote. Это способность быстро делать скриншоты процессов установки и изменений (и затем иметь возможность искать текст в ИЗОБРАЖЕНИЯХ) с помощью win-S - убийственная особенность.
GLPI- это сторона открытого исходного кода, предназначенная для хранения документации на компьютерах, программном обеспечении, принтерах (и как она изменилась со временем).
Для дополнительных функций есть также база знаний, система, позволяющая отслеживать, к каким компьютерам подключены (на уровне сети). Он включил систему тикетов для сообщения / решения проблем и справочной службы.
Мы используем вики здесь. Отличный инструмент, особенно если вы делитесь документами для внутреннего редактирования
Папки с электронными таблицами с информацией о каждом сервере, документациями / документами в формате PDF с инструкциями по эксплуатации, контактными данными для OEM /VAR / службы поддержки и т. Д.
Затем получите что-то вроде dropbox/sugarsync/etc. и убедитесь, что вы синхронизируете все это с Интернетом, чтобы все, что вы обновляете, копировалось. Вам понравится это в ситуации DR.
Что я сделал, это:
Документирован каждый сервер в MS Word:
Документация включает в себя: a) сведения об аппаратном обеспечении сервера (количество сетевых карт, контроллеров Raid, версии микропрограммного обеспечения каждой карты, версию BIOS, количество физических дисков и версий микропрограммного обеспечения.
b) План рейда: тип уровня (ов) рейда, членство физических дисков в виртуальных дисках, номера дисков Windows (это помогает мне определить, какой диск Windows находится на моем сервере и уровне рейда).
c) Конфигурация сети: настройки IP, настройки брандмауэра, входящие порты разрешены, исходящие разрешены / запрещены.
d) Установленная операционная система: версия, используемый ключ, дата установки, расположение файла подкачки, любые другие дампы драйверов или приложения, которые я сохранил на нем, установленные приложения и веб-сайты (при необходимости).
e) Поддержка сервера / Поддержка поставщика: тип поддержки, контактный номер, метка обслуживания.
Я использовал диаграмму топологии AD для визуализации нашей инфраструктуры AD и сохранил ее в формате PDF.
Затем я установил скрипт под названием "Racktables", который является открытым исходным кодом, использует базу данных mysql - очень прост в настройке.
Которые я использую для прокладки RACKS серверной комнаты и там серверов, затем я конвертирую файлы MS Word в PDF и прикрепляю к этим стойкам.
Вы также можете использовать сценарий проекта SYDI Documentation для документирования ваших серверов: http://ogenstad.net/2006/10/18/how-to-document-servers-with-sydi-part-1-of-3/
Надеюсь, что помогает Rihatum
NodeSystems предназначена для хранения серверной документации. Как побочный эффект, он также генерирует интерактивную диаграмму.
Проверьте онлайн демо здесь: http://www.nodesystems.org/demo/
Проверьте SCC (сборщик конфигурации сервера) http://scc.qnh.eu/, у которого есть клиенты для Win32, большинства Linux и других Un*x, чтобы получить информацию о конфигурации и обновлять ее с помощью версий для аудитов и т. Д.
В предыдущей компании мы добавили текстовый файл на основе этого на сервер, который затем анализируется, чтобы помочь в "документировании" функции / владельца конкретного сервера и т. Д.
Но да, по-прежнему существует необходимость в общем доступе к вики / документам для таких вещей, как инструкции по добавлению / удалению дисков в той или иной системе для операторов и обслуживающего персонала.