mirror of
https://github.com/status-im/consul.git
synced 2025-03-03 23:00:44 +00:00
ab51aac7e0
* added usage folder to organize use case docs for CAPIgw * Add peer field to MeshService configuration page * Add first pass at guide for routing to peered services * Add exception to same-datacenter restriction for referenced Consul service * Add example HTTPRoute referencing the MeshService as backendRef * Add example ServiceResolver * Add note about current ServiceResolver requirement ServiceResolver may eventually be created implicitly by the API gateway controller, but that decision is pending. * tweaks to the usage page for routing to peered services * tweaks to the description in the configuration reference * resolved TO-DOs from previous iteration * Remove datacenter federation from limited support matrix * added tolerations doc * Remove note excluding k8s 1.24 since we now support it * Reorder sections to maintain alphabetical sort * Add example configuration for MeshService resource * Adjust wording + indentation of other docs * Use consistent "example-" prefix for resource names in example code * reframed the tolerations documentation; STILL A WIP * add helm chart documentation * removed tolerations from gwcconfig configuration model reference * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * update version to 0.5.0 * Update install.mdx * added release notes for v.0.5.x Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com> Co-authored-by: Sarah Alsmiller <sarah.alsmiller@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com>
58 lines
2.2 KiB
Plaintext
58 lines
2.2 KiB
Plaintext
---
|
||
layout: docs
|
||
page_title: Reroute HTTP Requests
|
||
description: >-
|
||
Learn how to configure Consul API Gateway to reroute HTTP requests to a specific path.
|
||
---
|
||
|
||
# Reroute HTTP Requests
|
||
|
||
This topic describes how to configure Consul API Gateway to reroute HTTP requests.
|
||
|
||
## Requirements
|
||
|
||
1. Verify that the [requirements](/docs/api-gateway/tech-specs) have been met.
|
||
1. Verify that the Consul API Gateway CRDs and controller have been installed and applied. Refer to [Installation](/docs/api-gateway/install) for details.
|
||
|
||
## Configuration
|
||
|
||
Specify the following fields in your `Route` configuration. Refer to the [Route configuration reference](/docs/api-gateway/configuration/routes) for details about the parameters.
|
||
|
||
- [`rules.filters.type`](/docs/api-gateway/configuration/routes#rules-filters-type): Set this parameter to `URLRewrite` to instruct Consul API Gateway to rewrite the URL when specific conditions are met.
|
||
- [`rules.filters.urlRewrite`](/docs/api-gateway/configuration/routes#rules-filters-urlrewrite): Specify the `path` configuration.
|
||
- [`rules.filters.urlRewrite.path`](/docs/api-gateway/configuration/routes#rules-filters-urlrewrite-path): Contains the paths that incoming requests should be rewritten to based on the match conditions.
|
||
|
||
To configure the route to accept paths with or without a trailing slash, you must make two separate routes to handle each case.
|
||
|
||
### Example
|
||
|
||
In the following example, requests to` /incoming-request-prefix/` are forwarded to the `backendRef` as `/prefix-backend-receives/`. As a result, requests to `/incoming-request-prefix/request-path` are received by `backendRef` as `/prefix-backend-receives/request-path`.
|
||
|
||
<CodeBlockConfig filename="route.yaml">
|
||
|
||
```yaml hideClipboard
|
||
apiVersion: gateway.networking.k8s.io/v1beta1
|
||
kind: HTTPRoute
|
||
metadata:
|
||
name: example-route
|
||
##...
|
||
spec:
|
||
parentRefs:
|
||
- group: gateway.networking.k8s.io
|
||
kind: Gateway
|
||
name: api-gateway
|
||
rules:
|
||
- backendRefs:
|
||
. . .
|
||
filters:
|
||
- type: URLRewrite
|
||
urlRewrite:
|
||
path:
|
||
replacePrefixMatch: /prefix-backend-receives/
|
||
type: ReplacePrefixMatch
|
||
matches:
|
||
- path:
|
||
type: PathPrefix
|
||
value: /incoming–request-prefix/
|
||
```
|
||
</CodeBlockConfig> |