Skip to content

docs: add missing wasm parameters #871

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

Open
kayx23 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: add missing wasm parameters #871

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6aee2e2
add missing wasm parameters
kayx23 Sep 5, 2025
471ab63
docs: fix wasm plugin configuration structure
kayx23 Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions charts/apisix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,11 @@ The command removes all the Kubernetes components associated with the chart and
| apisix.vault.prefix | string | `""` | Prefix allows you to better enforcement of policies. |
| apisix.vault.timeout | int | `10` | HTTP timeout for each request. |
| apisix.vault.token | string | `""` | The generated token from vault instance that can grant access to read data from the vault. |
| apisix.wasm.enabled | bool | `false` | Enable Wasm Plugins. See [wasm plugin](https://apisix.apache.org/docs/apisix/next/wasm/) |
| apisix.wasm.plugins | list | `[]` | |
| apisix.wasm.enabled | bool | `false` | Enable Wasm Plugins. See [wasm plugin](https://apisix.apache.org/docs/apisix/next/wasm/). |
| apisix.wasm.file | string | `""` | Set path to Wasm plugin. |
| apisix.wasm.http_request_phase | string | `"rewrite"` | Set the HTTP request phase in which the plugin should run. |
| apisix.wasm.plugins | list | `[]` | Set Wasm plugin name. |
| apisix.wasm.priority | int | `7999` | Set wasm plugin priority. |
| autoscaling.enabled | bool | `false` | |
| autoscaling.maxReplicas | int | `100` | |
| autoscaling.minReplicas | int | `1` | |
Expand Down
9 changes: 8 additions & 1 deletion charts/apisix/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,9 +554,16 @@ apisix:
cmd: ["/path/to/apisix-plugin-runner/runner", "run"]

wasm:
# -- Enable Wasm Plugins. See [wasm plugin](https://apisix.apache.org/docs/apisix/next/wasm/)
# -- Enable Wasm Plugins. See [wasm plugin](https://apisix.apache.org/docs/apisix/next/wasm/).
enabled: false
# -- Set Wasm plugin name.
plugins: []
# -- Set wasm plugin priority.
priority: 7999
# -- Set path to Wasm plugin.
file: ""
Copy link
Copy Markdown
Member

@nic-6443 nic-6443 Apr 25, 2026

Choose a reason for hiding this comment

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

priority, file, and http_request_phase are per-plugin properties in APISIX's config, not top-level wasm settings. The existing configmap template just does toYaml .Values.apisix.wasm.plugins, so these top-level values won't be used in the generated config at all.

The correct structure should have these as fields within each plugin entry:

wasm:
  enabled: false
  plugins:
    - name: "example-plugin"
      priority: 7999
      file: "/path/to/plugin.wasm"
      http_request_phase: "rewrite"

As-is, setting apisix.wasm.priority or apisix.wasm.file would have no effect on the rendered config. The docs should show the correct per-plugin structure instead.

# -- Set the HTTP request phase in which the plugin should run.
http_request_phase: rewrite

# -- customPlugins allows you to mount your own HTTP plugins.
customPlugins:
Expand Down