docs: Unexclude remaining configs from validation #13534

phlax · 2020-10-13T09:11:43Z

Signed-off-by: Ryan Northey ryan@synca.io

Commit Message: docs: Unexclude remaining configs from validation
Additional Description:

some configs in docs were initially excluded from validation (in #13387) - this PR will remove the exclusions where possible

Risk Level:
Testing:
Docs Changes:
Release Notes:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Deprecated:]

phlax · 2020-10-14T08:44:13Z

/retest

repokitteh-read-only · 2020-10-14T08:44:17Z

Retrying Azure Pipelines, to retry CircleCI checks, use /retest-circle.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #13534 (comment) was created by @phlax.

see: more, trace.

phlax · 2020-10-14T09:58:15Z

/retest

repokitteh-read-only · 2020-10-14T09:58:18Z

Retrying Azure Pipelines, to retry CircleCI checks, use /retest-circle.
Cannot retry non-completed check: envoy-presubmit (Windows), please wait.

🐱

Caused by: a #13534 (comment) was created by @phlax.

see: more, trace.

phlax · 2020-10-14T12:14:45Z

/retest

repokitteh-read-only · 2020-10-14T12:14:49Z

Retrying Azure Pipelines, to retry CircleCI checks, use /retest-circle.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #13534 (comment) was created by @phlax.

see: more, trace.

docs/root/intro/arch_overview/security/_include/ssl.yaml

phlax · 2020-10-14T20:05:12Z

