Vitrage 获取模板列表 API

https://blueprints.launchpad.net/vitrage/+spec/template-list-api

一个用于列出从模板库加载的所有模板的 API,包括通过验证和未通过验证的模板

问题描述

我们希望能够列出从 /etc/vitrage/templates 加载的所有模板,在将其上传到 Vitrage 之前,包括那些通过验证和未通过验证的模板。

提议的变更

创建 API 以列出所有已加载的 Vitrage 模板。

  1. 有效模板 - 已经通过验证并加载到场景仓库中的模板。

  2. 无效模板 = 未通过验证的模板。

模板列表 API 返回一个包含以下列的表格

  1. uuid - Vitrage 生成的唯一 ID

  2. name - 模板名称

  3. status - 是否通过验证

  4. 状态详情

  5. date - 模板验证发生的时间(在执行模板加载之前)

备选方案

数据模型影响

REST API 影响

模板列表

返回模板列表

GET /

头部

  • X-Auth-Token (字符串, 必需) - Keystone 认证令牌

  • Accept (字符串) - application/json

  • User-Agent (字符串)

路径参数

无。

查询参数

请求体

无。

请求示例

GET /v1/template/
Host: 135.248.18.122:8999
User-Agent: keystoneauth1/2.3.0 python-requests/2.9.1 CPython/2.7.6
Accept: application/json
X-Auth-Token: 2b8882ba2ec44295bf300aecb2caa4f7
响应

状态码

  • 200 - 确定

  • 400 - 请求错误

响应体

返回一个表格,该表格是所有模板的列表。每一行描述一个模板及其状态。

响应示例

::

uuid

name

status

状态详情

date

67bebcb4-53b1-4240-ad05-451f34db2438 4cc899e6-f6cb-43d8-94a0-6fa937e41ae2 0548367e-711a-4c08-9bdb-cb61f96fed04 33cb4400-f846-4c64-b168-530824d38f3e a04cd155-0fcf-4409-a27c-c83ba8b20a3c

vm_down_causes_suboptimal_application host_cpu_load_causes_vm_problem switch_connectivity_issues host_nic_down disconnected_storage_problems

failed pass pass pass pass

实体定义必须包含 template_id 字段 模板验证通过 模板验证通过 模板验证通过 模板验证通过

2016-06-29T12:24:16Z 2016-06-29T12:24:16Z 2016-06-29T12:24:16Z 2016-06-29T12:24:16Z 2016-06-29T12:24:16Z

安全影响

流水线影响

其他最终用户影响

性能/可扩展性影响

其他部署者影响

开发者影响

实现

负责人

liat har-tal <liat.har-tal@nokia.com>

工作项

未来生命周期

依赖项

测试

还需要添加 Tempest 测试来测试

  1. 获取模板列表

文档影响

新的 api 应该被记录

参考资料