documentation - 您推荐哪些方法/技术/工具用于记录系统和基础架构（运行手册）？

Question

背景

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

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

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

在我发现我不知道我的主要 subversion 配置文件在 /etc/apache2 中的位置之前，我一直有点随意（更不用说配置文件不受版本控制或备份！ ) 我意识到这需要迅速解决。

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

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

是否有维护 Runbook 的良好指南？好软件？这一定是一个相当普遍的问题，你是如何处理的？

score 2 · Accepted Answer

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

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

score 1 · Accepted Answer

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

score 1 · Accepted Answer

如果您使用Puppet（或 Chef 或 CFEngine 等）之类的东西来构建和管理您的机器，那么大部分 Runbook 内容都可以存在于 puppet 配置中，这样您就可以使用更少的东西（只有位置和密码）对于 puppetmaster，如果你把它发挥到极致！）放入你的维基。