此模板使用前必读:
- 下述 _斜体 _内容为模板示例,在实际写作中请根据写作需求进行修改。
- 下述 蓝色区块 内容为模板使用说明,用于提供对应章节的写作说明,请在实际写作中删除。
- 除上述说明内容外,其余内容直接复制粘贴使用即可。
- 此外,如有其他内容/章节的写作需求,可自行添加或联系文档部提供支持。
文档说明
使用范围
- 读者对象:运维工程师
- 适用版本:V6.0.2
运维报修
- 客服电话:400-648-5123 转3转2
- SLA:7X24
- 项目经理:xxx 136xxxxxxxx
- 交付架构师:xxx 130xxxxxxxx
- 工程师:xxx 130xxxxxxxx
修订记录
文档版本 | 修订日期 | 修订内容 |
---|---|---|
…… | …… | …… |
02 | 2022-01-20 |
- 新增xxx。
- 修改xxx。
- 删除xxx。
|
| 01 | 2022-01-01 | 第一次正式发布。 |
注意事项
(可选)本章节用于说明运维操作前或过程中,运维人员需要注意并遵守的相关事项。若无,可删除此章节。
常规运维
本章节主要介绍该云产品的一些常规运维操作。
本章节用于放置一些常规/例行/日常的运维操作,如获取并安装云产品、升级云产品、删除云产品、扩/缩容等。
运维标题一(要求:简洁、准确)
适用场景
本小节用于说明此运维操作的常见使用场景,即:在什么场景下,需要执行此操作。
前提条件
本小节用于说明此运维操作的前置条件准备,即:必须满足什么条件,此操作才能执行。
操作步骤
本小节用于说明此运维操作的具体操作步骤。
结果验证
(可选)本小节用于说明如何验证此运维操作成功执行。若无需验证,可删除此小节。
后续处理
(可选)本小节用于说明完成此运维操作后,还需要执行的其他相关操作。如:一云多芯在成功激活多架构后,还需扩容异构节点和创建可用区才可使用。如无后续处理操作,可删除此小节。
运维标题二
故障诊断
本章节主要介绍该云产品的一些常见故障及对应处理方案。
故障标题一
现象描述
本小节用于说明此故障所呈现出来的表面现象,以便用户根据所描述的现象,快速识别此故障。
告警信息
(可选)本小节用于说明在云平台的云监控服务中,查看到的告警信息的标题。若此故障不在云平台提示,可删除此小节。
问题定位
(可选)本小节用于说明如何进一步定位/判断此故障的具体问题,用于准确识别此故障。如在现象描述章节能够准确说明,可删除此小节。
问题原因
本小节用于说明引起此故障的准确原因或所有可能原因。
当为单个原因时,直接说明即可,无需使用下述无序列表。当为多个原因时,请使用以下形式说明。
- 原因1:xxx。
- 原因2:xxx。
- 原因3:xxx。
解决方案
本小节用于说明此故障的具体解决方案。当问题原因为多个,且需要逐个处理时,请使用以下形式,逐个说明。
- 原因1:xxx。
具体处理步骤。
- 原因2:xxx。
具体处理步骤。
- 原因3:xxx。
具体处理步骤。
故障标题二
附录
(可选)本章节用于放置一些运维时需要用到的相关内容,或需要了解的相关知识,如:常见运维命令、对运维类组件/概念/术语等的说明等。