docs: updating docs with explicit v1 callouts #4728
Conversation
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
alyssawilk
force-pushed
the
convert_docs
branch
from
36494d1 to
866ac5b
Compare
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
| {"binary": "000000000000f03f"}, | ||
| {"binary": "00"} | ||
| {"text": "39000000"}, | ||
| {"text": "EEEEEEEE"}, |
There was a problem hiding this comment.
How come you removed the full example?
There was a problem hiding this comment.
full example was binary, and binary is hidden in v2 API. I figured it wasn't really relevant without base64 converting which I didn't want to bother with.
There was a problem hiding this comment.
As mentioned below, I think we need to consistently move to YAML. Also, I think this example is wrong for v2, see https://github.com/envoyproxy/envoy/blob/master/api/envoy/api/v2/core/health_check.proto#L118. send is now a single Payload.
| {"binary": "00000000000000f03f"}, | ||
| {"binary": "00"} | ||
| {"text": "EEEEEEEE"}, | ||
| {"text": "01000000"}, |
There was a problem hiding this comment.
Partially because this is a config snippet, partially because I'm trying to do the minimal work to remove the deprecated docs
| in the route configuration determines the probability of selecting a | ||
| particular route (and hence its cluster). By using the runtime | ||
| particular route (and hence its cluster). By using the runtime_fraction |
| .. code-block:: yaml | ||
|
|
||
| virtual_hosts: | ||
| - name: "www2" |
| .. code-block:: yaml | ||
|
|
||
| actions: | ||
| - {source_cluster: {}} |
There was a problem hiding this comment.
This looks pretty strange YAML; did you validate?
There was a problem hiding this comment.
so if I tweak the rate limit test to dump MessageUtil::getJsonStringFromMessage( on a tweaked rate limit proto, I get
{
"disable_key": "",
"actions": [
{
"source_cluster": {}
},
{
"remote_address": {}
},
{
"generic_key": {
"descriptor_value": "some_value"
}
}
]
}
which tossed into the first hit yaml converter online gets me this, which tossed into the first yaml validator online, thinks it's valid, but suggests
actions:
source_cluster: {}
- generic_key:
descriptor_value: some_value
I could switch to this, or I could fall back to json?
There was a problem hiding this comment.
We need to use YAML in all examples as this is the official textual representation of proto in Envoy.
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
Part of removing v1 docs. Risk Level: low (risk of bad docs) Testing: n/a Docs Changes: yep Release Notes: nope Part of envoyproxy#4617 Signed-off-by: Alyssa Wilk <alyssar@chromium.org> Signed-off-by: Yang Song <yasong@yasong00.cam.corp.google.com>
Part of removing v1 docs.
Risk Level: low (risk of bad docs)
Testing: n/a
Docs Changes: yep
Release Notes: nope
Part of #4617