envoyproxy/envoy

Add documentation about Wasm extension internals

Open

#15 361 ouverte le 8 mars 2021

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)C++ (5 373 forks)batch import
area/docsarea/wasmhelp wanted

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

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:

Guide contributeur

Direction de recherche
Étudiez la spécification Proxy Wasm existante et l'implémentation d'Envoy pour documenter les aspects internes du mécanisme d'extension Wasm, y compris l'intégration avec l'hôte Proxy Wasm C++, les interactions d'exécution, le modèle de threading, l'initialisation des VM et les détails de l'ABI.
Stack technique
cppwasm
Domaine
backenddocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C++WebAssemblyEnvoy
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50