Skip to content

feat(cli): document skip ports behavior for tap (#1966) #2105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
travisbeckham merged 8 commits into from
Apr 23, 2026
Merged

feat(cli): document skip ports behavior for tap (#1966) #2105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2c6be21
Add CLI reference page for linkerd tap (#1966)
Mike-4-prog Mar 16, 2026
c63558d
Fix tap.md formatting, consolidate usage header, update examples & flags
Mike-4-prog Mar 16, 2026
c0d3b32
Remove trailing empty lines in tap.md
Mike-4-prog Mar 23, 2026
ac57e2e
Move skipped ports note to viz tap section and remove standalone tap …
Mike-4-prog Mar 23, 2026
0c8d00f
Use note shortcode for skipped ports warning in viz tap section
Mike-4-prog Mar 23, 2026
40c4cea
Add skipped ports note to 2-edge viz CLI docs
Mike-4-prog Mar 30, 2026
249d76e
Merge branch 'main' into docs-skip-port-tap-1966
cratelyn Apr 15, 2026
11cba99
Merge branch 'main' into docs-skip-port-tap-1966
travisbeckham Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions linkerd.io/content/2-edge/reference/cli/viz.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,12 @@ Because retries are only performed on the _outbound_ (client) side, the

{{< docs/cli-description "viz tap" >}}

{{< note >}}If a pod is configured with the annotations
`config.linkerd.io/skip-inbound-ports` or
`config.linkerd.io/skip-outbound-ports`, traffic on those ports bypasses the
Linkerd proxy. Because `linkerd tap` observes traffic through the proxy,
**traffic on skipped ports cannot be tapped**.{{< /note >}}

{{< docs/cli-examples "viz tap" >}}

{{< docs/cli-flags "viz tap" >}}
Expand Down
6 changes: 6 additions & 0 deletions linkerd.io/content/2.19/reference/cli/viz.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,12 @@ Because retries are only performed on the _outbound_ (client) side, the

{{< docs/cli-description "viz tap" >}}

{{< note >}}If a pod is configured with the annotations
`config.linkerd.io/skip-inbound-ports` or
`config.linkerd.io/skip-outbound-ports`, traffic on those ports bypasses the
Linkerd proxy. Because `linkerd tap` observes traffic through the proxy,
**traffic on skipped ports cannot be tapped**.{{< /note >}}
Comment thread
cratelyn marked this conversation as resolved.

{{< docs/cli-examples "viz tap" >}}

{{< docs/cli-flags "viz tap" >}}
Expand Down