Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify xDS resource instance version semantics #12580

Merged
merged 3 commits into from
Aug 12, 2020

Conversation

markdroth
Copy link
Contributor

Signed-off-by: Mark D. Roth [email protected]

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

api/xds_protocol.rst Outdated Show resolved Hide resolved
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 <[email protected]>
: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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to add that this "resource type version" is the "system version" in delta xDS?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Member

@htuch htuch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@htuch htuch merged commit 2a4f7da into envoyproxy:master Aug 12, 2020
@markdroth markdroth deleted the xds_resource_version_semantics branch August 12, 2020 14:22
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 <[email protected]>
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 <[email protected]>
Signed-off-by: Craig Radcliffe <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants