Skip to content

docs: Fix Deprecated Tap Request Examples#20194

Closed
DavidPeet8 wants to merge 2 commits intoenvoyproxy:mainfrom
DavidPeet8:tap-docs
Closed

docs: Fix Deprecated Tap Request Examples#20194
DavidPeet8 wants to merge 2 commits intoenvoyproxy:mainfrom
DavidPeet8:tap-docs

Conversation

@DavidPeet8
Copy link
Copy Markdown
Contributor

Commit Message:
Update the Tap documentation to avoid use of match_config as this is deprecated and use of this field causes errors in CI.

Signed-off-by: David Peet davidpeet@tutanota.com

Additional Description: n/a
Risk Level: low
Testing: n/a
Docs Changes: Update documentation for Tap filter to use match instead of match_config
Release Notes: n/a
Platform Specific Features: n/a
Fixes: #20190

Signed-off-by: David Peet <davidpeet@tutanota.com>
@repokitteh-read-only
Copy link
Copy Markdown

Hi @DavidPeet8, 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: #20194 was opened by DavidPeet8.

see: more, trace.

@rojkov
Copy link
Copy Markdown
Member

rojkov commented Mar 3, 2022

/assign @yangminzhu

Copy link
Copy Markdown
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with these inline configs that tend to go stale - i generally ask/recommend that we move them into separate yaml files so that they are tested

i would be happy to follow up tho, if we just fix them in this pr

@phlax
Copy link
Copy Markdown
Member

phlax commented Mar 3, 2022

...or advise on how to do so

@DavidPeet8
Copy link
Copy Markdown
Contributor Author

i generally ask/recommend that we move them into separate yaml files so that they are tested

@phlax Is that testing automatic or is the thought that separate yaml files for these code snippets will make developers more likely to test them as they are more obvious? If these tests are automatic, are there any additional changes I need to make to set them up?

@phlax
Copy link
Copy Markdown
Member

phlax commented Mar 3, 2022

testing is automatic - if you grep for literalinclude you will find other examples of config that has been separated out to full (bootstrap) configs

Signed-off-by: David Peet <davidpeet@tutanota.com>
@DavidPeet8 DavidPeet8 marked this pull request as draft March 3, 2022 22:57
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 3, 2022

This pull request has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

@github-actions github-actions Bot added the stale stalebot believes this issue/PR has not been touched recently label Apr 3, 2022
@phlax
Copy link
Copy Markdown
Member

phlax commented Apr 3, 2022

hi @DavidPeet8 would be good to progress this

copying out the error (config validation)

ERROR: some configuration files (1) failed to validate

ERROR (validation failed): docs/root/configuration/http/http_filters/_include/tap-filter.yaml
Failed to parse static_resources field: Failed to parse listeners field: Failed to parse filter_chains field: Failed to parse filters field: Failed to parse http_filters field: Failed to parse common_config field: Message type "envoy.extensions.common.tap.v3.AdminConfig" has no field named "tap_config".
 Available Fields(except extensions): ['configId']......

@github-actions github-actions Bot removed the stale stalebot believes this issue/PR has not been touched recently label Apr 3, 2022
@DavidPeet8
Copy link
Copy Markdown
Contributor Author

Hi @phlax I won't have much capacity to look into the validation errors on the documents for a few weeks. Is it alright if I return to this then?

@phlax
Copy link
Copy Markdown
Member

phlax commented Apr 6, 2022

Is it alright if I return to this then?

sure, of course, lmk if i can help resolving the remaining issues

/wait

@phlax phlax self-assigned this Apr 6, 2022
@DavidPeet8
Copy link
Copy Markdown
Contributor Author

Hey @phlax - just an FYI, I'm an intern at Uber right now and my term ends at the end of next week. At that point I'll lose access to my dev environment for Envoy. I'm not sure if I'll have the time to look into why the docs are failing builds before then, so feel free to commandeer this change to get it in.

@github-actions
Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

@github-actions github-actions Bot added the stale stalebot believes this issue/PR has not been touched recently label May 23, 2022
@github-actions
Copy link
Copy Markdown

This pull request has been automatically closed because it has not had activity in the last 37 days. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

@github-actions github-actions Bot closed this May 30, 2022
paul-r-gall pushed a commit that referenced this pull request Mar 16, 2026
…es (#43955)

## Summary
- Replace the deprecated `match_config` field with `match` in all 7 YAML
examples in the tap filter documentation
- `match_config` has been deprecated since v3.0 (see
`api/envoy/config/tap/v3/common.proto`)
- Both fields use the same `MatchPredicate` type so the YAML structure
is unchanged

Fixes #20190
Continues the work from #20194.

Risk Level: Low (docs only)
Testing: N/A
Docs Changes: Updated all tap filter examples
Release Notes: N/A

Signed-off-by: Kit <kit@kovan.dev>

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Signed-off-by: Kit <kit@kovan.dev>
Signed-off-by: kovan <xaum.io@gmail.com>
fishcakez pushed a commit to fishcakez/envoy that referenced this pull request Mar 25, 2026
…es (envoyproxy#43955)

## Summary
- Replace the deprecated `match_config` field with `match` in all 7 YAML
examples in the tap filter documentation
- `match_config` has been deprecated since v3.0 (see
`api/envoy/config/tap/v3/common.proto`)
- Both fields use the same `MatchPredicate` type so the YAML structure
is unchanged

Fixes envoyproxy#20190
Continues the work from envoyproxy#20194.

Risk Level: Low (docs only)
Testing: N/A
Docs Changes: Updated all tap filter examples
Release Notes: N/A

Signed-off-by: Kit <kit@kovan.dev>

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Signed-off-by: Kit <kit@kovan.dev>
Signed-off-by: kovan <xaum.io@gmail.com>
kpramesh2212 pushed a commit to kpramesh2212/envoy that referenced this pull request Apr 14, 2026
…es (envoyproxy#43955)

## Summary
- Replace the deprecated `match_config` field with `match` in all 7 YAML
examples in the tap filter documentation
- `match_config` has been deprecated since v3.0 (see
`api/envoy/config/tap/v3/common.proto`)
- Both fields use the same `MatchPredicate` type so the YAML structure
is unchanged

Fixes envoyproxy#20190
Continues the work from envoyproxy#20194.

Risk Level: Low (docs only)
Testing: N/A
Docs Changes: Updated all tap filter examples
Release Notes: N/A

Signed-off-by: Kit <kit@kovan.dev>

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Signed-off-by: Kit <kit@kovan.dev>
Signed-off-by: kovan <xaum.io@gmail.com>
krinkinmu pushed a commit to grnmeira/envoy that referenced this pull request Apr 20, 2026
…es (envoyproxy#43955)

## Summary
- Replace the deprecated `match_config` field with `match` in all 7 YAML
examples in the tap filter documentation
- `match_config` has been deprecated since v3.0 (see
`api/envoy/config/tap/v3/common.proto`)
- Both fields use the same `MatchPredicate` type so the YAML structure
is unchanged

Fixes envoyproxy#20190
Continues the work from envoyproxy#20194.

Risk Level: Low (docs only)
Testing: N/A
Docs Changes: Updated all tap filter examples
Release Notes: N/A

Signed-off-by: Kit <kit@kovan.dev>

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Signed-off-by: Kit <kit@kovan.dev>
Signed-off-by: kovan <xaum.io@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

stale stalebot believes this issue/PR has not been touched recently waiting

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants