This repository has been archived by the owner on Jul 28, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates README to reflect the project direction (#451)
Signed-off-by: Takeshi Yoneda <[email protected]>
- Loading branch information
Showing
1 changed file
with
11 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,16 @@ | ||
| > [!WARNING] | ||
| > We are no longer recommending this SDK or Wasm in general for anyone due to the fundamental memory issue of TinyGo (See [the detailed explanation](https://github.com/tetratelabs/proxy-wasm-go-sdk/issues/450#issuecomment-2253729297) by a long-time community member) | ||
| > as well as [the project state of Proxy-Wasm in general](https://github.com/envoyproxy/envoy/issues/35420). | ||
| > If you are not in a position where you have to run untrusted binaries (like for example, you run Envoy proxies while your client gives you the binaries to run), we recommend using other extension mechanism | ||
| > such as Lua or External Processing which should be comparable or better or worse depending on the use case. | ||
| > | ||
| > If you are already using this SDK, but still want to continue using Wasm for some reason instead of Lua or External Processing, | ||
| > we strongly recommend migrating to the Rust or C++ SDK due to the memory issue of TinyGo described in the like above. | ||
| > | ||
| > We keep this repository open and not archived for the existing users, but we cannot provide any support or guarantee for the future development of this SDK. | ||
| # WebAssembly for Proxies (Go SDK) [](https://github.com/tetratelabs/proxy-wasm-go-sdk/actions) [](LICENSE) | ||
|
|
||
| The Go SDK for | ||
| [Proxy-Wasm](https://github.com/proxy-wasm/spec), enabling developers to write Proxy-Wasm plugins in Go. | ||
| This SDK is powered by [TinyGo](https://tinygo.org/) and does not support the official Go compiler. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| - [examples](examples) directory contains the example codes on top of this SDK. | ||
| - [OVERVIEW.md](doc/OVERVIEW.md) the overview of Proxy-Wasm, the API of this SDK, and the things you should know when writing plugins. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - [TinyGo](https://tinygo.org/): v0.32+ - This SDK depends on TinyGo and leverages its [WASI](https://github.com/WebAssembly/WASI) (WebAssembly System Interface) target. Please follow the official instruction [here](https://tinygo.org/getting-started/) for installing TinyGo. | ||
| - [Envoy](https://www.envoyproxy.io) - To run compiled examples, you need to have Envoy binary. We recommend using [func-e](https://func-e.io) as the easiest way to get started with Envoy. Alternatively, you can follow [the official instruction](https://www.envoyproxy.io/docs/envoy/latest/start/install). | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| ``` | ||
| go get github.com/tetratelabs/proxy-wasm-go-sdk | ||
| ``` | ||
|
|
||
| ## Build and run Examples | ||
|
|
||
| ```bash | ||
| # Build all examples. | ||
| make build.examples | ||
|
|
||
| # Build a specific example. | ||
| make build.example name=helloworld | ||
|
|
||
| # Run a specific example. | ||
| make run name=helloworld | ||
| ``` | ||
|
|
||
| ## Compatible Envoy builds | ||
|
|
||
| Envoy is the first host side implementation of Proxy-Wasm ABI, | ||
| and we run end-to-end tests with multiple versions of Envoy and Envoy-based [istio/proxy](https://github.com/istio/proxy) in order to verify Proxy-Wasm Go SDK works as expected. | ||
|
|
||
| Please refer to [workflow.yaml](.github/workflows/workflow.yaml) for which version is used for End-to-End tests. | ||
|
|
||
| ## Build tags | ||
|
|
||
| The following build tags can be used to customize the behavior of the built plugin: | ||
|
|
||
| - `proxywasm_timing`: Enables logging of time spent in invocation of the plugin's exported functions. This can be useful for debugging performance issues. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions from the community! See [CONTRIBUTING.md](doc/CONTRIBUTING.md) for how to contribute to this repository. | ||
|
|
||
| ## External links | ||
|
|
||
| - [WebAssembly for Proxies (ABI specification)](https://github.com/proxy-wasm/spec) | ||
| - [WebAssembly for Proxies (AssemblyScript SDK)](https://github.com/solo-io/proxy-runtime) | ||
| - [WebAssembly for Proxies (C++ SDK)](https://github.com/proxy-wasm/proxy-wasm-cpp-sdk) | ||
| - [WebAssembly for Proxies (Rust SDK)](https://github.com/proxy-wasm/proxy-wasm-rust-sdk) | ||
| - [TinyGo - Go compiler for small places](https://tinygo.org/) |