Envoy-Pilot

Envoy Pilot or Envoy xDS is a control plane implementation for Envoy written in Golang and uses Consul for persistence.
Currently Supports
- CDS
- LDS
- RDS
- ADS (for the above)
Note: Some infrequent configurations might not be mapped. Feel free to PR
Checkout Envoy XDS PROTOCOL Overview for more detail
Usage
xDS Server will be exposed on port 7777
Run Envoy Proxy with the following configurations or use --service-node && --service-cluster
node:
id: TN
cluster: India
Every *DS requires two keys to be set in consul
And the key template is cluster/CLUSTER_NAME/node/NODE_NAME/DISCOVERY_TYPE/(config|version)
For CDS add KV pairs
cluster/India/node/TN/cluster/version => "1.0"
cluster/India/node/TN/cluster/config => "[{ { "name": "app1", "connect_timeout": "0.250s", "type": "STRICT_DNS", "lb_policy": "RANDOM", "hosts": [{ "socket_address": { "address": "127.0.0.2", "port_value": 1234 } }] } }]"
Pushing new configuration
- Envoy-Pilot will be polling for version change every 10 seconds.
- If there is a version mismatch for any of
cluster/India/node/TN/(cluster|listener|route)/version then new config cluster/India/node/TN/(cluster|listener|route)/config will be pushed to subscriber envoy.
- If update succeed there will be an ACK log for the instance.
Running Docker Compose
From root directory
docker network create envoy-pilot_xds-demo
docker-compose -f docker-compose.consul.yaml up
docker-compose -f docker-compose.server.yaml up --build
Runnnig Docker
Consul url need to be set in .env
docker run -v $(pwd)/env_values.txt:/.env -p 7777:7777 -p 9090:9090 tak2siva/envoy-pilot:latest
Helm Chart
Install using the Helm Chart for Envoy-Pilot.
Debugging
- xDS-Server is running on port 7777
- A http server is running on port 9090 for debugging
localhost:9090/dump/KEY_TEMPLATE will give a json dump of proto mapping
Ex:
http://localhost:9090/dump/cds/cluster/India/node/TN/cluster/config