Skip to content

Commit

Permalink
clean docs
Browse files Browse the repository at this point in the history
  • Loading branch information
KSmigielski committed Nov 16, 2022
1 parent 8ba1a9d commit 3417e63
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 23 deletions.
4 changes: 1 addition & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,7 @@ Property
**envoy-control.envoy.snapshot.routes.status.endpoints** | List of endpoints with path or prefix of status routes | /status
**envoy-control.envoy.snapshot.routes.status.create-virtual-cluster** | Create virtual cluster for status route | false
**envoy-control.envoy.snapshot.state-sample-duration** | Duration of state sampling (this is used to prevent surges in consul events overloading control plane) | 1s
**envoy-control.envoy.snapshot.xds-cluster-name** | Name of cluster for xDS operations | envoy-control-xds
**envoy-control.envoy.snapshot.enabled-communication-modes.ads** | Enable or disable support for ADS communication mode | true
**envoy-control.envoy.snapshot.enabled-communication-modes.xds** | Enable or disable support for XDS communication mode | true
**envoy-control.envoy.snapshot.xds-cluster-name** | Name of cluster for xDS operations | envoy-control-xds | true
**envoy-control.envoy.snapshot.should-send-missing-endpoints** | Enable sending missing Endpoints - when Envoy requests for not existing cluster in snapshot control-plane will respond with empty Endpoint definition | false
**envoy-control.envoy.snapshot.cluster-name** | Dynamic forward proxy cluster name | dynamic_forward_proxy_cluster
**envoy-control.envoy.snapshot.dns-lookup-family** | DNS lookup address family | V4_ONLY
Expand Down
1 change: 0 additions & 1 deletion docs/features/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ An example configuration:

```yaml
metadata:
ads: true
proxy_settings:
outgoing:
dependencies:
Expand Down
10 changes: 0 additions & 10 deletions docs/integrations/envoy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,6 @@ and the IP can be put in `x-envoy-original-dst-host` header (`x-envoy-original-d
By default, Envoy will respond with `404` status code when it receives a request for a cluster that does not exist.
The behavior is changed so that the `503` status code is returned.

## ADS Support

By default, the xDS is used instead of
[Aggregated Discovery Service](https://www.envoyproxy.io/docs/envoy/latest/configuration/overview/xds_api#aggregated-discovery-service)
(ADS). To use ADS for given node put the
```
ads: true
```
in Envoy metadata config. Envoy Control will pick it up and use ADS for this node.

## Outlier detection

You can configure global
Expand Down
9 changes: 0 additions & 9 deletions docs/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,6 @@ Additionally, the network usage is significantly higher. With 1,000 clusters, we
Assuming that a new snapshot is generated every second. 1,000 Envoys with 1,000 clusters can generate a load of
300 MB/s. When following only a few services, the snapshot is about 5 KB and it's sent much less frequently.

### Use ADS

With xDS, Envoy set up a gRPC stream to Envoy Control per cluster. Let's say there are 1,000 Envoys and 1,000 clusters.
Envoy Control will have to handle 1,000,000 open gRPC streams. This puts pressure on memory, which converts to more
frequent GC runs and higher CPU usage.

With ADS, each Envoy sets up a single gRPC stream for all clusters. With 1,000 Envoys, there are 1,000 streams which
reduces memory usage dramatically.

### Sampling

Envoy Control by default follows changes from the discovery service, batches them and sends to Envoys at most once every second.
Expand Down

0 comments on commit 3417e63

Please sign in to comment.