dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3359 from codefromthecrypt/wasm-url 

wasm middleware: change path property to url
This commit is contained in:
Hannah Hunter 2023-05-09 17:16:42 -04:00 committed by GitHub
parent bff94b5b5f 69e70ad5b0
commit 36493dc6f7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
daprdocs/content/en/reference/components-reference/supported-middleware/middleware-wasm.md
View File

@ -17,9 +17,10 @@ binary. In other words, you can extend Dapr using external files that are not
pre-compiled into the `daprd` binary. Dapr embeds [wazero](https://wazero.io) pre-compiled into the `daprd` binary. Dapr embeds [wazero](https://wazero.io)
to accomplish this without CGO. to accomplish this without CGO.
Wasm modules are loaded from a filesystem path. On Kubernetes, see [mounting Wasm binaries are loaded from a URL. For example, the URL `file://rewrite.wasm`
volumes to the Dapr sidecar]({{< ref kubernetes-volume-mounts.md >}}) to configure loads `rewrite.wasm` from the current directory of the process. On Kubernetes,
a filesystem mount that can contain Wasm modules. see [How to: Mount Pod volumes to the Dapr sidecar]({{< ref kubernetes-volume-mounts.md >}})
to configure a filesystem mount that can contain Wasm modules.
## Component format ## Component format
@ -32,8 +33,8 @@ spec:
type: middleware.http.wasm type: middleware.http.wasm
version: v1 version: v1
metadata: metadata:
- name: path - name: url
value: "./router.wasm" value: "file://router.wasm"
``` ```
## Spec metadata fields ## Spec metadata fields
@ -42,8 +43,8 @@ Minimally, a user must specify a Wasm binary implements the [http-handler](https
How to compile this is described later. How to compile this is described later.
| Field | Details | Required | Example | | Field | Details | Required | Example |
|----------|----------------------------------------------------------------|----------|----------------| |-------|----------------------------------------------------------------|----------|----------------|
| path | A relative or absolute path to the Wasm binary to instantiate. | true | "./hello.wasm" | | url | The URL of the resource including the Wasm binary to instantiate. The supported schemes include `file://`. The path of a `file://` URL is relative to the Dapr process unless it begins with `/`. | true | `file://hello.wasm` |
## Dapr configuration ## Dapr configuration
@ -109,7 +110,7 @@ func handleRequest(req api.Request, resp api.Response) (next bool, reqCtx uint32
``` ```
If using TinyGo, compile as shown below and set the spec metadata field named If using TinyGo, compile as shown below and set the spec metadata field named
"path" to the location of the output (ex "router.wasm"): "url" to the location of the output (for example, `file://router.wasm`):
```bash ```bash
tinygo build -o router.wasm -scheduler=none --no-debug -target=wasi router.go` tinygo build -o router.wasm -scheduler=none --no-debug -target=wasi router.go`
@ -145,7 +146,7 @@ func rewrite(requestURI []byte) ([]byte, error) {
``` ```
If using TinyGo, compile as shown below and set the spec metadata field named If using TinyGo, compile as shown below and set the spec metadata field named
"path" to the location of the output (ex "example.wasm"): "url" to the location of the output (for example, `file://example.wasm`):
```bash ```bash
tinygo build -o example.wasm -scheduler=none --no-debug -target=wasi example.go tinygo build -o example.wasm -scheduler=none --no-debug -target=wasi example.go