Lework Study hard, improve every day.

一篇软件部署文档,该有哪些部分呢?

2019-12-10
lework
本文 567 字,阅读全文约需 2 分钟

作为一名苦逼运维,写软件部署文档时必不可少的一件事情,可以说:文档的好坏决定了运维能力的高低。

那我们在写部署文档的时候,要做哪些事情,要写关于软件的哪些步骤呢,本人结合自己常用的一些流程,整理了下列的模板,仅供大家参考!

  1. 软件简介

    介绍安装内容

  2. 集群概述

    描述下集群的实现方式

  3. 环境信息

    描述软件的部署环境信息

    3.0 软件版本

    3.1 架构图

    3.2 节点列表

    System OS IP Address Kernel Hostname Cpu Memory Application
    CentOS 7.4.1708 192.168.77.130 5.1.11-1.el7 rmq0 1C 1G rabbitmq
  4. 网络信息

    软件的网络环境信息

    集群网络: 192.168.77.0/24

    集群DNS: 192.168.77.2

  5. 节点初始化

    软件宿主机的初始化操作

    5.1 关闭防火墙

    5.2 关闭网络服务

    5.3 关闭selinux

    5.4 关闭swap

    5.5 启动同步时间

    5.6 系统参数调整

    5.7 修改系统限制

    5.8 设置主机名解析

    5.9 添加依赖仓库

    5.10 内核升级(根据情况)

  6. 安装部署

    按照软件的步骤

  7. 验证

    验证安装是否成功。

    6.1 安装完验证

    6.2 节点重启完验证

  8. 常用操作

    软件的常用操作命令

最后的最后,本文档只是做一个参考,没必要完全照搬,照搬也不一定适合每个人的需求。书写本文档的目的也只是想规范下部署文档的大体内容,方便日后写文档。

原文地址 https://lework.github.io/2019/12/10/install-include/

Similar Posts

Comments