OpenStack-Ansible 安装指南的全面修订

日期:

2016-05-31 00:00

标签:

docs

蓝图：OpenStack-Ansible 安装指南的全面修订

在 2016 年奥斯汀峰会上，就 OpenStack-Ansible 安装指南的现状进行了一次讨论，并达成了一致意见。

注意

之前已经创建了一个 蓝图和规范，旨在改进峰会讨论中提出的文档。

目前，OpenStack-Ansible 安装指南包含的安装信息很少，但配置信息却很多。本规范提出一个更正式的计划，以分离这些信息并简化安装指南，使其更易于快速安装 OpenStack。

问题描述

OpenStack-Ansible 安装指南包含的信息不一定属于安装指南的结构。它积累了大量的配置信息和参考信息，这降低了用户安装 OpenStack 的重点和简洁性。

当前的安装指南也不遵循 openstack-manuals 文档约定。

提议的变更

安装指南的主要重点是重新组织和开发内容，以便部署者在部署 OpenStack 测试环境和生产环境时做出很少的决策和最少的配置。

拟议的更改是

  • 明确定义参考架构，并在附录中开发用例配置示例。

  • 将当前安装指南中的配置信息删除，并将其包含在 OpenStack-Ansible 角色文档中。

  • 暂时将运维内容迁移到 openstack-ansible-ops 仓库，直到可以生成运维指南为止。

  • 重构指南，以包含基本的部署配置。

  • 附录包括配置文件示例、neutron 插件、cinder 选项以及与 OpenStack-Ansible 安装相关的其他资源。

  • 从安装指南中包含指向基于角色的文档的链接。

备选方案

  • 保持安装指南不变，仅将配置信息迁移到开发者文档。

  • 考虑修改安装指南，以满足 项目特定的安装指南 中的标准，并发布到 docs.openstack.org

Playbook/Role 影响

N/A

升级影响

N/A

安全影响

N/A

性能影响

N/A

最终用户影响

这些更改有望改善最终用户体验，通过提供更结构化和更好的信息流程来安装 OpenStack。

部署者影响

N/A

开发人员影响

首先将现有内容迁移到角色，然后开发者必须将任何新的文档提交到角色仓库。

依赖项

N/A

实现

负责人

主要负责人

Alexandra Settle (asettle)

其他贡献者

Darren Chan (darrenc), Jesse Pretorius (odyssey4me), Travis Truman (automagically), Major Hayden (mhayden)

工作项

  • 澄清并获得内容结构的一致意见

  • 根据需要从主题专家处收集信息

  • 为安装指南的更改创建一个草稿目录

  • 创建一个工作项列表并分配资源

  • 确保文档符合 openstack-manuals 写作约定

  • 在发布之前测试草稿文档

测试

测试将由社区在提供草稿后进行。OpenStack-Ansible 用户将被要求遵循新的安装指南来安装 OpenStack，并评估提供的信息是否准确、清晰和简洁。

文档影响

这是一个文档更改，不适用。

参考资料