We'd like to add a metadata field to CDS and have it be accessible in Envoy through ClusterInfo and anywhere else general cluster info is available.
Signed-off-by: Matt Rice <mattrice@google.com>
Make it more discoverable and in prep for adding new content.
Also make the use of "Envoy" in top level titles consistent.
We don't need to say "Envoy" in general as all of the documentation
is about Envoy.
Signed-off-by: Matt Klein <mklein@lyft.com>
1) Do RDS other than rate limit. This is large enough will do that next.
2) Manually order top level in v2 with better titles
3) Random other fixes
Note also that I'm going to manually reorder the protos in some cases in a
follow up so the docs make a bit more sense for a casual reader.
Signed-off-by: Matt Klein <mklein@lyft.com>
This patch adds an overview page introduced the v2 API concepts via a
worked example. Brought in the entire transitive dep set of protos from
bootstrap.proto, none of these have been cleaned up beyond the minimum
required to have them build under Sphinx.
Also added the ability to link to the underlying proto in messages/enums
from protodoc.py generated RST.
Signed-off-by: Harvey Tuch <htuch@google.com>
I will defer RDS into another PR. I will also do another cleanup
pass over all of this later but want to get most of this in place
first.
Signed-off-by: Matt Klein <mklein@lyft.com>
As discussed and docced up here: envoyproxy/envoy#1980 (comment)
My one remaining concern with this approach is that the clusters all take a cluster config on start-up so they won't all get the benefits of primary/failover mechanics. It looks like static already doesn't get priorities so maybe it's meant to be a super simple start-up option but it seems like it still might benefit from the more advanced features.
For #1929
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
This PR just fixes enough stuff to get the HTTP connection manager filter
docs building. I want to get this out as it conflicts with other inflight
PRs and some of the work can be split up. E.g., access logging with that
in flight PR.
Signed-off-by: Matt Klein <mklein@lyft.com>
This should provide an example of how to do the .proto doc linking,
refactoring and constraint addition for the full API.
Signed-off-by: Harvey Tuch <htuch@google.com>
* [#not-implemented-hide:] will hide a message/enum/field from docs.
* [#not-implemented-warn:] will add a "Not implemented yet" warning to a
message/enum/field.
* [#v2-api-diff:<text>] will add a note indicating v2 API difference to
a message/enum/field.
* Switched title annotation to [#protodoc-title:<text>] for consistency.
Signed-off-by: Harvey Tuch <htuch@google.com>
alyssawilk
Matt Klein
Jose Ulises Nino Rivera
Daljeet Virdi
Matt Rice
Shriram Rajagopalan
Daniel Hochman
Kuat
moderation
htuch
Lita Cho
Mike Schore
Greg Greenway
Jonathan Oddy
jmillikin-stripe
Piotr Sikora
Whitney Jackson