docs: clarify xDS resource instance version semantics #12580
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Mark D. Roth <roth@google.com>
ggreenway
reviewed
Aug 10, 2020
ggreenway
reviewed
Aug 10, 2020
kyessenov
reviewed
Aug 10, 2020
| identifier. This holds true regardless of the acceptance of the discovery | ||
| responses on the same stream. The node identifier should always be identical if | ||
| present more than once on the stream. It is sufficient to only check the first | ||
| message for the node identifier as a result. |
There was a problem hiding this comment.
fyi: this is broken for runtime type, found by accident. I think we may need to enforce it better in envoy before making the spec strict.
There was a problem hiding this comment.
This paragraph is actually not new; I just moved it from where it was before. This is already part of the spec, so if something is breaking that requirement, I think it's unrelated to this PR. (But I agree that this should be fixed.)
Signed-off-by: Mark D. Roth <roth@google.com>
htuch
reviewed
Aug 10, 2020
| :ref:`DiscoveryRequest <envoy_api_msg_DiscoveryRequest>` from the client, specifying | ||
| the list of resources to subscribe to, the type URL corresponding to the | ||
| subscribed resources, the node identifier and an empty :ref:`version_info <envoy_api_field_DiscoveryRequest.version_info>`. | ||
| Every xDS resource type has a version string that indicates the version for that resource type. |
There was a problem hiding this comment.
Do you want to add that this "resource type version" is the "system version" in delta xDS?
Signed-off-by: Mark D. Roth <roth@google.com>
htuch
pushed a commit
that referenced
this pull request
Oct 22, 2020
Clarify that the server may not resend resources upon stream restart only if it has some way to know that the client is not subscribing to new resources that it wasn't previously subscribed to. Risk Level: Low Testing: N/A Docs Changes: Included in PR Clarifies text added in #12580. Signed-off-by: Mark D. Roth <roth@google.com>
chradcliffe
pushed a commit
to chradcliffe/envoy
that referenced
this pull request
Oct 23, 2020
) Clarify that the server may not resend resources upon stream restart only if it has some way to know that the client is not subscribing to new resources that it wasn't previously subscribed to. Risk Level: Low Testing: N/A Docs Changes: Included in PR Clarifies text added in envoyproxy#12580. Signed-off-by: Mark D. Roth <roth@google.com> Signed-off-by: Craig Radcliffe <craig.radcliffe@broadcom.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Mark D. Roth roth@google.com
Commit Message: docs: clarify xDS resource instance version semantics
Additional Description: Clarify that resource instance version can be reused across stream restarts. Also a few other small fixes and improvements.
Risk Level: Low
Testing: N/A
Docs Changes: Included in PR
Release Notes: N/A
CC @htuch @kyessenov