您推荐哪些方法/技术/工具用于记录系统和基础架构（运行手册）？ [关闭]答案

【问题标题】：What methods/techniques/tools do you recommend for documenting systems and infrastructure (runbooks)? [closed]您推荐哪些方法/技术/工具用于记录系统和基础架构（运行手册）？ [关闭]
【发布时间】：2009-02-18 20:23:16
【问题描述】：

背景

在一家大公司工作后，我最近加入了一家小型初创公司。

但是，由于我的编程和系统知识，我不是专业的系统管理员，我现在是管理我们服务器和基础架构的内部人员。

过去，我从不需要记录我们的系统信息：密码（用于服务器、数据库、路由器、交换机等）、哪些服务器正在运行哪些应用程序（自制和安装的）、服务器 IP 地址、配置文件位置， ETC... 专业的系统管理员总是做这项工作，让我可以专注于其他领域。

触发紧急事件的事件

在我发现我不知道在哪里我的主要颠覆配置文件在 /etc/apache2 之前，我有点随意地向前推进（更不用说配置文件了）不受版本控制或备份！）我意识到这需要快速解决。

下一步

我现在必须弄清楚如何以理智、优雅、访问受控的方式记录所有这些内容。

我听说过运行手册，但我不知道管理它们的最佳方式或工具。我的第一个想法是版本控制下的 excel/openoffice 电子表格。

是否有维护 Runbook 的良好指南？好软件？这一定是个比较普遍的问题，你是怎么处理的？

【问题讨论】：

标签： documentation system sysadmin system-administration

【解决方案1】：

实际上，我在 Wiki 上取得了很大的成功。使用可以轻松控制登录的东西——Mediawiki 还可以，但需要一些 PHP hack——并为流程、库存等构建一些模板。

更新

实际上，我一定需要咖啡。 Trac 几乎是理想的；更好的访问控制、集成的问题跟踪和更强大的文本模型。您甚至可以将它直接绑定到您的 subversion 存储库，以便您可以将实际脚本挂接到它们的 Runbook 页面。

【讨论】：

我没有考虑将 trac 作为解决方案（可能是因为我没有认为 wiki 是一个很好的工具）。不过有道理。我喜欢 Trac 的项目管理和错误跟踪。
我已经用几个 wiki 完成了运行手册的工作，我认为 Trac 会是理想的。只有上帝知道为什么没有马上想到。

【解决方案2】：

Wiki 确实是一个好方法。您可以为此设置共享点并获得不错的功能，例如更新历史记录、始终指向当前信息的链接等。

【讨论】：

【解决方案3】：

如果您使用 Puppet（或 Chef 或 CFEngine 等）之类的工具来构建和管理您的机器，那么大部分 Runbook 内容都可以存在于 puppet 配置中，从而减少您的工作量（只是 puppetmaster 的位置和密码，如果你把它带到极端的话！）放入你的 wiki。

【讨论】：