docs/BUILD

 filegroup(
    name = "configs",
    srcs = glob(
        ["root/**/*.yaml"],
        exclude = [
+            # `some.customer.filter`
            "root/intro/_include/life-of-a-request.yaml",


i guess its not trivial to add some.customer.filter - wondering how we can keep this config valid

I think we can just use a real filter? @htuch?

any suggestions on which filter to use would be great

i think we are going to need to look at the docs related to these configs to see what effect these changes have

i have commented out the some.customer.filter example from the filter chain - as i think it still serves its purpose being present but commented out - open to suggestions

I would prefer it to be included, since it's designed to capture what happens when you add a customer filter and is referenced extensively in the text (as "CustomerFilter"). I wonder if we can somehow augment envoy/tools/type_whisperer/all_protos_with_ext_pb_text.pb_text to reflect some dummy config.

docs/BUILD

phlax · 2020-10-14T20:06:39Z

docs/BUILD

            "root/intro/arch_overview/security/_include/ssl.yaml",
-            "root/configuration/http/http_filters/_include/dns-cache-circuit-breaker.yaml",
-            "root/configuration/http/http_filters/_include/grpc-reverse-bridge-filter.yaml",
+            # missing proto.pb


im wondering if/how we can include this proto.pb file into the test bundle

I think this can be a bazel file dep? cc @htuch @lizan

Yep I guess this need to be part of artifact, or bazelify whole of example test (which is out of scope of this PR)

this should be fixed. i generated a .pb file and added to bazel build etc

i have also updated the docs, as the required steps were not very clear, and the examples were a bit inconsistent

configs/configgen.sh

mattklein123

Thanks for working on this. This is so great. A few comments.

/wait

mattklein123 · 2020-10-14T21:32:22Z

docs/BUILD

 filegroup(
    name = "configs",
    srcs = glob(
        ["root/**/*.yaml"],
        exclude = [
+            # `some.customer.filter`
            "root/intro/_include/life-of-a-request.yaml",


I think we can just use a real filter? @htuch?

docs/BUILD

mattklein123 · 2020-10-14T22:20:50Z

docs/BUILD

            "root/intro/arch_overview/security/_include/ssl.yaml",
-            "root/configuration/http/http_filters/_include/dns-cache-circuit-breaker.yaml",
-            "root/configuration/http/http_filters/_include/grpc-reverse-bridge-filter.yaml",
+            # missing proto.pb


I think this can be a bazel file dep? cc @htuch @lizan

phlax · 2020-10-15T13:10:54Z

to accomodate changes to the example configs, i made some changes to the grpc-transcoder page - which can be seen here

https://storage.googleapis.com/envoy-pr/13534/docs/configuration/http/http_filters/grpc_json_transcoder_filter.html

also the ssl page is affected so worth checking over:

https://storage.googleapis.com/envoy-pr/13534/docs/intro/arch_overview/security/ssl.html

phlax · 2020-10-15T14:01:58Z

and the life of a request page

https://storage.googleapis.com/envoy-pr/13534/docs/intro/life_of_a_request.html

Signed-off-by: Ryan Northey <ryan@synca.io>

mattklein123

Amazing. Thank you! LMK if you want to merge this and iterate or keep trying to fix stuff.

docs/BUILD

phlax · 2020-10-15T15:32:44Z

ill add the todo - but then should be ready to land i think

Signed-off-by: Ryan Northey <ryan@synca.io>

mattklein123

Thanks!

phlax · 2020-10-15T17:29:48Z

/retest

repokitteh-read-only · 2020-10-15T17:29:53Z

Retrying Azure Pipelines, to retry CircleCI checks, use /retest-circle.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #13534 (comment) was created by @phlax.

see: more, trace.

sunjayBhatia · 2020-10-15T17:48:43Z

docs/BUILD

        exclude = [
-            "root/intro/_include/life-of-a-request.yaml",
+            # TODO(phlax/windows-dev): figure out how to get this working on windows
+            #      "Error: unable to read file: /etc/ssl/certs/ca-certificates.crt"


I'll open an issue for this, it could dovetail with the idea of Envoy tapping into the trusted system cert pool as well potentially?

@phlax feel free to chime in with any more details or ideas: #13596

cool, will do

mattklein123 · 2020-10-15T22:36:59Z

Merge main once #13598 merges. Thanks!

/wait

lizan · 2020-10-15T23:45:30Z

/retest

repokitteh-read-only · 2020-10-15T23:45:35Z

Retrying Azure Pipelines, to retry CircleCI checks, use /retest-circle.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #13534 (comment) was created by @lizan.

see: more, trace.

* master: (22 commits) delay health checks until transport socket secrets are ready. (envoyproxy#13516) test, oauth2: Make sure config test runs field validation (envoyproxy#13496) [http] swap codec implementations to default new (envoyproxy#13579) wasm: update proxy-wasm-cpp-host (envoyproxy#13606) postgres: do not copy and linearize received data when it is not going to be used (envoyproxy#13393) configs: Update configs v2 -> v3 (envoyproxy#13562) http2: Remove RELEASE_ASSERTs in sendPendingFrames() error handling (envoyproxy#13546) dependencies: track untracked implied dependencies, wrapup dashboard. (envoyproxy#13571) listener: add match all filter chain (envoyproxy#13449) fix mistakes in docstrings (envoyproxy#13603) ratelimit: add route entry metadata to ratelimit actions (envoyproxy#13269) cluster manager: avoid immediate activation for dynamic inserted cluster when initialize (envoyproxy#12783) ext_authz: Avoid calling check multiple times (envoyproxy#13288) docs: Unexclude remaining configs from validation (envoyproxy#13534) build: update rules_rust to allow Rustc in RBE (envoyproxy#13595) docs: Update sphinxext.rediraffe (envoyproxy#13589) Deprecate moonjit support on Windows before beta (envoyproxy#13541) dependencies: bump LuaJIT to 2.1 branch HEAD @ e9af1ab. (envoyproxy#13474) docs: add TLS stats to cluster stats doc (envoyproxy#13561) ci: stop building alpine-debug images in favor of ubuntu-based debug image (envoyproxy#13598) ... Signed-off-by: Michael Puncel <mpuncel@squareup.com>

phlax changed the title ~~docs: Unexclude remaining configs from validation~~ [WIP] docs: Unexclude remaining configs from validation Oct 13, 2020

phlax marked this pull request as draft October 13, 2020 10:43

mattklein123 self-assigned this Oct 13, 2020

mattklein123 added the waiting label Oct 13, 2020

repokitteh-read-only bot removed the waiting label Oct 14, 2020

phlax commented Oct 14, 2020

View reviewed changes

docs/root/intro/arch_overview/security/_include/ssl.yaml Outdated Show resolved Hide resolved

mattklein123 added the waiting label Oct 14, 2020

repokitteh-read-only bot removed the waiting label Oct 14, 2020

phlax force-pushed the docs-unexclude-config-validations branch 2 times, most recently from b829a1c to f7f90aa Compare October 14, 2020 18:40

phlax commented Oct 14, 2020

View reviewed changes

docs/BUILD Outdated Show resolved Hide resolved

phlax commented Oct 14, 2020

View reviewed changes

configs/configgen.sh Show resolved Hide resolved

phlax changed the title ~~[WIP] docs: Unexclude remaining configs from validation~~ docs: Unexclude remaining configs from validation Oct 14, 2020

phlax marked this pull request as ready for review October 14, 2020 20:30

mattklein123 requested changes Oct 14, 2020

View reviewed changes

repokitteh-read-only bot added waiting and removed waiting labels Oct 14, 2020

phlax force-pushed the docs-unexclude-config-validations branch from 138824b to 78ec197 Compare October 15, 2020 10:34

phlax added 2 commits October 15, 2020 16:21

docs: Unexclude remaining configs from validation

66c0d93

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

9846e6f

Signed-off-by: Ryan Northey <ryan@synca.io>

phlax added 10 commits October 15, 2020 16:21

docs/

2a0c622

Signed-off-by: Ryan Northey <ryan@synca.io>

add helloworld.pb to config test bundle

f2d49bb

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

0524b2f

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

fc143ef

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

84a59c4

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

e3bed9d

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

efc4d19

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

0486e4d

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

1578721

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

ce06ed6

Signed-off-by: Ryan Northey <ryan@synca.io>

phlax force-pushed the docs-unexclude-config-validations branch from 4ec9292 to ce06ed6 Compare October 15, 2020 15:23

mattklein123 previously approved these changes Oct 15, 2020

View reviewed changes

docs/BUILD Outdated Show resolved Hide resolved

add todo

a4a5a1d

Signed-off-by: Ryan Northey <ryan@synca.io>

phlax dismissed mattklein123’s stale review via a4a5a1d October 15, 2020 15:34

todo

338dd2f

Signed-off-by: Ryan Northey <ryan@synca.io>

mattklein123 approved these changes Oct 15, 2020

View reviewed changes

sunjayBhatia reviewed Oct 15, 2020

View reviewed changes

sunjayBhatia mentioned this pull request Oct 15, 2020

Docs/examples that use Linux-specific system CA bundle path fail on Windows #13596

Closed

repokitteh-read-only bot added the waiting label Oct 15, 2020

lizan removed the waiting label Oct 15, 2020

lizan merged commit 7b62e16 into envoyproxy:master Oct 16, 2020

phlax mentioned this pull request Oct 21, 2020

2020/10/21 phlax/cncf-progress#3

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Unexclude remaining configs from validation #13534

docs: Unexclude remaining configs from validation #13534

phlax commented Oct 13, 2020

phlax commented Oct 14, 2020

repokitteh-read-only bot commented Oct 14, 2020

phlax commented Oct 14, 2020

repokitteh-read-only bot commented Oct 14, 2020

phlax commented Oct 14, 2020

repokitteh-read-only bot commented Oct 14, 2020

phlax Oct 14, 2020

mattklein123 Oct 14, 2020

phlax Oct 15, 2020

phlax Oct 15, 2020

htuch Oct 16, 2020

phlax Oct 14, 2020

mattklein123 Oct 14, 2020

lizan Oct 15, 2020

phlax Oct 15, 2020

mattklein123 left a comment

mattklein123 Oct 14, 2020

mattklein123 Oct 14, 2020

phlax commented Oct 15, 2020

phlax commented Oct 15, 2020

mattklein123 left a comment

phlax commented Oct 15, 2020

mattklein123 left a comment

phlax commented Oct 15, 2020

repokitteh-read-only bot commented Oct 15, 2020

sunjayBhatia Oct 15, 2020

sunjayBhatia Oct 15, 2020

phlax Oct 15, 2020

mattklein123 commented Oct 15, 2020

lizan commented Oct 15, 2020

repokitteh-read-only bot commented Oct 15, 2020

docs: Unexclude remaining configs from validation #13534

docs: Unexclude remaining configs from validation #13534

Conversation

phlax commented Oct 13, 2020

phlax commented Oct 14, 2020

repokitteh-read-only bot commented Oct 14, 2020

phlax commented Oct 14, 2020

repokitteh-read-only bot commented Oct 14, 2020

phlax commented Oct 14, 2020

repokitteh-read-only bot commented Oct 14, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattklein123 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phlax commented Oct 15, 2020

phlax commented Oct 15, 2020

mattklein123 left a comment

Choose a reason for hiding this comment

phlax commented Oct 15, 2020

mattklein123 left a comment

Choose a reason for hiding this comment

phlax commented Oct 15, 2020

repokitteh-read-only bot commented Oct 15, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattklein123 commented Oct 15, 2020

lizan commented Oct 15, 2020

repokitteh-read-only bot commented Oct 15, 2020