From ec585693a3808d120cc4de1555cb4c2f4fee8012 Mon Sep 17 00:00:00 2001 From: danehans Date: Mon, 3 Oct 2022 17:42:07 -0700 Subject: [PATCH 1/2] Adds Roadmap Doc Signed-off-by: danehans --- README.md | 1 + docs/design/ROADMAP.md | 56 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 docs/design/ROADMAP.md diff --git a/README.md b/README.md index 3db47db942..cc9ecb1378 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Kubernetes-based application gateway. * [Blog][blog] introducing Envoy Gateway. * [Goals](GOALS.md) * [Quickstart](./docs/user/QUICKSTART.md) to use Envoy Gateway in a few simple steps. +* [Roadmap](./docs/design/ROADMAP.md) ## Contact diff --git a/docs/design/ROADMAP.md b/docs/design/ROADMAP.md new file mode 100644 index 0000000000..2a58c7910f --- /dev/null +++ b/docs/design/ROADMAP.md @@ -0,0 +1,56 @@ +## Introduction + +This document serves as a high-level reference for Envoy Gateway users and contributors to understand the direction of +the project. + +## Contributing to the Roadmap + +- To propose a roadmap item, create an [issue][issue] or join a [community meeting][meeting] to discuss your desired + feature. Update this document if your requested feature is accepted for a particular [milestone][milestones]. +- To help with an existing roadmap item, comment on the associated issue. If an item doesn't have an issue, create one + and open a [pull request][PR] linking the issue to an exiting roadmap item. +- Submit a [pull request][PR] to add a feature to the roadmap. __Note:__ The feature should be discussed in an issue or + a community meeting before implementing the feature. + +If you don't know where to start contributing, help is needed to reduce technical, automation, and documentation debt. +Look for issues with the `help wanted` label to get started. + +## Roadmap +Roadmap features and timelines may change based on feedback, community contributions, etc. If you depend on a specific +roadmap item, you're encouraged to attend a community meeting to discuss the details, or help us deliver the feature by +contributing to the project. + +`Last Updated: October 2022` + +### [v0.2.0][v0.2.0]: Establish a Solid Foundation +- Complete the core Envoy Gateway implementation- [Issue #60][60]. +- Establish initial testing, e2e, integration, etc- [Issue #64][64]. +- Establish user and developer project documentation- [Issue #17][17]. +- Achieve Gateway API conformance (e.g. routing, LB, Header transformation, etc.)- [Issue #65][65]. +- Setup a CI/CD pipeline- [Issue #63][63]. + +### [v0.3.0][v0.3.0]: Drive Advanced Features through Extension Mechanisms +- Global Rate Limiting +- AuthN/AuthZ- [Issue #336][336]. +- Lets Encrypt Integration + +### [v0.4.0][v0.4.0]: Manageability and Scale +- Tooling for devs/infra admins to aid in managing/maintaining EG +- Support advanced provisioning use cases (e.g. multi-cluster, serverless, etc.) +- Perf testing (EG specifically) +- Support for Chaos engineering? + +[eg_board]: https://github.com/orgs/envoyproxy/projects/1/views/1?layout=board +[issue]: https://github.com/envoyproxy/gateway/issues +[meeting]: https://docs.google.com/document/d/1leqwsHX8N-XxNEyTflYjRur462ukFxd19Rnk3Uzy55I/edit?usp=sharing +[pr]: https://github.com/envoyproxy/gateway/compare +[milestones]: https://github.com/envoyproxy/gateway/milestones +[v0.2.0]: https://github.com/envoyproxy/gateway/milestone/1 +[v0.3.0]: https://github.com/envoyproxy/gateway/milestone/9 +[v0.4.0]: https://github.com/envoyproxy/gateway/milestone/10 +[60]: https://github.com/envoyproxy/gateway/issues/60 +[64]: https://github.com/envoyproxy/gateway/issues/64 +[17]: https://github.com/envoyproxy/gateway/issues/17 +[65]: https://github.com/envoyproxy/gateway/issues/65 +[63]: https://github.com/envoyproxy/gateway/issues/63 +[336]: https://github.com/envoyproxy/gateway/issues/336 From fa67efed103720a2144c6301071e008323e32fb8 Mon Sep 17 00:00:00 2001 From: danehans Date: Tue, 4 Oct 2022 13:46:55 -0700 Subject: [PATCH 2/2] Resolves @arko 10-4-22 Feedback Signed-off-by: danehans --- docs/design/ROADMAP.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/design/ROADMAP.md b/docs/design/ROADMAP.md index 2a58c7910f..1d5d942d83 100644 --- a/docs/design/ROADMAP.md +++ b/docs/design/ROADMAP.md @@ -5,12 +5,13 @@ the project. ## Contributing to the Roadmap -- To propose a roadmap item, create an [issue][issue] or join a [community meeting][meeting] to discuss your desired - feature. Update this document if your requested feature is accepted for a particular [milestone][milestones]. -- To help with an existing roadmap item, comment on the associated issue. If an item doesn't have an issue, create one - and open a [pull request][PR] linking the issue to an exiting roadmap item. -- Submit a [pull request][PR] to add a feature to the roadmap. __Note:__ The feature should be discussed in an issue or - a community meeting before implementing the feature. +- To add a feature to the roadmap, create an [issue][issue] or join a [community meeting][meeting] to discuss your use + case. If your feature is accepted, a maintainer will assign your issue to a [release milestone][milestones] and update + this document accordingly. +- To help with an existing roadmap item, comment on or assign yourself to the associated issue. +- If a roadmap item doesn't have an issue, create one, assign yourself to the issue, and reference this document. A + maintainer will submit a [pull request][PR] to add the feature to the roadmap. __Note:__ The feature should be + discussed in an issue or a community meeting before implementing it. If you don't know where to start contributing, help is needed to reduce technical, automation, and documentation debt. Look for issues with the `help wanted` label to get started. @@ -46,8 +47,8 @@ contributing to the project. [pr]: https://github.com/envoyproxy/gateway/compare [milestones]: https://github.com/envoyproxy/gateway/milestones [v0.2.0]: https://github.com/envoyproxy/gateway/milestone/1 -[v0.3.0]: https://github.com/envoyproxy/gateway/milestone/9 -[v0.4.0]: https://github.com/envoyproxy/gateway/milestone/10 +[v0.3.0]: https://github.com/envoyproxy/gateway/milestone/7 +[v0.4.0]: https://github.com/envoyproxy/gateway/milestone/12 [60]: https://github.com/envoyproxy/gateway/issues/60 [64]: https://github.com/envoyproxy/gateway/issues/64 [17]: https://github.com/envoyproxy/gateway/issues/17