Forward Proxy Advanced Configuration Examples

Configuration Examples

Enable on a service

Enable on a route

Enable on a consumer

Enable globally

The following examples provide some typical configurations for enabling the forward-proxy plugin on a service.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
    --data "name=forward-proxy"  \
    --data "config.http_proxy_host=example.com"  \
    --data "config.http_proxy_port=80"  \
    --data "config.proxy_scheme=http"  \
    --data "config.auth_username=example_user"  \
    --data "config.auth_password=example_pass"  \
    --data "config.https_verify=false"  \
    --data "config.x_headers=transparent"

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: forward-proxy-example
plugin: forward-proxy
config:
  http_proxy_host: example.com
  http_proxy_port: 80
  proxy_scheme: http
  auth_username: example_user
  auth_password: example_pass
  https_verify: false
  x_headers: transparent
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the service as follows:

kubectl annotate service SERVICE_NAME konghq.com/plugins=forward-proxy-example

Replace SERVICE_NAME with the name of the service that this plugin configuration will target. You can see your available ingresses by running kubectl get service.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: forward-proxy
  service: SERVICE_NAME|SERVICE_ID
  config:
    http_proxy_host: example.com
    http_proxy_port: 80
    proxy_scheme: http
    auth_username: example_user
    auth_password: example_pass
    https_verify: false
    x_headers: transparent

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

The following examples provide some typical configurations for enabling the forward-proxy plugin on a route.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
    --data "name=forward-proxy"  \
    --data "config.http_proxy_host=example.com"  \
    --data "config.http_proxy_port=80"  \
    --data "config.proxy_scheme=http"  \
    --data "config.auth_username=example_user"  \
    --data "config.auth_password=example_pass"  \
    --data "config.https_verify=false"  \
    --data "config.x_headers=transparent"

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: forward-proxy-example
plugin: forward-proxy
config:
  http_proxy_host: example.com
  http_proxy_port: 80
  proxy_scheme: http
  auth_username: example_user
  auth_password: example_pass
  https_verify: false
  x_headers: transparent
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the ingress as follows:

kubectl annotate ingress INGRESS_NAME konghq.com/plugins=forward-proxy-example

Replace INGRESS_NAME with the name of the ingress that this plugin configuration will target. You can see your available ingresses by running kubectl get ingress.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: forward-proxy
  route: ROUTE_NAME|ROUTE_ID
  config:
    http_proxy_host: example.com
    http_proxy_port: 80
    proxy_scheme: http
    auth_username: example_user
    auth_password: example_pass
    https_verify: false
    x_headers: transparent

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

The following examples provide some typical configurations for enabling the forward-proxy plugin on a consumer.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/consumers/CONSUMER_NAME|CONSUMER_ID/plugins \
    --data "name=forward-proxy"  \
    --data "config.http_proxy_host=example.com"  \
    --data "config.http_proxy_port=80"  \
    --data "config.proxy_scheme=http"  \
    --data "config.auth_username=example_user"  \
    --data "config.auth_password=example_pass"  \
    --data "config.https_verify=false"  \
    --data "config.x_headers=transparent"

Replace CONSUMER_NAME|CONSUMER_ID with the id or name of the consumer that this plugin configuration will target.

in the same request, to further narrow the scope of the plugin.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: forward-proxy-example
plugin: forward-proxy
config:
  http_proxy_host: example.com
  http_proxy_port: 80
  proxy_scheme: http
  auth_username: example_user
  auth_password: example_pass
  https_verify: false
  x_headers: transparent
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the KongConsumer object as follows:

kubectl annotate KongConsumer CONSUMER_NAME konghq.com/plugins=forward-proxy-example

Replace CONSUMER_NAME with the name of the consumer that this plugin configuration will target. You can see your available consumers by running kubectl get KongConsumer.

To learn more about KongConsumer objects, see Provisioning Consumers and Credentials .

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: forward-proxy
  consumer: CONSUMER_NAME|CONSUMER_ID
  config:
    http_proxy_host: example.com
    http_proxy_port: 80
    proxy_scheme: http
    auth_username: example_user
    auth_password: example_pass
    https_verify: false
    x_headers: transparent

Replace CONSUMER_NAME|CONSUMER_ID with the id or name of the consumer that this plugin configuration will target.

A plugin which is not associated to any service, route, or consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

The following examples provide some typical configurations for enabling the Forward Proxy Advanced plugin globally.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
    --data "name=forward-proxy"  \
    --data "config.http_proxy_host=example.com"  \
    --data "config.http_proxy_port=80"  \
    --data "config.proxy_scheme=http"  \
    --data "config.auth_username=example_user"  \
    --data "config.auth_password=example_pass"  \
    --data "config.https_verify=false"  \
    --data "config.x_headers=transparent"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-forward-proxy>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: "true"
config:
  http_proxy_host: example.com
  http_proxy_port: 80
  proxy_scheme: http
  auth_username: example_user
  auth_password: example_pass
  https_verify: false
  x_headers: transparent
plugin: forward-proxy

Add a plugins entry in the declarative configuration file:

plugins:
- name: forward-proxy
  config:
    http_proxy_host: example.com
    http_proxy_port: 80
    proxy_scheme: http
    auth_username: example_user
    auth_password: example_pass
    https_verify: false
    x_headers: transparent

Previous Forward Proxy Advanced Configuration

Next Forward Proxy Advanced Changelog