Skip to content

Commit

Permalink
update ServiceProfile compat warning
Browse files Browse the repository at this point in the history
This commit updates the HTTPRoute/ServiceProfile incompatibility warning
in the documentation to use the new wording suggested by @wmorgan in
#1657 (comment).
  • Loading branch information
hawkw committed Aug 21, 2023
1 parent d2aefbc commit 90cae02
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
13 changes: 8 additions & 5 deletions linkerd.io/content/2-edge/reference/httproute.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,12 @@ rerouted to different backend services. This can be used to perform [dynamic
request routing](../../tasks/configuring-dynamic-request-routing/).

{{< warning >}}
Outbound HTTPRoutes are **incompatible with ServiceProfiles**. If the
[ParentReference](#parentreference) of an HTTPRoute is a Service, and a
[ServiceProfile](../../features/service-profiles/) is also defined for that
Service, proxies will use the ServiceProfile configuration, rather than the
HTTPRoute configuration, as long as the ServiceProfile exists.
**Outbound HTTPRoutes and [ServiceProfile]s provide overlapping configuration.**
For backwards-compatibility reasons, a ServiceProfile will take precedence over
HTTPRoutes which configure the same Service. If a ServiceProfile is defined for
the parent Service of an HTTPRoute, proxies will use the ServiceProfile
configuration, rather than the HTTPRoute configuration, as long as the
ServiceProfile exists.
{{< /warning >}}

{{< table >}}
Expand Down Expand Up @@ -245,3 +246,5 @@ spec:
- name: smiley
port: 80
```

[ServiceProfile]: ../../features/service-profiles/
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,12 @@ namespace (`test`), and also specify the Service port number (not the Service's
target port).

{{< warning >}}
Outbound `HTTPRoute`s are **incompatible with `ServiceProfiles`**. If a
[ServiceProfile](../../features/service-profiles/) is defined for the parent
Service of an [`HTTPRoute`], proxies will use the `ServiceProfile` configuration,
rather than the [`HTTPRoute`] configuration, as long as the `ServiceProfile`
**Outbound [`HTTPRoute`]s and [`ServiceProfile`]s provide overlapping
configuration.** For backwards-compatibility reasons, a [`ServiceProfile`] will
take precedence over [`HTTPRoute`s] which configure the same Service. If a
[`ServiceProfile`] is defined for the parent Service of an [`HTTPRoute`],
proxies will use the [`ServiceProfile`] configuration, rather than the
[`HTTPRoute`] configuration, as long as the [`ServiceProfile`]
exists.
{{< /warning >}}

Expand Down Expand Up @@ -171,3 +173,4 @@ more workloads you have injected the better, to benefit from things like easy
mTLS setup and all the other advantages that linkerd brings to the table!

[`HTTPRoute`]: ../../features/httproute/
[`ServiceProfile`]: ../../features/ServiceProfile/

0 comments on commit 90cae02

Please sign in to comment.