https://github.com/envoyproxy/data-plane-api

[READ ONLY MIRROR] Envoy REST/proto API definitions and documentation.
https://github.com/envoyproxy/data-plane-api

Last synced: about 2 months ago
JSON representation

[READ ONLY MIRROR] Envoy REST/proto API definitions and documentation.

• Host: GitHub
• URL: https://github.com/envoyproxy/data-plane-api
• Owner: envoyproxy
• License: apache-2.0
• Created: 2017-05-08T21:50:29.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T17:56:43.000Z (5 months ago)
• Last Synced: 2024-04-13T00:49:07.100Z (5 months ago)
• Language: Starlark
• Homepage: https://github.com/envoyproxy/envoy/tree/master/api
• Size: 7.05 MB
• Stars: 548
• Watchers: 41
• Forks: 267
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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)