# traefik-external-processing

**Repository Path**: mirrors_DataDog/traefik-external-processing

## Basic Information

- **Project Name**: traefik-external-processing
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-26
- **Last Updated**: 2025-10-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# External Processing Plugin for Traefik

This plugin allows you to use [Envoy's External Processing API](https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/ext_proc/v3/external_processor.proto) on your Traefik proxy.

**Disclaimer**: This plugin doesn't support the whole features of the External Processing API. It only supports the following features:

- Request headers ProcessingRequest to the External Processor
- Response headers ProcessingResponse to the External Processor
- Request headers/body mutations
- Response headers/body mutations

With a send mode configuration:
- `response_header_mode`: `SENT`
- `response_body_mode`: `NONE`
- `request_header_mode`: `SENT`
- `request_body_mode`: `NONE`
- `request_trailers_mode`: `SKIP`
- `response_trailers_mode`: `SKIP`

## Usage

Import into your `traefik.yml` file:

```yaml
experimental:
  plugins:
    plugin-external-processing:
      moduleName: "github.com/DataDog/traefik-external-processing"
      version: "v1.0.0"
```

The plugin also needs to be configured as a middleware on each of your services:

*Note: The plugin needs to be added as the first middleware.*

```yaml
http:
  routers:
    webservice:
      rule: "PathPrefix(`/`)"
      service: "webservice"
      entryPoints:
        - web
      middlewares:
        - plugin-external-processing # Adding the plugin middleware here
  middlewares:
    plugin-external-processing:
      plugin:
        plugin-external-processing:
          traefik_external_processor_middleware_host: "127.0.0.1"
          traefik_external_processor_middleware_port: "444"
          request_timeout: 500
```

To allow the plugin to perform requests to the External Processor, you need to create a new service that listens on the configured port.

```yaml
entryPoints:
  plugin-external-processor:
    address: ":444" # Matching the "traefik_external_processor_middleware_port" of the plugin configuration

http:
  routers:
    plugin-external-processor:
      # Allowing only request coming from localhost and to the External Processor
      # Only call by the Ext Proc Plugin
      rule: "Host(`127.0.0.1`) && PathPrefix(`/envoy.service.ext_proc.v3.ExternalProcessor/Process`)"
      service: "plugin-external-processor"
      entryPoints:
        - plugin-external-processor
  services:
    plugin-external-processor-service:
      loadBalancer:
        servers:
          - url: "h2c://localhost:443" # The host:port should be your real external processor service
```

## Configuration

The plugin needs to be configured with the following parameters:

| **Environment variable**          | **Default value** | **Description**
|-----------------------------------|:-------------------:|----------------
| `traefik_external_processor_host` |   `127.0.0.1`   | Host on where Traefik is installed. It will be used to route the request to the configured External Processor service.
| `traefik_external_processor_port` |       `444`      | Port on where Traefik is configured to listen for routing External Processor requests.
| `request_timeout`                 |       `500`      | The global timeout of the middleware in milliseconds. If the request/response cycle takes longer than this, the middleware will return and won't process the request.

## Development

To build the plugin locally, you can use the following command:

```bash
make
```

It will output the plugin binary `plugin.wasm`..

### Loading the local plugin

The plugin can be load locally by importing it in your `traefik.yml` file:

```yaml
experimental:
  localPlugins:
    plugin-external-processing:
      moduleName: "github.com/DataDog/traefik-external-processing"
```

The local plugin will be loaded from the path `./plugins-local/src/github.com/DataDog/traefik-external-processing`.