微服务类项目部署手册思路

简介

• 文章由来：公司产品使用基于K8S的微服务已经2年半，从刚开始使用带领测试开荒到现在负责测试工具相关工作，都是和微服务打交道，前一段时间之前部门负责人来找咨询部署手册怎么写、怎么落地，基于此沟通简单整理了下。

  

  image.png

部署手册编写思路

根据以下条件综合确定

• 公司产品的(解决方案)部署形式：是在测试OK后，打包，然后到各个现场进行安装的使用场景；
• 公司产品的(解决方案)架构：docker+k8s微服务体系的基础saas服务，各类上层的微服务业务体系，涉及知识面及领域交广；
• 使用人员能力：现场部署人员有是刚毕业的新人(小白)、有linux大牛(专业大牛)、也有公司产品熟悉精通者(业务大牛)；

• 没有人是全能，啥都知道，这就需要部署文档写的比较详细，参考文档可以完成部署取来，根据人员能力性质，基本需要达到小白文的水平，按照手册不需要太多理解调整，可以部署起来。

  

  image.png

简单示例

image.png

• 示例：上面k8s微服务，切给刚接触人员使用，基本上按照教程式，图文并茂进行，切截图、文字等必须保持一致，方便理解等。
• 部署文档需要包含以下内容：部署前需要准备什么(什么样的硬件、IP需求、存储需求、下载哪些软件包、拓扑图等)、部署中具体操作及命令(每一步操作及确定OK)、完成后如何验证
  PS：有点匆忙，找时间在优化下。