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

Aberta
  • Algo errado?
#2,084 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
cloud, documentation

Direção de pesquisa

Comece pela página «Supported Providers» em libcloud.apache.org/supported_providers.html e revise as páginas individuais dos provedores de Compute e Storage. Determine se a matriz deve ficar nas páginas dos provedores ou em um documento centralizado e, em seguida, faça um inventário dos métodos padrão e das extensões ex_* específicas dos provedores nos drivers relevantes. A tarefa estará concluída quando os principais provedores selecionados tiverem seus status de suporte e notas documentados, e o escopo e a abordagem de manutenção estiverem explicitamente definidos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Python
Estrelas
2.1k
Forks
935
Merge médio
5d 3h
PRs com merge (30d)
15

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de apache/libcloud

Todas as issues de apache/libcloud

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.