TCP proxy

TCP proxy configuration overview.

  1. {
  2.   "name": "tcp_proxy",
  3.   "config": {
  4.     "stat_prefix": "...",
  5.     "route_config": "{...}",
  6.     "access_log": []
  7.   }
  8. }

route_config

(required, object) The route table for the filter. All filter instances must have a route table, even if it is empty.

stat_prefix

(required, string) The prefix to use when emitting statistics.

access_log

(optional, array) Configuration for access logs emitted by the this tcp_proxy.

Route Configuration

  1. {
  2.   "routes": []
  3. }

routes

(required, array) An array of route entries that make up the route table.

Route

A TCP proxy route consists of a set of optional L4 criteria and the name of a cluster. If a downstream connection matches all the specified criteria, the cluster in the route is used for the corresponding upstream connection. Routes are tried in the order specified until a match is found. If no match is found, the connection is closed. A route with no criteria is valid and always produces a match.

  1. {
  2.   "cluster": "...",
  3.   "destination_ip_list": [],
  4.   "destination_ports": "...",
  5.   "source_ip_list": [],
  6.   "source_ports": "..."
  7. }

cluster

(required, string) The cluster to connect to when a the downstream network connection matches the specified criteria.

destination_ip_list

(optional, array) An optional list of IP address subnets in the form “ip_address/xx”. The criteria is satisfied if the destination IP address of the downstream connection is contained in at least one of the specified subnets. If the parameter is not specified or the list is empty, the destination IP address is ignored. The destination IP address of the downstream connection might be different from the addresses on which the proxy is listening if the connection has been redirected. Example:

  1. [
  2.   "192.168.3.0/24",
  3.   "50.1.2.3/32",
  4.   "10.15.0.0/16",
  5.   "2001:abcd::/64"
  6. ]

destination_ports

(optional, string) An optional string containing a comma-separated list of port numbers or ranges. The criteria is satisfied if the destination port of the downstream connection is contained in at least one of the specified ranges. If the parameter is not specified, the destination port is ignored. The destination port address of the downstream connection might be different from the port on which the proxy is listening if the connection has been redirected. Example:

  1. {
  2.   "destination_ports": "1-1024,2048-4096,12345"
  3. }

source_ip_list

(optional, array) An optional list of IP address subnets in the form “ip_address/xx”. The criteria is satisfied if the source IP address of the downstream connection is contained in at least one of the specified subnets. If the parameter is not specified or the list is empty, the source IP address is ignored. Example:

  1. [
  2.   "192.168.3.0/24",
  3.   "50.1.2.3/32",
  4.   "10.15.0.0/16",
  5.   "2001:abcd::/64"
  6. ]

source_ports

(optional, string) An optional string containing a comma-separated list of port numbers or ranges. The criteria is satisfied if the source port of the downstream connection is contained in at least one of the specified ranges. If the parameter is not specified, the source port is ignored. Example:

  1. {
  2.   "source_ports": "1-1024,2048-4096,12345"
  3. }