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.

Sign up for GitHub

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

Jump to bottom

docs/examples: Fix and add docs for Wasm C++ sandbox #13622

Merged
merged 29 commits into from
Oct 23, 2020
Merged

docs/examples: Fix and add docs for Wasm C++ sandbox #13622

merged 29 commits into from
Oct 23, 2020

Conversation

phlax
Copy link
Member

@phlax phlax commented Oct 19, 2020 •
edited
Loading

Signed-off-by: Ryan Northey ryan@synca.io

Commit Message: docs/examples: Fix and add docs for Wasm sandbox
Additional Description:

  • provide a pre-compiled wasm binary for example
  • provide recipe for updating wasm
  • fix verify.sh and composition permissions
  • add docs

Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue] Fix #13605
[Optional Deprecated:]

@phlax phlax changed the title [WIP] docs: Add docs for WASM sandbox [WIP] docs: Add docs for Wasm sandbox Oct 19, 2020
@phlax phlax force-pushed the docs-add-wasm-sandbox-docs branch 2 times, most recently from a380c6e to 6d5fef5 Compare October 19, 2020 10:58
@phlax
Copy link
Member Author

phlax commented Oct 19, 2020 •
edited
Loading

the sandbox here pretty much works. Ill update the docs next...

it includes a routine which:

  • brings up a composition with a pre-compiled wasm
  • checks content/headers
  • brings down composition
  • recompiles a new wasm
  • brings back up and rechecks

i think the recompiling is very helpful for end users of the sandbox but it adds 5mins+ to the CI

@phlax phlax force-pushed the docs-add-wasm-sandbox-docs branch from 2391148 to 6a8644b Compare October 19, 2020 12:55
@phlax phlax changed the title [WIP] docs: Add docs for Wasm sandbox [WIP] docs/examples: Fix and add docs for Wasm sandbox Oct 19, 2020
phlax
phlax commented Oct 19, 2020
View reviewed changes
examples/wasm/BUILD Outdated Show resolved Hide resolved
@phlax phlax force-pushed the docs-add-wasm-sandbox-docs branch from a60336c to cc2128f Compare October 19, 2020 15:10
phlax
phlax commented Oct 19, 2020
View reviewed changes
examples/wasm/BUILD Outdated Show resolved Hide resolved
phlax
phlax commented Oct 19, 2020
View reviewed changes
.azure-pipelines/pipelines.yml Outdated Show resolved Hide resolved
@phlax
Copy link
Member Author

phlax commented Oct 19, 2020

i have some small changes remaining, but docs are rendered here:

https://storage.googleapis.com/envoy-pr/13622/docs/start/sandboxes/wasm.html

phlax
phlax commented Oct 19, 2020
View reviewed changes
configs/configgen.sh Outdated Show resolved Hide resolved
@phlax phlax marked this pull request as draft October 19, 2020 17:56
PiotrSikora
PiotrSikora reviewed Oct 19, 2020
View reviewed changes
examples/wasm/BUILD Outdated Show resolved Hide resolved
examples/wasm/envoy_filter_http_wasm_example.cc Outdated Show resolved Hide resolved
@phlax
Copy link
Member Author

phlax commented Oct 20, 2020

/retest

@repokitteh-read-only
Copy link

Retrying Azure Pipelines.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #13622 (comment) was created by @phlax.

see: more, trace.

@phlax phlax force-pushed the docs-add-wasm-sandbox-docs branch from 0a21a82 to 7496d6c Compare October 20, 2020 07:28
@phlax phlax marked this pull request as ready for review October 20, 2020 07:52
@phlax phlax changed the title [WIP] docs/examples: Fix and add docs for Wasm sandbox docs/examples: Fix and add docs for Wasm sandbox Oct 20, 2020
@phlax
Copy link
Member Author

phlax commented Oct 20, 2020

/retest

@repokitteh-read-only
Copy link

Retrying Azure Pipelines.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #13622 (comment) was created by @phlax.

see: more, trace.

@phlax phlax mentioned this pull request Oct 20, 2020
Closed
@phlax
Copy link
Member Author

phlax commented Oct 20, 2020

/retest

phlax added 22 commits October 23, 2020 13:55
@phlax
docs
f3dcbeb 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
docs
e956df4 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
switch location -> content-type
ed8049c 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
examples/
d4030a5 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
fix compile_time_options test
ad757f9 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
last fixes, cleanups and docs updates
bb53a0f 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
docs/
d4f25d8 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
docs/
973a05e 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
docs/
4e039ae 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
docs/
ca7fc48 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
examples/
d768f3f 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
docs/
83b3df8 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
docs/
2bddc1e 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
examples/
d0329af 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
docs/
7bea3af 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
rename sandbox wasm -> wasm-cc
76639ea 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
rename sandbox wasm -> wasm-cc
b5f797b 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
examples/
fdc8e55 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
docs/
685b220 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
tools/
32c7f52 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
examples/
8ce542d 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
add clang_tidy exclusion for examples/wasm
3f761e8 
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax force-pushed the docs-add-wasm-sandbox-docs branch from 2935235 to 3f761e8 Compare October 23, 2020 12:56
mattklein123
mattklein123 approved these changes Oct 23, 2020
View reviewed changes
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool. Love seeing these working examples.

@mattklein123 mattklein123 merged commit 2dcbe20 into envoyproxy:master Oct 23, 2020
@phlax phlax mentioned this pull request Oct 23, 2020
Merged
htuch pushed a commit that referenced this pull request Oct 23, 2020
@phlax
docs: Cleanup duplicated/merged function (#13735)
38ec92e 
When #13728 and #13622 got merged a function got duplicated, this removes it

Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax mentioned this pull request Nov 6, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PiotrSikora PiotrSikora PiotrSikora left review comments

@mattklein123 mattklein123 mattklein123 approved these changes

Assignees

@PiotrSikora PiotrSikora

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add docs for Wasm Sandbox
3 participants
@phlax @PiotrSikora @mattklein123