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: Updated EXTENSION docs #13759

Merged
merged 1 commit into from
Oct 28, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions EXTENSION_POLICY.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ The following procedure will be used when proposing new extensions for inclusion
by other contributors.
5. Any new dependencies added for this extension must comply with
[DEPENDENCY_POLICY.md](DEPENDENCY_POLICY.md), please follow the steps detailed there.
6. If an extension depends on platform specific functionality, be sure to guard it in the build
system. See [platform specific features](./PULL_REQUESTS.md#platform-specific-features).
Add the extension to the necessary `*_SKIP_TARGETS` in [bazel/repositories.bzl](bazel/repositories.bzl)
and tag tests to be skipped/failed on the unsupported platform.

## Removing existing extensions

Expand Down Expand Up @@ -122,3 +126,14 @@ An assessment of a robust security posture for an extension is subject to the fo

The current stability and security posture of all extensions can be seen
[here](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/threat_model#core-and-extensions).

## Adding Extension Points

Envoy might lack the extension point necessary for an extension. In that
case we need to install an extension point, which can be done as follows:

1. Open a GitHub issue describing the proposed extension point and use cases.
2. Make changes in core Envoy for the extension point.
3. Update [extending envoy](docs/root/extending/extending.rst) to list the new
extension point and add any documentation explaining the extension point.
At the very least this should link to the corresponding proto.