Update service profile troubleshooting to explain headers
Open
Beginner friendly
Nobody has claimed this yet.
area/troubleshooting
docs
- Dominant language
- JavaScript
- Stars
- 60
- Forks
- 221
- Avg merge
- 4h 32m
- Merged PRs (30d)
- 1
Description
A common point of confusion around service profiles is that the `Host` header needs to match. It can be hard to understand how to get that to work.
- Include a traffic generator.
- Explain why `port-forward` doesn't work, see https://github.com/linkerd/linkerd2/issues/2352
- Suggest using `curl` from inside the cluster with `-H`.
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
Locate the service profile troubleshooting documentation and review the linked issue about port-forwarding. Update the guidance to include a traffic generator, explain why port-forward does not work, and show how to use curl from inside the cluster with the Host header; done means all three points are covered clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100