envoyproxy/envoy

Add documentation about Wasm extension internals

Open

#15.361 aberto em 8 de mar. de 2021

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (5.373 forks)batch import
area/docsarea/wasmhelp wanted

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

Description

Given that Wasm extension mechanism seems more complex than standard built-in extensions, it is useful provide the dedicated documentation about Wasm extension internals for end-users and Envoy core developers.

This would include, for example,

  • How Envoy is integrated with Proxy-Wasm C++ Host
  • How runtimes interact with Envoy
  • The Threading model
  • How VMs are initialized and Wasm binaries are loaded
  • Envoy specific implementation details
  • How to provide Envoy specific ABI
  • Considerations and limitations (e.g. memory consumptions, etc.)
  • How to develop statically linked NullVm Wasm plugins

and could be based on https://github.com/proxy-wasm/spec/blob/master/docs/WebAssembly-in-Envoy.md

Related issues:

Guia do colaborador

Direção de pesquisa
Estude a especificação existente do Proxy Wasm e a implementação do Envoy para documentar os internos do mecanismo de extensão Wasm, incluindo integração com o Proxy Wasm C++ Host, interação em tempo de execução, modelo de threading, inicialização da VM e detalhes da ABI.
Pilha de tecnologia
cppwasm
Domain
backenddocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
3-5 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C++WebAssemblyEnvoy
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50