Lua

    As of Envoy v1.18 the v2 API has been removed and is no longer supported.

    If you are upgrading from v2 API config you may wish to view the v2 API documentation:

    This extension may be referenced by the qualified name

    Note

    This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted.

    Tip

    Lua configuration overview.

    inline_code

    (string, REQUIRED) The Lua code that Envoy will execute. This can be a very small script that further loads code from disk if desired. Note that if JSON configuration is used, the code must be properly escaped. YAML configuration may be easier to read since YAML supports multi-line strings so complex scripts can be easily expressed inline in the configuration.

    source_codes

    (repeated map<, config.core.v3.DataSource>) Map of named Lua source codes that can be referenced in . The Lua source codes can be loaded from inline string or local files.

    Example:

    extensions.filters.http.lua.v3.LuaPerRoute

    disabled

    () Disable the Lua filter for this particular vhost or route. If disabled is specified in multiple per-filter-configs, the most specific one will be used.

    Precisely one of disabled, , source_code must be set.

    name

    () A name of a Lua source code stored in Lua.source_codes.

    Precisely one of , name, must be set.

    source_code

    Precisely one of disabled, , source_code must be set.