IT运维服务部署与记录规范 V1.1

公司的内网和外网部署了非常多的服务,如果不进行记录和规范化,一段时间后服务将无法被维护,直接导致的结果就是服务本身无法正常运行,以及依赖这些服务的工作无法正常开展。所以,我们将对内网和外网服务的上线做一些文档化的要求。一方面帮助开发者理清对应项目的条理,另一方面也为服务的可部署和可维护提供一些保障。任何需要将所开发的项目或服务部署在内网和外网时,都需要编写服务部署文档。

请开发者完成相应的内容,并邮件至 it@deepin.com,由相关人员审核后回复。请部署者完成相应的内容,合并开发者已经完成的部分,邮件至 it@deepin.com,并以项目名称为文件夹名称,归档到 seafile的 IT运维目录中。

以下内容由项目或服务的开发人员撰写,文档包含但不仅限于以下内容:

1、项目概述
对要上线的项目或服务进行说明,包括项目名称、用途和开发者。如果该项目或服务是一组项目或一组服务的集合,请说明每个项目或服务的名称和用途,以及相互之间的关系。如果该项目或服务依赖依赖其他项目或服务,请说明相互之间的依赖关系。

2、项目地址
对于由社区或商业公司开发和支持的项目或服务,请提供官方下载地址或Github等代码托管平台的地址。对于由公司开发和支持的项目或服务,请提供内部代管托管服务的地址或Github的地址。

3、部署方式
请基于一个干净的系统,由始至终详细描述项目或服务的部署方式。如果该项目或服务是一组项目或一组服务的集合,请分别描述每一个项目或服务。

4、升级方式
对于由公司开发和支持的项目或服务,请说明更新的周期,以及更新的方法。如果该项目或服务是一组项目或一组服务的集合,请分别描述每一个项目或服务。

以下内容由项目或服务的部署人员撰写,文档包含但不仅限于以下内容

5、备份方式
对于该项目或服务的数据,说明备份方案,包括备份的周期、位置和方法等。

6、部署位置
对于已经完成的部署,运维人员应该记录该服务部署的服务器地址和目录,以及是由谁来完成该项目或服务的部署。如果完成部署和完成文档的人不同,请分别说明。如果该项目或服务是一组项目或一组服务的集合,请分别描述每一个项目或服务。

发表评论

电子邮件地址不会被公开。 必填项已用*标注