docs: Update the Traffic tapping configuration

[haiyuewa]

The option 'envoy.config.tap.v3.TapConfig.match_config' has been marked deprecated by the commit 520389e ("tap: factor out the TAP filter matcher for later reuse in other filters (#12429)").

Update the option to 'envoy.config.tap.v3.TapConfig.match'.

[repokitteh-read-only]

Docs for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-pr/28158/docs/index.html

The docs are (re-)rendered each time the CI envoy-presubmit (precheck docs) job completes.

🐱

Caused by: #28158 was opened by haiyuewa.

see: more, trace.

[repokitteh-read-only]

Hi @haiyuewa, welcome and thank you for your contribution.

We will try to review your Pull Request as quickly as possible.

In the meantime, please take a look at the contribution guidelines if you have not done so already.

🐱

Caused by: #28158 was opened by haiyuewa.

see: more, trace.

[phlax]

hi @haiyuewa thanks for raising this

we have been gradually moving all of our (bootstrap) config out of rst and into yaml - this ensures that the config is tested and doesnt go stale

would you be willing to shift these to yaml ?

you can find exsiting examples where the config has been separated with:

$ git grep literalinclude docs/

im happy to help if needed

[haiyuewa]

@phlax
By my understanding:

1. Add a dir '_include' into 'docs/root/operations'.
2. Put my workable yaml into it.
3. Then change to 'literalinclude'.

Right ?

[phlax]

yep - thats basically the gist - you will probably need to wrap the config with bootstrap boilerplate - ie listeners/clusters/etc

with the literalinclude there are a few options - not all are currently used in all examples - but ideally we want:

• only relevant lines showing
• caption/download for the config file itself
• optionally highlighting of significant lines

i should probably write this up somewhere as it comes up a lot

[phlax]

cc @kanurag94

[haiyuewa]

@phlax Yes, I found the format. I will submit a new patch about 'Traffic tapping' as a start.

.. literalinclude:: _include/http-cache-configuration.yaml
   :language: yaml
   :lines: 29-34
   :linenos:
   :lineno-start: 29
   :caption: :download:`http-cache-configuration.yaml <_include/http-cache-configuration.yaml>`

[phlax]

great, thanks @haiyuewa

re patch, i would just update this pr (perhaps i misunderstand)

[haiyuewa]

@phlax

The doc showing is as:

[phlax]

nice work @haiyuewa docs are buiilding - just a couple of (yaml) format issues to resolve

CodeChecker ERROR [yamllint] docs/root/operations/_include/traffic_tapping_plain_text.yaml (indentation 39:19): wrong indentation: expected 16 but found 18
CodeChecker ERROR [yamllint] docs/root/operations/_include/traffic_tapping_ssl.yaml (indentation 54:17): wrong indentation: expected 14 but found 16

[haiyuewa]

@phlax

Fixed, just copy it from the original design. ;-)

[phlax]

lgtm, thanks @haiyuewa for resolving this properly