You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
23 lines
1.2 KiB
23 lines
1.2 KiB
# Data plane API |
|
|
|
This tree hosts the configuration and APIs that drive [Envoy](https://www.envoyproxy.io/). The |
|
APIs are also in some cases used by other proxy solutions that aim to interoperate with management |
|
systems and configuration generators that are built against this standard. Thus, we consider these a |
|
set of *universal data plane* APIs. See [this](https://medium.com/@mattklein123/the-universal-data-plane-api-d15cec7a) |
|
blog post for more information on the universal data plane concept. |
|
|
|
# Repository structure |
|
|
|
The API tree can be found at two locations: |
|
* https://github.com/envoyproxy/envoy/tree/main/api - canonical read/write home for the APIs. |
|
* https://github.com/envoyproxy/data-plane-api - read-only mirror of |
|
https://github.com/envoyproxy/envoy/tree/main/api, providing the ability to consume the data |
|
plane APIs without the Envoy implementation. |
|
|
|
# Further API reading |
|
|
|
* [API style guide](STYLE.md) |
|
* [API versioning guide](API_VERSIONING.md) |
|
* [API overview for users](https://www.envoyproxy.io/docs/envoy/latest/configuration/overview/overview) |
|
* [xDS protocol overview](https://www.envoyproxy.io/docs/envoy/latest/api-docs/xds_protocol) |
|
* [Contributing guide](CONTRIBUTING.md)
|
|
|