[Docs] Add "Feature Matrix" or "Capability Status" table to Provider pages

未关闭
#2,084 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
python

调研方向

从 libcloud.apache.org/supported_providers.html 上的「Supported Providers」页面开始,并查看各个 Compute 和 Storage provider 页面。确定该矩阵应放在 provider 页面中,还是放在一个集中式文档中,然后从相关 driver 中整理标准方法和 provider 特有的 ex_* 扩展。完成的标准是:选定的主要 provider 已记录其能力支持状态和备注,并明确说明范围与维护方式。

由索引模型根据 Issue 内容生成。

描述

Is your feature request related to a problem? Please describe.

Currently, the "Supported Providers" documentation lists which drivers exist (e.g., EC2, Azure ARM, GCE), but it is difficult for a user to determine the depth of support for each provider without diving into the source code.

The Problem:
A user looking at the Compute Providers page sees that "Amazon EC2" is supported. However, they cannot easily verify:

  1. Does it support recent features like IMDSv2 (Instance Metadata Service v2)?
  2. Does it support Spot Instance requests via the unified API?
  3. Are the list_sizes or list_images methods hardcoded or dynamically fetched?

This opacity makes it hard for architects to evaluate Libcloud against the native SDKs (Boto3, Azure SDK) for their specific needs.

Describe the solution you'd like

I propose enhancing the documentation for major providers (Compute/Storage) to include a Capability Status Matrix.

Proposed Documentation Update:
On the individual provider pages (or a centralized matrix), we should track the support status of standard API methods.

Example Table:

Feature Support Status Notes
create_node ✅ Full Supports user_data, SSH keys
list_sizes ⚠️ Partial Hardcoded list (last updated 2024)
deploy_node ✅ Full
ex_start_node ✅ Extension Provider-specific extension
IPv6 Support ❌ No
Describe alternatives you've considered
  • Status Quo: Users must install the library and run dir(driver) or inspect the source code to find capabilities.
  • Automated Badge: Generating this matrix automatically from the test suite (e.g., based on which methods are overridden in the driver class). This would be the ideal long-term solution.
Additional Context

As cloud providers add features rapidly, Libcloud's value proposition is "unification." Clear documentation on what is unified vs. what requires extension methods (ex_*) is critical for adoption.

主要语言
Python
星标
2.1k
派生
935
平均合并
5 天 3 小时
30 天内合并 PR
15

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

apache/libcloud 的其他 Issue

查看 apache/libcloud 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。