From 85a03894e3b6e984329ab04461599a2c5a8362e2 Mon Sep 17 00:00:00 2001 From: Eliza Weisman Date: Mon, 21 Aug 2023 11:53:01 -0700 Subject: [PATCH] update ServiceProfile compat warning (#1661) This commit updates the HTTPRoute/ServiceProfile incompatibility warning in the documentation to use the new wording suggested by @wmorgan in https://github.com/linkerd/website/pull/1657#discussion_r1298905092. --- linkerd.io/content/2-edge/reference/httproute.md | 13 ++++++++----- .../tasks/configuring-dynamic-request-routing.md | 13 ++++++++----- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/linkerd.io/content/2-edge/reference/httproute.md b/linkerd.io/content/2-edge/reference/httproute.md index 6da86e150c..7b23460555 100644 --- a/linkerd.io/content/2-edge/reference/httproute.md +++ b/linkerd.io/content/2-edge/reference/httproute.md @@ -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](../../features/service-profiles/)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 >}} @@ -245,3 +246,5 @@ spec: - name: smiley port: 80 ``` + +[ServiceProfile]: ../../features/service-profiles/ diff --git a/linkerd.io/content/2-edge/tasks/configuring-dynamic-request-routing.md b/linkerd.io/content/2-edge/tasks/configuring-dynamic-request-routing.md index 8cfe9818c8..626042ffcf 100644 --- a/linkerd.io/content/2-edge/tasks/configuring-dynamic-request-routing.md +++ b/linkerd.io/content/2-edge/tasks/configuring-dynamic-request-routing.md @@ -110,11 +110,13 @@ 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` -exists. +**Outbound [`HTTPRoute`](../../features/httproute/)s and +[`ServiceProfile`](../../features/service-profiles/)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 >}} Next, we give a list of rules that will act on the traffic hitting that Service. @@ -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/