Skip to content

Commit

Permalink
api/faq: add entry on incremental xDS. (envoyproxy#10876)
Browse files Browse the repository at this point in the history
Also remove some stale comments around delta xDS in ConfigSource.

Fixes envoyproxy#10836

Signed-off-by: Harvey Tuch <htuch@google.com>
Signed-off-by: pengg <pengg@google.com>
  • Loading branch information
htuch authored and penguingao committed Apr 22, 2020
1 parent bac607e commit 935e74e
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 26 deletions.
4 changes: 0 additions & 4 deletions api/envoy/api/v2/core/config_source.proto
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,6 @@ message ApiConfigSource {
// Using the delta xDS gRPC service, i.e. DeltaDiscovery{Request,Response}
// rather than Discovery{Request,Response}. Rather than sending Envoy the entire state
// with every update, the xDS server only sends what has changed since the last update.
//
// DELTA_GRPC is not yet entirely implemented! Initially, only CDS is available.
// Do not use for other xDSes.
// [#comment:TODO(fredlas) update/remove this warning when appropriate.]
DELTA_GRPC = 3;
}

Expand Down
4 changes: 0 additions & 4 deletions api/envoy/config/core/v3/config_source.proto
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,6 @@ message ApiConfigSource {
// Using the delta xDS gRPC service, i.e. DeltaDiscovery{Request,Response}
// rather than Discovery{Request,Response}. Rather than sending Envoy the entire state
// with every update, the xDS server only sends what has changed since the last update.
//
// DELTA_GRPC is not yet entirely implemented! Initially, only CDS is available.
// Do not use for other xDSes.
// [#comment:TODO(fredlas) update/remove this warning when appropriate.]
DELTA_GRPC = 3;
}

Expand Down
4 changes: 0 additions & 4 deletions api/envoy/config/core/v4alpha/config_source.proto
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,6 @@ message ApiConfigSource {
// Using the delta xDS gRPC service, i.e. DeltaDiscovery{Request,Response}
// rather than Discovery{Request,Response}. Rather than sending Envoy the entire state
// with every update, the xDS server only sends what has changed since the last update.
//
// DELTA_GRPC is not yet entirely implemented! Initially, only CDS is available.
// Do not use for other xDSes.
// [#comment:TODO(fredlas) update/remove this warning when appropriate.]
DELTA_GRPC = 3;
}

Expand Down
11 changes: 11 additions & 0 deletions docs/root/faq/api/incremental.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
What is the status of incremental xDS support?
==============================================

The :ref:`incremental xDS <xds_protocol_delta>` protocol is designed to improve efficiency,
scalability and functional use of xDS updates via two mechanisms:

* Delta xDS. Resource deltas are delivered rather than state-of-the-world.
* On-demand xDS. Resource can be lazy loaded depending on request contents.

Currently, all xDS protocols (including ADS) support delta xDS. On-demand xDS is supported for
:ref:`VHDS <config_http_conn_man_vhds>` only.
5 changes: 3 additions & 2 deletions docs/root/faq/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Build
build/binaries
build/boringssl

API versioning
--------------
API
---
.. toctree::
:maxdepth: 2

Expand All @@ -23,6 +23,7 @@ API versioning
api/control_plane
api/package_naming
api/why_versioning
api/incremental

Performance
-----------
Expand Down
4 changes: 0 additions & 4 deletions generated_api_shadow/envoy/api/v2/core/config_source.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 0 additions & 4 deletions generated_api_shadow/envoy/config/core/v3/config_source.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 935e74e

Please sign in to comment.