AskOverflow.Dev

AskOverflow.Dev Logo AskOverflow.Dev Logo

AskOverflow.Dev Navigation

  • 主页
  • 系统&网络
  • Ubuntu
  • Unix
  • DBA
  • Computer
  • Coding
  • LangChain

Mobile menu

Close
  • 主页
  • 系统&网络
    • 最新
    • 热门
    • 标签
  • Ubuntu
    • 最新
    • 热门
    • 标签
  • Unix
    • 最新
    • 标签
  • DBA
    • 最新
    • 标签
  • Computer
    • 最新
    • 标签
  • Coding
    • 最新
    • 标签
主页 / server / 问题 / 433923
Accepted
Frerich Raabe
Frerich Raabe
Asked: 2012-10-02 23:01:01 +0800 CST2012-10-02 23:01:01 +0800 CST 2012-10-02 23:01:01 +0800 CST

您如何避免服务器文档与实际设置不同步?

  • 772

我们有相当好的环境文档(AsciiDoc 格式),最近允许另一个人在不到 30 分钟的时间内从头开始重新创建整个设置。
然而,我注意到在初始设置之后,很容易发生对系统进行小的更改(比如:inetd 被禁用,我的 IMAP 服务器在一个额外的端口上监听 ManageSieve 连接,一个新的路由器被添加到 exim 配置)不要' 立即出现在文档中(如果有的话)。

我的想法是通过(部分地?)从配置文件和其中的注释生成文档来避免这个问题——实现这个的一种方法可能是/etc放入/usr/local/etc一些源代码管理系统(比如 - git),然后运行一个在每次提交时重新生成文档的脚本。但是,我不确定这是否会矫枉过正和/或太难正确(毕竟,我不希望我的文档中有源文件的完整副本,而只是差异)。

其他人如何避免服务器文档过时 - 是否有一种好方法可以自动保持它们同步,或者您是否只是在修改系统的同时更新文档?

documentation
  • 3 3 个回答
  • 364 Views

3 个回答

  • Voted
  1. Michael Hampton
    2012-10-03T04:07:48+08:002012-10-03T04:07:48+08:00

    如果你只管理一两个小系统,那么设置一个像 puppet 或 chef 这样的大型配置管理系统似乎有点矫枉过正。(不过,如果您计划在未来拥有更多系统,请立即行动!)

    对于像这样的小型设置,我建议使用类似etckeeper的程序,它会放入/etc存储git库并提供一些有用的功能,例如在安装、升级或删除软件包时自动提交。

    • 6
  2. HopelessN00b
    2012-10-02T23:57:18+08:002012-10-02T23:57:18+08:00

    每次在系统上进行更改时,您只需更新文档即可。又名Change Management。

    事实上,大多数公司都以如此荒谬的方式实施变革管理,以至于比什么都不做还糟糕,这不应减损基本概念的实用性或阻止您正确地做事。

    我曾经使用html或某种 wiki 来跟踪我的所有配置。现在我在一家 Windows 商店工作(不寒而栗)SharePoint,所以现在我使用我创建的 Word 文档“模板”来跟踪我拥有的每个系统和我所做的每个配置更改,这并不像听起来那么糟糕,因为有很多系统只是其他系统的千篇一律的副本,可以将它们全部集中到同一个文档中。(而且我将我所有资料的本地副本保存在我的硬盘驱动器中,实际上以合理的方式组织,除了将它们扔到任何人的 SharePoint 站点的无组织堆上。)

    最大的挑战实际上是花时间记录,我通过将记录时间添加为进行更改的时间的一部分来做到这一点。所以,其实并没有那么难,尤其是如果你是个混蛋,并且不介意告诉人们滚开并排队等候,因为你现在太忙了,无暇顾及他们的问题。

    • 5
  3. Best Answer
    Matt
    2012-10-03T03:02:59+08:002012-10-03T03:02:59+08:00

    您永远不会离开某些文档,但正如您所暗示的那样,有些系统可以集成到您的变更过程中以涵盖其中的大部分内容。

    • 使用配置管理工具(如puppet或chef)。
    • 以更改控制的方式存储您的配置。(比如git或SVN)
    • 确保配置是人类可读/可访问的(即纯文本、可搜索的数据库)

    这样,通过将部署信息存储在配置项或代码中作为您进行更改的系统的一部分,我们通常会错过(或不打扰)的较低级别的文档得到强制执行。这还有一个额外的好处,即该过程在未来变得更加可重复。

    外部文档仍然需要更新,但它变得非常高级,带有指向“部署 x”或“部署 y”的指针,而不是长命令/文件列表。这还使文档更改既不那么频繁又更容易,这也意味着它更有可能完成。

    同样在你回家之前,用 puppet 可能已经有人写了一些东西来管理你想要的东西。

    • 5

相关问题

  • 如何交付 IT 工具的文档?

  • 在活动目录服务器中记录什么是重要的?

  • 教程/培训创建工具[关闭]

  • 您如何记录您的工作、流程和环境?

  • 您希望开发人员向您提供什么级别的文档?

Sidebar

Stats

  • 问题 205573
  • 回答 270741
  • 最佳答案 135370
  • 用户 68524
  • 热门
  • 回答
  • Marko Smith

    新安装后 postgres 的默认超级用户用户名/密码是什么?

    • 5 个回答
  • Marko Smith

    SFTP 使用什么端口?

    • 6 个回答
  • Marko Smith

    命令行列出 Windows Active Directory 组中的用户?

    • 9 个回答
  • Marko Smith

    什么是 Pem 文件,它与其他 OpenSSL 生成的密钥文件格式有何不同?

    • 3 个回答
  • Marko Smith

    如何确定bash变量是否为空?

    • 15 个回答
  • Martin Hope
    Tom Feiner 如何按大小对 du -h 输出进行排序 2009-02-26 05:42:42 +0800 CST
  • Martin Hope
    Noah Goodrich 什么是 Pem 文件,它与其他 OpenSSL 生成的密钥文件格式有何不同? 2009-05-19 18:24:42 +0800 CST
  • Martin Hope
    Brent 如何确定bash变量是否为空? 2009-05-13 09:54:48 +0800 CST
  • Martin Hope
    cletus 您如何找到在 Windows 中打开文件的进程? 2009-05-01 16:47:16 +0800 CST

热门标签

linux nginx windows networking ubuntu domain-name-system amazon-web-services active-directory apache-2.4 ssh

Explore

  • 主页
  • 问题
    • 最新
    • 热门
  • 标签
  • 帮助

Footer

AskOverflow.Dev

关于我们

  • 关于我们
  • 联系我们

Legal Stuff

  • Privacy Policy

Language

  • Pt
  • Server
  • Unix

© 2023 AskOverflow.DEV All Rights Reserve