技术 / 分析与实践观点
凌晨三点,你需要怎样的运维手册?
一页式服务运维手册模板:用途、依赖、日志、健康检查、恢复与升级处理,不在文档中保存密码。

概念来源: On-call- Google SRE Workbook。 。 - 。 本说明的格式和样本是业务文件的独立建议书设计.
一份有用的文件应该在重点太低的时候澄清下一个决定。 对我来说,开始一个详细的页面比一个带有旧命令的大文件夹要好. 当然,一个页面是唯一的切入点;专门的详情可以包含在链接文件中.
第一页应该是什么?
- 适用和重要性: 这个服务对用户有什么作用,它做什么?
- 拥有者和推荐路径 : 技术、后续和组织联系方法在哪里?
- 附录 : 所需服务、地点和审查顺序的逻辑名称是什么?
- 健康和证据: 成功的用户测试、位置和已知错误标志是什么?
- 恢复和返回: 确定的程序联系、备份参考地点和停止行动的条件是什么?
- 纪录片信用: 谁和什么日期适应了实际情况?
假设样本。
就“内部报告”而言,可以写成:职责是每日报告显示;基本隶属关系;数据库报告;健康测试是输入测试账户和打开样本报告;如果出现错误,则检查事件时间和应用程序ID,然后检查应用程序日志。 真实的名称和路线必须由同样的环境完成.
此样本的值不在于字段数;下一位知道从哪里开始,哪些结果是有效的. 诸如“如果它被打破,启动”之类的命令不是可靠的指南,没有条件、副作用和成功的衡量标准。
纪录片需要测试.
请作者不要跟随同一向导的测试情景. 无论他在哪里不得不提出一个口头问题,都可能发现一个真正的模糊之处。 服务重大变更后审查文件.
我的建议是:不要把密码、信使和私人钥匙留在页面里, 该文件必须找到,并根据受众获取的程度量身定制。 将公共版本或教育样本与真实的网络信息分开。
相关研究: 启动前检查列表 。.
通过技术分析,为决策提供更充分的依据。全部文章 →


