Skip to content

Commit

Permalink
fix: relative paths
Browse files Browse the repository at this point in the history
Signed-off-by: bitliu <[email protected]>
  • Loading branch information
Xunzhuo committed Mar 7, 2024
1 parent 75cfe67 commit 6ebac02
Show file tree
Hide file tree
Showing 31 changed files with 45 additions and 45 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ not exposed by Envoy Gateway APIs today.

### Prerequisites

* Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
* Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

### Enable EnvoyPatchPolicy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The project also provides example dashboard for visualising the metrics using Gr

## Prerequisites

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Run the following commands to install the metrics stack, with the Gateway API State Metrics configuration, on your kubernetes cluster:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This guide shows you how to visualise the metrics exposed to prometheus using gr

## Prerequisites

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Follow the steps from the [Proxy Observability](../proxy-observability#Metrics) to enable prometheus metrics.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This guide show you how to config proxy observability, includes metrics, logs, a

## Prerequisites

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

[FluentBit](https://fluentbit.io/) is used to collect logs from the EnvoyProxy instances and forward them to Loki. Install FluentBit:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Service. To learn more about GatewayClass and ParametersRef, please refer to [Ga

## Installation

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Add GatewayClass ParametersRef
Expand Down
6 changes: 3 additions & 3 deletions site/content/en/latest/user/security/basic-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This instantiated resource can be linked to a [Gateway][Gateway], [HTTPRoute][HT

## Prerequisites

Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Configuration
Expand Down Expand Up @@ -78,7 +78,7 @@ kubectl get securitypolicy/basic-auth-example -o yaml

## Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../quickstart) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) guide is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -117,7 +117,7 @@ The request should be allowed and you should see the response from the backend s

## Clean-Up

Follow the steps from the [Quickstart](../quickstart) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to uninstall Envoy Gateway and the example manifest.

Delete the SecurityPolicy and the secret

Expand Down
6 changes: 3 additions & 3 deletions site/content/en/latest/user/security/cors.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This instantiated resource can be linked to a [Gateway][Gateway], [HTTPRoute][HT

## Prerequisites

Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Configuration
Expand Down Expand Up @@ -57,7 +57,7 @@ kubectl get securitypolicy/cors-example -o yaml

## Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../quickstart) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) guide is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -122,7 +122,7 @@ filter to work. Otherwise, the OPTIONS request won't match the routes and the CO

## Clean-Up

Follow the steps from the [Quickstart](../quickstart) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to uninstall Envoy Gateway and the example manifest.

Delete the SecurityPolicy:

Expand Down
6 changes: 3 additions & 3 deletions site/content/en/latest/user/security/jwt-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This instantiated resource can be linked to a [Gateway][Gateway], [HTTPRoute][HT

## Prerequisites

Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
For GRPC - follow the steps from the [GRPC Routing](../grpc-routing) example.
Before proceeding, you should be able to query the example backend using HTTP or GRPC.

Expand Down Expand Up @@ -71,7 +71,7 @@ kubectl get securitypolicy/jwt-example -o yaml

## Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../quickstart) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) guide is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -150,7 +150,7 @@ You should see the below response

## Clean-Up

Follow the steps from the [Quickstart](../quickstart) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to uninstall Envoy Gateway and the example manifest.

Delete the SecurityPolicy:

Expand Down
4 changes: 2 additions & 2 deletions site/content/en/latest/user/security/oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This instantiated resource can be linked to a [Gateway][Gateway] and [HTTPRoute]

## Prerequisites

Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

OIDC authentication requires the redirect URL to be HTTPS. Follow the [Secure Gateways](../secure-gateways) guide
Expand Down Expand Up @@ -110,7 +110,7 @@ successfully login, you should see the response from the backend service.

## Clean-Up

Follow the steps from the [Quickstart](../quickstart) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to uninstall Envoy Gateway and the example manifest.

Delete the SecurityPolicy and the secret:

Expand Down
8 changes: 4 additions & 4 deletions site/content/en/latest/user/security/secure-gateways.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ testing and demonstration purposes only.

## Installation

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## TLS Certificates
Expand Down Expand Up @@ -242,7 +242,7 @@ Lastly, test connectivity using the above [Testing section](#testing).

## Clean-Up

Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the Secrets:

Expand All @@ -257,7 +257,7 @@ This section gives a walkthrough to generate RSA and ECDSA derived certificates

## Prerequisites

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Follow the steps in the [TLS Certificates](../secure-gateways#tls-certificates) section in the guide to generate self-signed RSA derived Server certificate and private key, and configure those in the Gateway listener configuration to terminate HTTPS traffic.
Expand Down Expand Up @@ -369,7 +369,7 @@ This sections gives a walkthrough to generate multiple certificates correspondin
## Prerequisites
Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.
Follow the steps in the [TLS Certificates](../secure-gateways#tls-certificates) section in the guide to generate self-signed RSA derived Server certificate and private key, and configure those in the Gateway listener configuration to terminate HTTPS traffic.
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/security/tls-cert-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Changing to the Let's Encrypt production environment is straight-forward after t

## Installation

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Deploying cert-manager
Expand Down
4 changes: 2 additions & 2 deletions site/content/en/latest/user/security/tls-passthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ to terminate the TLS connection, while the Gateway routes the requests to the ap

## Installation

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## TLS Certificates
Expand Down Expand Up @@ -106,7 +106,7 @@ curl -v -HHost:passthrough.example.com --resolve "passthrough.example.com:6443:$

## Clean-Up

Follow the steps from the [Quickstart Guide](../quickstart) to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the Secret:

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/security/tls-termination.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This guide will walk through the steps required to configure TLS Terminate mode

## Installation

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway.

## TLS Certificates
Generate the certificates and keys used by the Gateway to terminate client TLS connections.
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/circuit-breaker.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This instantiated resource can be linked to a [Gateway][], [HTTPRoute][] or [GRP

### Install Envoy Gateway

* Follow the installation step from the [Quickstart Guide](../quickstart) to install Envoy Gateway and sample resources.
* Follow the installation step from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and sample resources.

### Install the hey load testing tool
* The `hey` CLI will be used to generate load and measure response times. Follow the installation instruction from the [Hey project] docs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This API was added as a new policy attachment resource that can be applied to Ga

### Prerequisites

* Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
* Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

### Support TCP keepalive for downstream client
Expand Down
6 changes: 3 additions & 3 deletions site/content/en/latest/user/traffic/fault-injection.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This instantiated resource can be linked to a [Gateway][], [HTTPRoute][] or [GRP

## Prerequisites

Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
For GRPC - follow the steps from the [GRPC Routing](../grpc-routing) example.
Before proceeding, you should be able to query the example backend using HTTP or GRPC.

Expand Down Expand Up @@ -170,7 +170,7 @@ kubectl get backendtrafficpolicy/fault-injection-abort -o yaml

## Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../quickstart) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) guide is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -238,7 +238,7 @@ Error invoking method "yages.Echo/Ping": rpc error: code = Unavailable desc = fa

## Clean-Up

Follow the steps from the [Quickstart](../quickstart) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to uninstall Envoy Gateway and the example manifest.

Delete the BackendTrafficPolicy:

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/gateway-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Depending on the Service Type, the addresses of gateway can be used as:

## Prerequisites

Follow the steps from the [Quickstart](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.

## External IPs

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/global-rate-limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ has its own 100r/s rate limit bucket.

### Install Envoy Gateway

* Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the HTTPRoute example manifest.
* Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the HTTPRoute example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

### Install Redis
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/grpc-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To learn more about gRPC routing, refer to the [Gateway API documentation][].

## Prerequisites

Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Installation
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/http-redirect.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ learn more about HTTP routing, refer to the [Gateway API documentation][].

## Prerequisites

Follow the steps from the [Quickstart](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTPS.

## Redirects
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ client.

## Prerequisites

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Adding Request Headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ EOF
Error from server: error when creating "STDIN": admission webhook "validate.gateway.networking.k8s.io" denied the request: spec.rules[0].filters: Invalid value: "RequestMirror": cannot be used multiple times in the same rule
```

[Quickstart Guide]: ../quickstart/
[Quickstart Guide]: ../../quickstart/
[Traffic Splitting]: ../http-traffic-splitting/
[HTTPRoute]: https://gateway-api.sigs.k8s.io/api-types/httproute/
[backendRefs]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.BackendRef
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ upstream service.

## Prerequisites

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Adding Response Headers
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/http-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Services. To learn more about HTTP routing, refer to the [Gateway API documentat

## Prerequisites

Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Installation
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/http-timeouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ __Note:__ The Request duration must be >= BackendRequest duration

## Installation

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Verification
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ with status code `500` for all requests that would have been sent to that backen

## Installation

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Single backendRef
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/http-urlrewrite.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ used on a Route rule. This MUST NOT be used on the same Route rule as a HTTPRequ

## Prerequisites

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Rewrite URL Prefix Path
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/local-rate-limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ has its own 100r/s rate limit bucket.

### Install Envoy Gateway

* Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the HTTPRoute example manifest.
* Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the HTTPRoute example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Rate Limit Specific User
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/retry.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Envoy Gateway introduces a new CRD called [BackendTrafficPolicy](../../../api/ex

## Prerequisites

Follow the installation step from the [Quickstart Guide](../quickstart) to install Envoy Gateway and sample resources.
Follow the installation step from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and sample resources.

## Test and customize retry settings

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/user/traffic/tcp-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ HTTP routing, refer to the [Gateway API documentation][].

## Installation

Follow the steps from the [Quickstart](../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Configuration
Expand Down
Loading

0 comments on commit 6ebac02

Please sign in to comment.