架构设计指南重构

架构设计指南重构

问题描述

目前,架构设计指南主要按用例组织。然而,在设计 OpenStack 云时,经常会结合来自不同用例的功能。

建议重新组织信息,以便用户可以考虑所有需求,从而确定他们的 OpenStack 云架构。在开发、分阶段或生产环境中设计 OpenStack 云时,应提供更多信息。建议开发一个更详细的结构,在云架构概念和各种 OpenStack 项目之间创建抽象。这将使维护和更新指南更容易。

提议的变更

指南的建议结构是首先描述常见的云用例,然后是通用的架构概念,最后是设计章节,其中详细分解了主要的云架构组件。

设计章节的标题如下

  1. 技术细节
  2. 容量和规模
  3. 高可用性
  4. 运维要求
  5. 部署注意事项
  6. 维护注意事项

这些标题旨在作为应提供的信息类型的指南。只有在需要特别强调信息时才使用。

建议的目录

架构设计指南的新建议结构如下

  1. 总体概述

  2. 用例

    1. 开发云
      1. 利益相关者
      2. 用户故事
      3. 设计模型
      4. 组件框图
    2. 通用计算云
      1. 利益相关者
      2. 用户故事
      3. 设计模型
      4. 组件框图
    3. Web 规模云
      1. 利益相关者
      2. 用户故事
      3. 设计模型
      4. 组件框图
    4. 公共云
      1. 利益相关者
      2. 用户故事
      3. 设计模型
      4. 组件框图
  3. 高可用性

    1. 概述
  4. 容量和规模

    1. 概述
  5. 设计

    1. 计算

      所有与计算平台实现相关的课题,例如 hypervisors、nova、ironic 等。

    2. 存储

      所有与存储选择以及 cinder、manila 等项目的实现相关的课题。

    3. 网络

      所有与网络设计选择(如 SDN、LBaaS 和 neutron)相关的课题。

    4. Identity

      关于 keystone 和任何其他相关项目在所有层级的身份验证、授权和分配的课题。

    5. 镜像

      关于 glance 和其他相关项目的镜像管理、创建、分发和部署的课题。

    6. 控制平面

      关于 OpenStack 控制组件的通用实现以及需要做出的选择的决策过程的课题。

    7. 仪表板和 API

      关于使用图形界面或 OpenStack API 与云服务交互的课题。这包括 horizon 和其他云管理平台 (CMP) 工具。

备选方案

保持指南不变

实现

负责人

主要负责人
  • shilla-saebi
其他贡献者
  • dazzachan
  • shaunom

工作项

  • 就信息架构达成共识
  • 修改摘要,以明确识别书籍的受众和目的
  • 移动内容以改进信息架构
  • 识别信息差距并提交和修复错误

依赖项

测试

测试将遵循标准文档审查流程。

参考资料

  • 讨论可以使用任何官方媒介进行,包括 #openstack-doc 中的 IRC、主题中带有 [arch-guide] 的 openstack-docs 邮件列表、双周 Ops Guide 专业团队会议、每周文档团队会议,以及潜在的 etherpads。
Creative Commons Attribution 3.0 License

除非另有说明,本文档根据 知识共享署名 3.0 许可协议 授权。请参阅所有 OpenStack 法律文件

docs-specs