consul-envoy-service-mesh implements the envoy dataplane api, exposing configuration using xDS. This implementation exposes the following components:
Currently, this project exposes the ADS (aggregated discovery service) which allows all of these components to be aggregated as a single configuration.
Requirements:
- consul
- consul-envoy-service-mesh binary
- envoy
I will not go through the configuration of consul, you can get a container or download/install a binary, there are a number of good guides on this process available.
However, you will now need to determine a kv path in consul which you will use for all envoy configurations. This path will be actively watched by consul-envoy-service-mesh. Any changes made in this path while the application is running will cause proxies to reconfigure. Once running, I would highly recommend changes made to this path happen via atomic operations, otherwise multi-key changes will cause multiple configuration changes to occur.
Sample configuration:
"envoy/test_service" =>
{
"type":"service",
"name":"test_service",
"listeners": [
"test_listener"
]
}
"envoy/test_listener" =>
{
"type": "listener",
"name": "test_listener",
"tls": true,
"host": "0.0.0.0",
"port": 8443,
"health_check":{
"pass_through_mode": {"value": true},
"endpoint": "/status"
},
"prefix": "/",
"protocol": "http2",
"clusters": [
"test_cluster"
]
}
"envoy/test_cluster" =>
{
"type": "cluster",
"name": "test_cluster",
"tls": false,
"host": "127.0.0.1",
"port": 8080,
"domains": ["*"],
"prefix": "/",
"protocol": "http2",
"health_checks": [
{
"type": "http",
"timeout_ms": 1000,
"interval_ms": 1000,
"unhealthy_threshold": 5,
"healthy_threshold": 6,
"path": "/status"
}
]
}
If TLS is true above, the certs are assumed to be installed in /etc/envoy/ssl/ the files are envoy.pem and envoy.crt. This will be configurable in the future.
Available options are here:
The list of available options configurable will continue to grow. If you have requests, please create an issue, and they will be prioritized. Please submit PRs, it would be greatfully appreciated.
In the near future, I will provide a container and possibly a binary of this application, however today you will need to build and install the binary. Once completed you can run it with the default options like so:
~/.go/bin/consul-envoy-service-mesh
This will start the service on port 18000
Other options:
~/.go/bin/consul-envoy-service-mesh --help
Usage of /Users/gdurham/.go/bin/consul-envoy-service-mesh:
-alsologtostderr
log to standard error as well as files
-configPath string
consul kv path to configuration root (default "envoy/")
-consulDC string
consul datacenter (default "dc1")
-consulHost string
consul hostname/ip (default "127.0.0.1")
-consulPort uint
consul port (default 8500)
-http uint
Http server port (default 18080)
-log_backtrace_at value
when logging hits line file:N, emit a stack trace
-log_dir string
If non-empty, write log files in this directory
-logtostderr
log to standard error instead of files
-stderrthreshold value
logs at or above this threshold go to stderr
-v value
log level for V logs
-vmodule value
comma-separated list of pattern=N settings for file-filtered logging
-xds uint
xDS server port (default 18000)
Initial sample bootstrap configuration:
node:
id: test
cluster: test
dynamic_resources:
ads_config:
api_type: GRPC
cluster_name: [xds_cluster]
lds_config: {ads: {}}
cds_config: {ads: {}}
static_resources:
clusters:
- name: xds_cluster
connect_timeout: 0.25s
type: STATIC
lb_policy: ROUND_ROBIN
http2_protocol_options: {}
hosts: [{ socket_address: { address: 192.168.100.1, port_value: 18000 }}]
admin:
access_log_path: "/dev/null"
address:
socket_address:
address: 0.0.0.0
port_value: 9901
This configuration tells envoy to connect to a host at address 192.168.100.1 for all resources on port 18000. The node section is optionally configured via yaml or command line but MUST be set, see here for options.
Some code and other ideas came from: consul-envoy-xds
I welcome any assistance, cleanup, or tips. Thank you, and hopefully this is useful to others.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent