-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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: move xds protocol to rst #6670
Conversation
Signed-off-by: Rama Chavali <rama.rao@salesforce.com>
Signed-off-by: Rama Chavali <rama.rao@salesforce.com>
Signed-off-by: Rama Chavali <rama.rao@salesforce.com>
Signed-off-by: Rama Chavali <rama.rao@salesforce.com>
@@ -13,3 +13,4 @@ Introduction | |||
getting_help | |||
version_history | |||
deprecated | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added this new line to be consistent with all other files
@mattklein123 @htuch PTAL |
/retest |
🔨 rebuilding |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ramaraochavali this is a nice improvement to the API docs situation. A few comments.
/wait
docs/root/index.rst
Outdated
@@ -19,4 +19,5 @@ Envoy documentation | |||
operations/operations | |||
extending/extending | |||
api-v2/api | |||
api-docs/xds_protocol |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should have a single top-level "API", and nested under this the xDS wire and API reference entries.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
api/xds_protocol.rst
Outdated
services and their corresponding APIs are referred to as *xDS*. | ||
Resources are requested via *subscriptions*, by specifying a filesystem | ||
path to watch, initiating gRPC streams or polling a REST-JSON URL. The | ||
latter two methods involve sending requests with a :ref:`Discovery Request <envoy_api_msg_DiscoveryRequest>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you add a space here between "Discovery" and "Request" (and "Response" below)? Ideally we keep the content exactly the same as the previous, no changes to things like naming etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was by mistake. I removed the spaces now
api/xds_protocol.rst
Outdated
|
||
In this sequence diagram, and below, the following format is used to abbreviate messages: | ||
|
||
- *DiscoveryRequest*: (V=`version_info`,R=`resource_names`,N=`response_nonce`,T=`type_url`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The backticks are visible in the rendered docs here.
api/xds_protocol.rst
Outdated
Each stream has its own notion of versioning, there is no shared | ||
versioning across resource types. When ADS is not used, even each | ||
resource of a given resource type may have a distinct version, since the | ||
Envoy API allows distinct EDS/RDS resources to point at different :ref:`Config Sources <envoy_api_msg_core.ConfigSource>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is another place a space has been inserted inside an identifier.
Signed-off-by: Rama Chavali <rama.rao@salesforce.com>
@htuch changed. PTAL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this is awesome.
* master: docs: add extension policy (envoyproxy#6678) ext_authz: added ability to detect partial request body data (envoyproxy#6583) version_history.rst: jwt_authn change missed 1.10.0 (envoyproxy#6684) docs: fix link in pull request template (envoyproxy#6679) Explicitly convert absl::string_view to std::string. (envoyproxy#6687) docs: improving watermark docs/comments (envoyproxy#6683) http filter: add CSRF filter (envoyproxy#6470) event: reintroduce dispatcher stats (envoyproxy#6659) security: postmortem for CVE-2019-990[01] (envoyproxy#6597) Improve build rules for (test only) library quic_port_utils. (envoyproxy#6672) spell check: skip unsupported extensions when called with a file (envoyproxy#6648) Changed TestHooks to ListenerHooks (envoyproxy#6642) proto: move extension-specific linking validation into extensions (envoyproxy#6657) stats: add/test heterogenous set of StatNameStorage objects. (envoyproxy#6504) docs: move xds protocol to rst (envoyproxy#6670) fix version history order (envoyproxy#6671) Signed-off-by: Michael Puncel <mpuncel@squareup.com>
@phylake the finished product is rendered at https://www.envoyproxy.io/docs/envoy/latest/api-docs/xds_protocol and the links look OK and work as expected. |
Description: This PR moves the xds protocol from md to rst.
Risk Level: Low
Testing: N/A
Docs Changes: N/A
Release Notes: N/A
Fixes #6338