Skip to content

Commit

Permalink
Document incremental xDS semantics about resources that do not exist. (
Browse files Browse the repository at this point in the history
…envoyproxy#9317)

Document incremental xDS semantics about resources that do not exist.
Risk Level: Low
Testing: N/A
Docs Changes: Included in PR
Release Notes: N/A

This attempts to clarify the incremental xDS protocol semantics, as per discussion in envoyproxy#7415

Signed-off-by: Mark D. Roth <roth@google.com>
  • Loading branch information
markdroth authored and htuch committed Dec 12, 2019
1 parent 1a6b970 commit fb89269
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions api/xds_protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,17 @@ names, which the server thought the client was already not subscribed
to. The server must cleanly process such a request; it can simply ignore
these phantom unsubscriptions.

Knowing When a Requested Resource Does Not Exist
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

When a resource subscribed to by a client does not exist, the server will send a :ref:`Resource
<envoy_api_msg_Resource>` whose :ref:`name <envoy_api_field_Resource.name>` field matches the
name that the client subscribed to and whose :ref:`resource <envoy_api_field_Resource.resource>`
field is unset. This allows the client to quickly determine when a resource does not exist without
waiting for a timeout, as would be done in the SotW protocol variants. However, clients are still
encouraged to use a timeout to protect against the case where the management server fails to send
a response in a timely manner.

REST-JSON polling subscriptions
-------------------------------

Expand Down

0 comments on commit fb89269

Please sign in to comment.