Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about Wasm extension internals #15361

Open
mathetake opened this issue Mar 8, 2021 · 2 comments
Open

Add documentation about Wasm extension internals #15361

mathetake opened this issue Mar 8, 2021 · 2 comments

Comments

@mathetake
Copy link
Member

mathetake commented Mar 8, 2021

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:

@mathetake mathetake added the triage Issue requires triage label Mar 8, 2021
@dio dio added area/docs enhancement Feature requests. Not bugs or questions. and removed triage Issue requires triage labels Mar 8, 2021
@dio
Copy link
Member

dio commented Mar 8, 2021

cc. @phlax

@mattklein123
Copy link
Member

In general WASM docs are at 0% right now. It's a known issue that we need a massive push on docs.

@mattklein123 mattklein123 added area/wasm help wanted Needs help! and removed enhancement Feature requests. Not bugs or questions. labels Mar 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants