配置参考：记录常用选项

更新日期：2018-12-06 13:55

配置参考：文档通用选项¶

https://blueprints.launchpad.net/openstack-manuals/+spec/config-ref-common-sections

问题描述¶

在配置参考中，诸如数据库、AMQP、keystone 中间件等配置选项的文档记录不完善，或者更糟糕的是，在多个地方记录不一致。

这可能会让读者感到困惑，并增加维护负担。

提议的变更¶

通用库定义了多个配置选项，所有 OpenStack 项目都会用到。与其为每个项目单独记录这些选项，不如创建一个专门的章节来记录通用库的配置选项，并在项目的章节中引用该章节。

目前这些选项的文档记录不完善，因此这次更改也将有机会添加缺失的信息，或者至少提供一个更好的结构以便将来进行补充。

此规范仅影响配置参考。

备选方案¶

在所有项目的章节中重复记录所有内容，导致大量重复

实现¶

负责人¶

主要负责人：gpocentek

工作项¶

使用 autohelp 为通用库生成选项表格。这些选项不会从项目的表格中删除，以继续为每个项目提供完整的选项集。
在配置参考中添加一个新的 通用配置选项 章节，记录 oslo 和 keystonemiddleware 库中可用的配置选项。记录的库包括（非详尽列表）
- oslo.concurrency
- oslo.db
- oslo.log
- oslo.messaging
- keystonemiddleware.auth_token
如有必要，删除项目中这些选项的文档记录（例如，使用 oslo.messaging 的 AMQP 有时会被记录）。
在每个组件章节中，添加对通用选项章节的引用。

依赖项¶

无

测试¶

使用 autohelp 生成的表格验证已记录选项的存在性。

参考资料¶

无

更新日期：2018-12-06 13:55

Creative Commons Attribution 3.0 License

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