Moved HTTPRoute reference doc into its own page#1590
Conversation
8242b53 to
07f973d
Compare
07f973d to
78c06d4
Compare
hawkw
left a comment
There was a problem hiding this comment.
I left some potential suggestions on the docs. I know a lot of this wasn't added in this PR, but I hope the suggestions are still helpful!
| |------|-------| | ||
| | `name`| Name of service for this backend.| | ||
| | `port`| Destination port number for this backend.| | ||
| | `weight`| Proportion of requests sent to this backend.| |
There was a problem hiding this comment.
a backend ref can also have a namespace: https://github.com/linkerd/linkerd2/blob/6e28aefc774f8746d8cc7536535261da5d135a3c/charts/linkerd-crds/templates/policy/httproute.yaml#L977
There was a problem hiding this comment.
Good point, I'll add that. But do we actually support cross-namespace traffic without ReferenceGrants?
8900445 to
b84703e
Compare
|
Thanks for the comments @hawkw , this is ready for review again. |
|
|
||
| ### parentReference | ||
|
|
||
| A reference to the parent resource this HTTPRoute is a part of. |
There was a problem hiding this comment.
it might be worth explaining what this does in terms of the proxy's behavior: it attaches an HTTPRoute's outbound policies to a Service, telling outbound proxies what to do when talking to that Service; or attaches an HTTPRoute's inbound policies to a Server, telling inbound proxies what to do when accepting traffic for that Server.
There was a problem hiding this comment.
I actually had a section at the beginning of the doc explaining this difference, but your point is taken, so I'm moving that into this subsection instead 👍
b84703e to
6b8face
Compare
| rerouted to different backend services. This can be used to perform dynamic | ||
| request routing. |
There was a problem hiding this comment.
maybe the phrase "dynamic request routing" should link to the dynamic request routing docs. we can add the link in that branch if this one merges first...
| policy](../authorization-policy/#authorizationpolicy) for specific routes served | ||
| on that Server. | ||
|
|
||
| HTTPRoutes can also be attached to a Service, in order to classify requests |
There was a problem hiding this comment.
not sure if i love the use of the term "classify" here, since that feels a little overloaded with response classification. how about
| HTTPRoutes can also be attached to a Service, in order to classify requests | |
| HTTPRoutes can also be attached to a Service, in order to route requests |
|
looks like something's busted: https://github.com/linkerd/website/actions/runs/4660760367/jobs/8249216653?pr=1590#step:5:19 |
kflynn
left a comment
There was a problem hiding this comment.
I definitely like moving the HTTPRoute spec into its own doc! I made a couple of suggestions about referring to it, though...
| authorizing traffic to that `HTTPRoute` only rather than to the entire [Server]. | ||
| `HTTPRoutes` may also define filters which add processing steps that must be | ||
| completed during the request or response lifecycle. | ||
| When attached to a [Server], an `HTTPRoute` resource represents a subset of the |
There was a problem hiding this comment.
Maybe just make this mention (or all mentions?) of HTTPRoute a link to the spec, rather than having the one-sentence paragraph at line 153?
| type: "PathPrefix" | ||
| method: GET | ||
| ``` | ||
| Please refer to HTTPRoute's full [spec](../httproute/). |
There was a problem hiding this comment.
Maybe just drop this sentence in favor of linking out from mentions of HTTPRoute?
There was a problem hiding this comment.
This paragraph briefly describes HTTPRoute in the context of Authorization Policy and the title is an HTTPRoute anchor, targeted from other places in this doc. That's why other references in this doc point to this paragraph and then I have this sentence to clearly point out to the other doc with the full reference. Makes sense?
Moved out of Authorization Policy given it's also used for Header-Based routing which is unrelated to Auth. Also added missing fields in the ref. Upcoming: Header-Based routing tutorial
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
ba4f5b8 to
b998fd7
Compare
Moved out of Authorization Policy given it's also used for Header-Based routing which is unrelated to Auth.
Also added missing fields in the ref.
Upcoming: Header-Based routing tutorial