apache / apache/libcloud

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

Abierto
#2,084 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
2.1k
Forks
931
Merge medio
1 d 2 h
PR fusionados (30 d)
4

Descripción

### 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](https://libcloud.apache.org/supported_providers.html) 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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con la página «Supported Providers» en libcloud.apache.org/supported_providers.html y revisa las páginas individuales de proveedores de Compute y Storage. Determina si la matriz debe estar en las páginas de los proveedores o en un documento centralizado y, a continuación, inventaría los métodos estándar y las extensiones ex_* específicas de cada proveedor de los drivers relevantes. Se considera terminado cuando los proveedores principales seleccionados tienen documentados sus estados de compatibilidad y sus notas, y el alcance y el enfoque de mantenimiento están definidos explícitamente.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
cloud, documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.