旧バージョンのドキュメントを参照しています。最新のドキュメントはこちらをご参照ください。

Proxy-Wasmフィルタの作成

はじめてのProxy-Wasmフィルター

言語の選択

フィルター開発を実現させるには、選択したプログラミング言語が次の条件を満たす必要があります。

ビルドターゲットとして WebAssembly をサポートします
Proxy-Wasm SDK がある

以下の言語 SDKs は現在 Kong Gateway で十分にテストされており、初めてのフィルターとして適切な選択です。

Go
Rust

他の言語やProxy-Wasm SDKsは理論的にはサポートされていますが、まだ完全にテストされていません。

Kongでは、GoとRust Proxy-Wasmフィルターのテンプレートを利用できます。独自フィルターの作成を開始したり、そのまま構築して、最初のhello worldタイプフィルターを手に入れましょう。

Kongを使用したフィルターのデプロイ

フィルターを記述して構築した後、次の手順ではKongを構成してWasmサポートを有効にし、フィルターを追加して、フィルターをルートまたはサービスに関連付けます。その後、Kongを起動し、フィルターを通過するリクエストを発行できるようになります。

構成

Kong Gateway で WebAssembly サポートを有効にする必要があります。

$ export KONG_WASM=on

さらに、wasm_filters_pathパラメータは、

Kong Gatewayが実行時にフィルターをロードする順番に構成する必要があります。これは、.wasmファイルを含む任意のフォルダになります。

ローカル開発中、短いフィードバックループが必要な場合は、このパラメータをビルドツールチェーンの出力ディレクトリ（コンパイルされた <filter-name id="sl-md0000000">.wasm ファイルが生成される場所）に設定できます。

$ export KONG_WASM_FILTERS_PATH=/path/to/my_filter/build

Kong サービスおよびルートへのリンク

さて、次のステップは、Kong Filter Chainエンティティを作成することです。前のステップで作成したフィルターを使い、Kongルートまたはサービスに関連付けます。これは宣言的なyaml設定ファイルを作成することによって行われます。例：kong.yml:

---
_format_version: '3.0'
services:
  - name: my-wasm-service
    url: http://httpbin.org
    routes:
      - name: my-wasm-route
        paths:
          - /
    filter_chains:
      - name: my-wasm-demo
        filters:
          - name: my_filter
            config: >-
              {
                "my_greeting": "Hello from Kong using WebAssembly!"
              }

$ export KONG_DATABASE=off
$ export KONG_DECLARATIVE_CONFIG="$PWD/kong.yml"

Kongの起動

これでKongを開始できます。

$ export KONG_PREFIX="$PWD/wasm-servroot"
$ kong prepare
$ kong start

Proxy-Wasmフィルターの使用準備が整っています。

$ http --headers http://127.0.0.1:8000/

HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Type: text/html; charset=utf-8
Date: Thu, 03 Aug 2023 19:28:27 GMT
Vary: Accept-Encoding
Via: kong/3.4.0
X-Greeting: Hello from Kong using WebAssembly!
X-Kong-Proxy-Latency: 1
X-Kong-Upstream-Latency: 342

参考文献

前へインストールと配布

次へ proxy-wasmフィルタの構成