跳转到: 导航, 搜索

Sahara/api-v2

此页面目前正在重构,以跟踪 sahara 的 API 转换工作。

描述 API 高层变更的规范可以在 https://specs.openstack.org/openstack/sahara-specs/specs/backlog/api-v2-experimental-impl.html 找到

描述新 API 实现通用工作流程的过程可以在 Mitaka 设计峰会的 etherpad 中找到。

工作项

以下子部分将包含 API 转换过程实验阶段的各项变更列表。

每个项目应包含以下条目

  • 姓名
  • 工作描述
  • 预计工作量
  • 需要规范
  • 负责人
  • 状态

这些条目中的大部分不言自明,“预计工作量”条目应该是“小”、“中”或“大”之一,这应该描述任务的预计大小,其中“小”是指少于 1 天的工作,“中”是指少于 5 天的工作,“大”是指大于 5 天的工作。这些并非硬性截止日期,而是对任何给定任务复杂度的总体估计。

“状态”条目应该是“未开始”、“已开始”或指向任务的 review(s) 的链接。

基础

初始 v2 提交

描述:此补丁将创建初始 "/v2" 端点结构。它会将所有当前端点迁移到新的 URI。此更改还将从 URI 中移除项目 ID,并将其添加到 OpenStack-Project-ID 标头。

预计工作量:

Assignee:elmiko (Michael McCune)

状态:https://review.openstack.org/#/c/273316/

新特性

添加 microversion 支持

描述:v2 端点都应尊重 microversion 请求。这些应遵循 API 工作组描述的当前最佳实践,并由 Nova 和 Ironic 等项目实施。API-WG 指南的当前状态正在制定中,但应随着其发展而遵循这些指南。

预计工作量:大

需要规范:是

负责人:

状态:未开始

添加版本发现

描述:根版本发现机制应升级为遵循 API-WG 关于此过程的指南,或者应调查 json-home 草案以在此处使用。此功能的规范应解决当前版本页面、新版本页面以及最终弃用 v1.1 api 的问题。

预计工作量:中

需要规范:是

负责人:

状态:未开始

添加 "actions" 端点

描述:为了帮助异步操作和需要更大内省的工作流程,应添加一个 action 风格的端点。此端点最初可能仅限于集群操作,但随着功能的探索,它也可能涵盖 job 风格的操作。

预计工作量:大

需要规范:是

负责人:

状态:未开始

端点更新

更新 registry images 标签

描述:/images/.../tag 和 /images/.../untag 端点应重构为符合 API 工作组关于在 https://specs.openstack.org/openstack/api-wg/guidelines/metadata.html 中描述的 metadata 指南。

预计工作量:中

需要规范:否

Assignee:shuyingya

状态:已完成 https://review.openstack.org/#/c/421827/

重命名 job execution 和 templates 端点

描述:.../jobs 端点应重命名为 .../job-templates,然后 .../job-executions 端点应重命名为 .../jobs

预计工作量:小

需要规范:否

Assignee:Shu Yingya

状态:已完成 https://review.openstack.org/#/c/441915/

重构启动 job 流程

描述:通过 /jobs/{job_id}/execute 端点执行 job template 应更改为对新 /jobs 端点的 POST 操作。

预计工作量:中

需要规范:否

Assignee:Shu Yingya

状态:已完成 https://review.openstack.org/#/c/443155/

重构取消 job 流程

描述:通过 /job-executions/{job_execution_id}/cancel 端点取消 job execution 应移除,以支持对新 /jobs/{job_id} 端点的 PATCH 请求以请求已取消状态。

预计工作量:中

需要规范:否

Assignee:Shu Yingya

状态:已完成 https://review.openstack.org/#/c/443156/

移除 job-binary-internal 端点

描述:/job-binary-internals 应移除,以支持 /job-binaries,后者接受内部数据库引用的项目,可以在 /job-binaries 下创建一个端点来上传文件(如果需要)。

预计工作量:大(如果需要替换)

需要规范:是

Assignee:Marianne Linhares Monteiro

状态:已开始 https://review.openstack.org/#/c/448113/1

重构 jobs 的 refresh-status

描述:/job-executions/{job_execution_id}/refresh-status 应移除,以支持对新 /jobs/{job_id} 端点的 GET 请求以获取正在运行的 job executions。

预计工作量:中

需要规范:否

Assignee:Shu Yingya

状态:已完成 https://review.openstack.org/444103

将 update 方法转换为使用 PATCH

描述:所有 update 操作都应同步使用 PATCH 而不是 PUT 进行部分资源更新。

预计工作量:小

需要规范:否

Assignee:Marianne Linhares Monteiro

状态:已完成 https://review.openstack.org/#/c/450484/

JSON Payload 变更

重命名 hadoop_version

描述:hadoop_version 应更改为 plugin_version

预计工作量:小

需要规范:否

Assignee:Marianne Linhares Monteiro

状态:已完成 https://review.openstack.org/#/c/454758/

重命名 oozie_job_id

描述:oozie_job_id 应更改为 engine_job_id

预计工作量:小

需要规范:否

Assignee:Marianne Linhares Monteiro

状态:已完成 https://review.openstack.org/#/c/455066/

确认 payload 包裹

描述:所有返回的 payload 都应包裹在其类型中,API 目前就是这样,为了保持一致性,应保持如此。

预计工作量:中

需要规范:否

负责人:

状态:未开始