Skip to content

Commit

Permalink
add note about installing gateway api crds (#1821)
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Leong <[email protected]>
  • Loading branch information
adleong authored and alpeb committed Aug 13, 2024
1 parent d4aa0be commit 6b7e116
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
7 changes: 7 additions & 0 deletions linkerd.io/content/2.16/features/httproute.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ documentation](../../reference/httproute/#linkerd-and-gateway-api-httproutes)
for details.
{{< /note >}}

If the Gateway API CRDs already exist in your cluster, then Linkerd must be
installed with the `--set enableHttpRoutes=false` flag during the
`linkerd install --crds` step or with the `enableHttpRoutes=false` Helm value
when installing the `linkerd-crds` Helm chart. This avoid conflicts by
instructing Linkerd to not install the Gateway API CRDs and instead rely on the
Gateway CRDs which already exist.

An HTTPRoute is a Kubernetes resource which attaches to a parent resource, such
as a [Service]. The HTTPRoute defines a set of rules which match HTTP requests
to that resource, based on parameters such as the request's path, method, and
Expand Down
11 changes: 9 additions & 2 deletions linkerd.io/content/2.16/reference/httproute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,15 @@ largely the same, the `policy.linkerd.io` HTTPRoute resource is an experimental
version that contains features not yet stabilized in the upstream
`gateway.networking.k8s.io` HTTPRoute resource, such as
[timeouts](#httproutetimeouts). Both the Linkerd and Gateway API resource
definitions may coexist within the same cluster, and both can be used to
configure policies for use with Linkerd.
definitions coexist within the same cluster, and both can be used to configure
policies for use with Linkerd.

If the Gateway API CRDs already exist in your cluster, then Linkerd must be
installed with the `--set enableHttpRoutes=false` flag during the
`linkerd install --crds` step or with the `enableHttpRoutes=false` Helm value
when installing the `linkerd-crds` Helm chart. This avoid conflicts by
instructing Linkerd to not install the Gateway API CRDs and instead rely on the
Gateway CRDs which already exist.

This documentation describes the `policy.linkerd.io` HTTPRoute resource. For a
similar description of the upstream Gateway API HTTPRoute resource, refer to the
Expand Down

0 comments on commit 6b7e116

Please sign in to comment.