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

Aperta
  • Qualcosa non va?
#2,084 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
cloud, documentation

Direzione di ricerca

Inizia dalla pagina «Supported Providers» all’indirizzo libcloud.apache.org/supported_providers.html e rivedi le singole pagine dei provider Compute e Storage. Determina se la matrice debba trovarsi nelle pagine dei provider o in un documento centralizzato, quindi inventaria i metodi standard e le estensioni ex_* specifiche dei provider dai driver pertinenti. Il lavoro è completo quando per i principali provider selezionati sono documentati gli stati di supporto e le note, e l’ambito e l’approccio di manutenzione sono resi espliciti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
2.1k
Fork
935
Merge medio
5g 3h
PR unite (30g)
15

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di apache/libcloud

Tutte le issue di apache/libcloud

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.