为审计添加名称¶

https://blueprints.launchpad.net/watcher/+spec/add-name-for-audit

问题描述¶

仅凭 UUID 很难让终端用户区分不同的审计。如果我们为审计添加名称，将更方便终端用户使用。

用例¶

作为终端用户，我希望能够通过名称检索审计。

提议的变更¶

本规范主要是为审计添加名称，以便用户可以轻松检索审计。

对于 watcherclient/watcher-api：用户可以通过名称显示/删除/更新审计。创建带有名称的审计。审计名称不是必需的。如果未提供审计名称，则使用默认名称。默认名称由策略或审计模板或目标名称与当前时间组成。
对于 DB：在审计表中添加一个新字段来存储审计的名称。审计表中的新字段，具有唯一属性：name = Column(String(63), nullable=True)
对于通知：将审计名称添加到 AuditPayload、ActionPlanPayload

备选方案¶

无

数据模型影响¶

是的，在审计表中添加一个名为“name”的新字段来存储审计的名称。

REST API 影响¶

以下 API 将会发生变化。参数“audit”现在可以用于通过审计的 UUID 或审计的名称来 GET、DELETE 或 PATCH 一个审计。 * GET /v1/audits * DELETE /v1/audits * PATCH /v1/audits

审计 API 的返回值将会发生变化。将“name”字段添加到以下返回值类型的审计对象中。 * AuditCollection * Audit

安全影响¶

无

通知影响¶

是的，它会将审计名称添加到 AuditPayload、ActionPlanPayload

其他最终用户影响¶

这可能会影响 watcher-dashboard。

性能影响¶

无

其他部署者影响¶

无

开发人员影响¶

无

实现¶

负责人¶

主要负责人：sue

工作项¶

为审计添加名称，python-watcherclient 的更改
为审计添加名称，watcher api/db 的更改
为审计添加名称，更新审计通知和 API 参考

依赖项¶

无

测试¶

单元测试

文档影响¶

是的，将更新两份文档。

Watcher 中的通知 https://docs.openstack.org/developer/watcher/dev/notifications.html
API 参考 https://docs.openstack.org/developer/watcher/#api-references

参考资料¶

无

历史¶

无

为审计添加名称