Ingress service profiling docs unclear on override header
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 60
- Forks
- 221
- Avg merge
- 4h 32m
- Merged PRs (30d)
- 1
Description
Hi,
Thanks to some quick help on Slack, I learned that I needed to upgrade to 2.4.0 to get incoming traffic from an ingress to recognize the override headers (cfr: https://github.com/linkerd/linkerd2/issues/2910). This limitation was not very clear from the existing docs (https://github.com/linkerd/website/blob/master/linkerd.io/content/2/tasks/using-ingress.md), I understood I just had to add the header and 2.3.2 would start recognizing it. Turns out this was only the case for outgoing traffic
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading linkerd.io/content/2/tasks/using-ingress.md and compare its guidance with issue 2910. Clarify the version requirement and distinguish incoming from outgoing traffic when describing override headers; the documentation is done when users cannot reasonably infer that 2.3.2 supports incoming override headers.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100