The Plugin Filter Type (v3alpha1)

The Plugin filter type allows you to plug in your own custom code. This code is compiled into a .so file, which you load into the Envoy Proxy container at /etc/ambassador-plugins/${NAME}.so. For more information about how requests are matched to Filter resources and the order in which Filters are executed, please refer to the FilterPolicy Resource documentation.

This doc is an overview of all the fields on the Plugin Filter Custom Resource with descriptions of the purpose, type, and default values of those fields. This page is specific to the getambassador.io/v3alpha1 version of the Plugin Filter resource. For the newer gateway.getambassador.io/v1alpha1 resource, please see the v1alpha1 Plugin Filter api reference.

Plugin Filter API Reference

To create a Plugin Filter, the spec.type must be set to plugin, and the plugin field must contain the configuration for your Plugin Filter.

name: Indicates the compiled binaries name excluding the extension for the Plugin. Envoy Proxy will look for the .so file in the /etc/ambassador-plugins directory. For example, if name: "example-plugin" the .so file should be available at "/etc/ambassador-plugins/example-plugin.so" on the Envoy Proxy container.