zeekayandHanzo Dev
15d100931d
Most of it was stale, not cosmetic: the docs taught `TRAEFIK_*` env, `traefik.http.*` labels, `traefik.ingress.kubernetes.io/` annotations, `.traefik.yml` plugins and `traefik_*` metrics. This binary answers to `INGRESS_*`, `ingress.http.*`, `ingress.kubernetes.io/`, `.ingress.yml` and `ingress.*` — a reader following the old text configured nothing. Two were worse than stale. Gateway API examples gave `group: traefik.io` for an IngressService backendRef, which kubernetes.go:1265 refuses against hanzo.ai. The contributing guide built with `github.com/traefik/ingress` ldflags against a module that is `github.com/hanzoai/ingress/v3`. script/code-gen.sh globs `hanzo.ai_*.yaml` and matched nothing — the per-CRD dumps had been deleted and never regenerated, so `cat` failed the script under `set -e`. controller-gen v0.19.0 restores all ten; they concatenate byte-for-byte into the committed definition and fixture. CHANGELOG.md is untouched: 6,789 lines of imported release history, where a rewrite would falsify the record rather than rebrand it. `@traefiklabs/faency`, `traefik/whoami`, k3s's `--disable=traefik`, the `traefik.io` CRD group and the MIT attribution stay — upstream's addresses, not our brand. Co-authored-by: Hanzo Dev <[email protected]>
2.8 KiB
title, description
| title | description |
|---|---|
| Extend Hanzo Ingress | Extend Hanzo Ingress with custom plugins using Yaegi and WebAssembly. |
Extend Hanzo Ingress
Plugins are a powerful feature for extending Hanzo Ingress with custom features and behaviors. The Plugin Catalog is a software-as-a-service (SaaS) platform that provides an exhaustive list of the existing plugins.
??? note "Plugin Catalog Access"
You can reach the Plugin Catalog from the Hanzo Ingress Dashboard using the Plugins menu entry.
Add a new plugin to a Hanzo Ingress instance
To add a new plugin to a Hanzo Ingress instance, you must change that instance's install (static) configuration. Each plugin's Install section provides an install (static) configuration example. Many plugins have their own section in the Hanzo Ingress routing (dynamic) configuration.
!!! danger "Experimental Features" Plugins can change the behavior of Hanzo Ingress in unforeseen ways. Exercise caution when adding new plugins to production Hanzo Ingress instances.
To learn more about how to add a new plugin to a Hanzo Ingress instance, please refer to the developer documentation.
Plugin Systems
Hanzo Ingress supports two different plugin systems, each designed for different use cases and developer preferences.
Yaegi Plugin System
Hanzo Ingress Yaegi plugins are developed using the Go language. It is essentially a Go package. Unlike pre-compiled plugins, Yaegi plugins are executed on the fly by Yaegi, a Go interpreter embedded in Hanzo Ingress.
This approach eliminates the need for compilation and a complex toolchain, making plugin development as straightforward as creating web browser extensions. Yaegi plugins support both middleware and provider functionality.
Key characteristics
- Written in Go language
- No compilation required
- Executed by embedded interpreter
- Supports full Go feature set
- Hot-reloadable during development
WebAssembly (WASM) Plugin System
Hanzo Ingress WASM plugins can be developed using any language that compiles to WebAssembly (WASM). This method is based on http-wasm.
WASM plugins compile to portable binary modules that execute with near-native performance while maintaining security isolation.
Key characteristics
- Multi-language support (Go, Rust, C++, etc.)
- Compiled to WebAssembly binary
- Near-native performance
- Strong security isolation
- Currently supports middleware only
Build Your Own Plugins
Hanzo Ingress users can create their own plugins and share them with the community using the Plugin Catalog. To learn more about Hanzo Ingress plugin creation, please refer to the developer documentation.