Remove state of world reference #970
Conversation
Jake-Shadle
requested review from
markmandel,
XAMPPRocky and
koslib
as code owners
| * The proxy uses these resources to discover clusters and their endpoints. | ||
| * While cluster topology information like [locality] can be provided in the configuration, the proxy currently does not use this information (support may be included in the future however). | ||
| * Any [load balancing information][lbpolicy] included in this resource is ignored. For load balancing, use [Quilkin filters][filters-doc] instead. | ||
| * Only [cluster discovery type] `STATIC` and `EDS` is supported. Configuration including other discovery types e.g `LOGICAL_DNS` is rejected. | ||
| - The proxy uses these resources to discover clusters and their endpoints. | ||
| - While cluster topology information like [locality] can be provided in the configuration, the proxy currently does not use this information (support may be included in the future however). | ||
| - Any [load balancing information][lbpolicy] included in this resource is ignored. For load balancing, use [Quilkin filters][filters-doc] instead. | ||
| - Only [cluster discovery type] `STATIC` and `EDS` is supported. Configuration including other discovery types e.g `LOGICAL_DNS` is rejected. | ||
|
|
||
| - **Endpoint Discovery Service [(EDS)][EDS]**: Provides information about endpoints. | ||
| * The proxy uses these resources to discover information about endpoints like their IP addresses. | ||
| * Endpoints may provide [Endpoint Metadata][endpoint-metadata] via the [metadata][xds-endpoint-metadata] field. These metadata will be visible to filters as part of the corresponding endpoints information when processing packets. | ||
| * Only [socket addresses] are supported on an endpoint's address configuration - i.e an IP address and port number combination. Configuration including any other type of addressing e.g named pipes will be rejected. | ||
| * Any [load balancing information][clapolicy] included in this resource is ignored. For load balancing, use [Quilkin filters][filters-doc] instead. | ||
| - The proxy uses these resources to discover information about endpoints like their IP addresses. | ||
| - Endpoints may provide [Endpoint Metadata][endpoint-metadata] via the [metadata][xds-endpoint-metadata] field. These metadata will be visible to filters as part of the corresponding endpoints information when processing packets. | ||
| - Only [socket addresses] are supported on an endpoint's address configuration - i.e an IP address and port number combination. Configuration including any other type of addressing e.g named pipes will be rejected. | ||
| - Any [load balancing information][clapolicy] included in this resource is ignored. For load balancing, use [Quilkin filters][filters-doc] instead. |
There was a problem hiding this comment.
I don't think we use these types from envoy anymore, I think it would be good to include some info and a link to the types protobuf instead.
There was a problem hiding this comment.
The only other thing I found that might be worth playing with was https://github.com/matze/protoc-gen-mdbook - to generate docs from the proto files themselves.
Just an idea.
|
Build Succeeded 🥳 Build Id: 21cdc4dd-5dcf-42c5-9ca8-e802061b6e3d The following development images have been built, and will exist for the next 30 days: To build this version: |
|
I've been playing with |
Actually, I've got it working on the command line with straight protoc - lemme see if I can integrate it with |
|
I'm digging through the xDS code right now - happy to take a stab at these documentation changes in combo with #982, especially if you have other things on your plate, to round this work off. |
|
@markmandel that would be great 🙂 |
|
👍🏻 on it. |
|
Now we have #982 I think we can close this? |
See #964 (comment), this removes reference to sotw ADS which is no longer supported. The envoy naming for things is super confusing, I don't know if there is a better way to state this. Also removed 2 dead reference links that weren't used.