From d55c90085c23f4e454e76087ca5e7903d14a83c8 Mon Sep 17 00:00:00 2001 From: Harvey Tuch Date: Tue, 21 Apr 2020 11:01:16 -0400 Subject: [PATCH] api/faq: add entry on incremental xDS. Also remove some stale comments around delta xDS in ConfigSource. Fixes #10836 Signed-off-by: Harvey Tuch --- api/envoy/api/v2/core/config_source.proto | 4 ---- api/envoy/config/core/v3/config_source.proto | 4 ---- api/envoy/config/core/v4alpha/config_source.proto | 4 ---- docs/root/faq/api/incremental.rst | 11 +++++++++++ docs/root/faq/overview.rst | 5 +++-- .../envoy/api/v2/core/config_source.proto | 4 ---- .../envoy/config/core/v3/config_source.proto | 4 ---- .../envoy/config/core/v4alpha/config_source.proto | 4 ---- 8 files changed, 14 insertions(+), 26 deletions(-) create mode 100644 docs/root/faq/api/incremental.rst diff --git a/api/envoy/api/v2/core/config_source.proto b/api/envoy/api/v2/core/config_source.proto index fa42a7aeec1ce..8bbb961c1a329 100644 --- a/api/envoy/api/v2/core/config_source.proto +++ b/api/envoy/api/v2/core/config_source.proto @@ -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; } diff --git a/api/envoy/config/core/v3/config_source.proto b/api/envoy/config/core/v3/config_source.proto index b56e06e6de4fd..7337403bc8537 100644 --- a/api/envoy/config/core/v3/config_source.proto +++ b/api/envoy/config/core/v3/config_source.proto @@ -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; } diff --git a/api/envoy/config/core/v4alpha/config_source.proto b/api/envoy/config/core/v4alpha/config_source.proto index be600bd0096ed..253a576a46ed6 100644 --- a/api/envoy/config/core/v4alpha/config_source.proto +++ b/api/envoy/config/core/v4alpha/config_source.proto @@ -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; } diff --git a/docs/root/faq/api/incremental.rst b/docs/root/faq/api/incremental.rst new file mode 100644 index 0000000000000..e6d4d3f11bbee --- /dev/null +++ b/docs/root/faq/api/incremental.rst @@ -0,0 +1,11 @@ +What is the status of incremental xDS support? +============================================== + +The :ref:`incremental xDS ` 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 ` only. diff --git a/docs/root/faq/overview.rst b/docs/root/faq/overview.rst index e6f4eaa275e6a..b3d9de1932352 100644 --- a/docs/root/faq/overview.rst +++ b/docs/root/faq/overview.rst @@ -12,8 +12,8 @@ Build build/binaries build/boringssl -API versioning --------------- +API +--- .. toctree:: :maxdepth: 2 @@ -23,6 +23,7 @@ API versioning api/control_plane api/package_naming api/why_versioning + api/incremental Performance ----------- diff --git a/generated_api_shadow/envoy/api/v2/core/config_source.proto b/generated_api_shadow/envoy/api/v2/core/config_source.proto index fa42a7aeec1ce..8bbb961c1a329 100644 --- a/generated_api_shadow/envoy/api/v2/core/config_source.proto +++ b/generated_api_shadow/envoy/api/v2/core/config_source.proto @@ -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; } diff --git a/generated_api_shadow/envoy/config/core/v3/config_source.proto b/generated_api_shadow/envoy/config/core/v3/config_source.proto index 159542a3e909a..ce896e070ac76 100644 --- a/generated_api_shadow/envoy/config/core/v3/config_source.proto +++ b/generated_api_shadow/envoy/config/core/v3/config_source.proto @@ -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; } diff --git a/generated_api_shadow/envoy/config/core/v4alpha/config_source.proto b/generated_api_shadow/envoy/config/core/v4alpha/config_source.proto index 0cfc7fc59b94b..4f532f0898692 100644 --- a/generated_api_shadow/envoy/config/core/v4alpha/config_source.proto +++ b/generated_api_shadow/envoy/config/core/v4alpha/config_source.proto @@ -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; }