envoyproxy/envoy

Add documentation about Wasm extension internals

Open

#15.361 geöffnet am 8. März 2021

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/docsarea/wasmhelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

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:

Contributor Guide

Research-Richtung
Studieren Sie die vorhandene Proxy Wasm Spezifikation und die Envoy Implementierung, um die Interna des Wasm Erweiterungsmechanismus zu dokumentieren, einschließlich der Integration mit dem Proxy Wasm C++ Host, der Laufzeitinteraktion, des Threading Modells, der VM Initialisierung und der ABI Details.
Tech Stack
cppwasm
Domain
backenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C++WebAssemblyEnvoy
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50