Trove 的 Pike 规范示例¶
引言段落 – 规范/蓝图的动机是什么?(别忘了将上面的标题更改为更相关的名称。)
Launchpad 蓝图:https://blueprints.launchpad.net/trove/+spec/name-of-blueprint
问题描述¶
对问题的详细描述。
提议的变更¶
在这里详细介绍您建议进行的更改。您如何提出解决此问题的方法?
如果这是更大工作的一部分,请明确说明这部分在哪里结束。换句话说,这项工作的范围是什么?
如果您的规范建议对 Trove REST API 进行任何更改,例如更改可以返回或接受的参数,甚至客户端调用 API 时发生的事情的语义,那么您应该在提交消息中添加 APIImpact 标记。带有 APIImpact 标记的规范可以通过以下查询找到
https://review.openstack.org/#/q/status:open+project:openstack/trove-specs+message:apiimpact,n,z
代码片段等应放置在适当标记的块中
# This is a bash command
ls -lf
# sample code
for count in range(1, 10):
print count
配置¶
这是否会影响任何配置文件?如果是,是哪些文件?
数据库¶
这是否会影响任何现有表?如果是,是哪些表?这些更改是否向前和向后兼容?请务必包含预期的迁移过程
公共 API¶
此更改是否会影响最终用户可以访问的任何 API?在与其他 API 的一致性方面是否存在任何例外情况?
Python API¶
此更改是否会更改 Python API?如果删除了任何内容,是否已正确将其标记为已弃用?
CLI (python-troveclient)¶
是否需要修改 Trove CLI?如果 CLI 将仅实现 Python API 部分中提到的更改,则可能足以在此处提及它。
内部 API¶
此更改是否会更改 API 和任务管理器之间或任务管理器与 Guest 之间的任何内部消息?
Guest Agent¶
此更改是否会更改 Guest Agent 上的行为?如果是,是否与 API 和任务管理器向后兼容?
备选方案¶
这是一个可选部分,在适用时,我们只是希望展示已经考虑过为什么建议的方法是最好的。
Dashboard 影响 (UX)¶
本节应详细说明仪表板 (Horizon) 如何显示新的更改(如果相关)。例如,如果为 Redis 添加集群支持,本节可以这样说
Enabling Redis clustering will simply reuse the existing Launch Cluster
dialog. The Redis datastore will be in the datastore pulldown. When the
user selects Redis the Launch Cluster dialog fields will dynamically
change to display the default Launch Cluster fields.
There will be a new detail overview panel with Redis cluster specific
information.
There are no additional actions to be added at this point for the Redis
cluster.
实现¶
负责人¶
谁在编写代码?或者这是一个规范,您将其抛出以查看谁来接手?
如果有多个人正在进行实现,请指定主要作者和联系人。
- 主要负责人
<launchpad-id 或 None>
- Dashboard 指定人
<launchpad-id 或 None>
如果他们打算对该规范进行大量实施工作,可以列出其他 ID。
里程碑¶
- 完成目标里程碑
例如,Liberty-1
工作项¶
工作项目或任务 – 将该功能分解为实施它需要完成的事情。这些部分可能最终由不同的人完成,但我们主要试图了解实施的时间表。
升级影响¶
在本节中,描述提议的更改的升级影响(如果有)。这可能包括以下详细信息:
如果这影响了配置文件,则更改文件位置或源树布局,
使旧备份无效,
以可能影响现有脚本的方式更改 CLI,
消除或添加新的通知(事件),
操作员或用户作为升级的一部分必须执行的任何更改。
如果更改具有升级影响,请记住
将 DocImpact 关键字添加到提交中,并且
在提交消息或创建的文档错误中提供足够的信息。
有关 DocImpact 关键字的更多信息,请参阅 https://wiki.openstack.org/wiki/Documentation/DocImpact
注意:CLI 命令的文档在发布 CLI 的新版本时会自动从帮助字符串生成,因此通常不需要 python-troveclient 更改的 DocImpact 关键字。
依赖项¶
包括对 Trove 或其他项目中,此规范依赖或相关的规范和/或蓝图的具体引用。
此功能是否需要任何新的库依赖项或未包含在 OpenStack 中的代码?或者它是否依赖于库的特定版本?
测试¶
请讨论如何测试更改。我们特别想知道将添加哪些 int 测试和 tempest 测试。假设将添加单元测试覆盖率,因此无需明确提及,但讨论为什么您认为单元测试足够,我们不需要添加更多 tempest 测试需要包含在内。
文档影响¶
此更改对文档团队有什么影响?有些更改可能需要向文档团队捐赠资源以更新文档。不要重复上面讨论的细节,但请在此处引用它们。
附录¶
任何其他技术信息和数据。