From 7a89649f1f2b2ef2ff218f9eeb362f682124c54a Mon Sep 17 00:00:00 2001 From: R-Lawton Date: Fri, 20 Dec 2024 12:43:19 +0000 Subject: [PATCH] fix 404 links Signed-off-by: R-Lawton --- .../auth/auth-for-app-devs-and-platform-engineers.md | 3 +-- doc/user-guides/dns/gateway-dns.md | 2 +- .../ratelimiting/authenticated-rl-for-app-developers.md | 5 +++-- .../authenticated-rl-with-jwt-and-k8s-authnz.md | 4 ++-- .../ratelimiting/gateway-rl-for-cluster-operators.md | 6 +++--- .../ratelimiting/multi-auth-rlp-diff-section.md | 8 +++----- .../ratelimiting/multi-auth-rlp-same-section.md | 7 ++++--- .../ratelimiting/simple-rl-for-app-developers.md | 5 ++--- 8 files changed, 19 insertions(+), 21 deletions(-) diff --git a/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md b/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md index 04c0d22db..8345e933f 100644 --- a/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md +++ b/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md @@ -37,8 +37,7 @@ Topology: ## Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. - +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toy Store sample application (Persona: _App developer_) diff --git a/doc/user-guides/dns/gateway-dns.md b/doc/user-guides/dns/gateway-dns.md index 804862359..2c1b99cd2 100644 --- a/doc/user-guides/dns/gateway-dns.md +++ b/doc/user-guides/dns/gateway-dns.md @@ -9,7 +9,7 @@ This user guide walks you through an example of how to configure DNS for all rou ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. Create a namespace: diff --git a/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md b/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md index 8aeb82e18..028aa7fcb 100644 --- a/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md +++ b/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md @@ -1,5 +1,6 @@ # Authenticated Rate Limiting for Application developers -For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas) + +For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas) This user guide walks you through an example of how to configure authenticated rate limiting for an application using Kuadrant. @@ -20,7 +21,7 @@ We will define 2 users of the API, which can send requests to the API at differe ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toy Store API diff --git a/doc/user-guides/ratelimiting/authenticated-rl-with-jwt-and-k8s-authnz.md b/doc/user-guides/ratelimiting/authenticated-rl-with-jwt-and-k8s-authnz.md index d566227e2..f08445928 100644 --- a/doc/user-guides/ratelimiting/authenticated-rl-with-jwt-and-k8s-authnz.md +++ b/doc/user-guides/ratelimiting/authenticated-rl-with-jwt-and-k8s-authnz.md @@ -25,7 +25,7 @@ Each user will be entitled to a maximum of 5rp10s (5 requests every 10 seconds). ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toystore example API: @@ -274,7 +274,7 @@ curl -H "Authorization: Bearer $SA_TOKEN" -H 'Host: api.toystore.com' -X POST ht # HTTP/1.1 403 Forbidden ``` -### Enforce rate limiting on requests to the Toy Store API +### Enforce rate limiting on requests to the Toy Store API Create a Kuadrant `RateLimitPolicy` to configure rate limiting: diff --git a/doc/user-guides/ratelimiting/gateway-rl-for-cluster-operators.md b/doc/user-guides/ratelimiting/gateway-rl-for-cluster-operators.md index 3619317d6..f0c551758 100644 --- a/doc/user-guides/ratelimiting/gateway-rl-for-cluster-operators.md +++ b/doc/user-guides/ratelimiting/gateway-rl-for-cluster-operators.md @@ -1,13 +1,12 @@ # Gateway Rate Limiting for Cluster Operators -For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas) +For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas) This user guide walks you through an example of how to configure rate limiting for all routes attached to a specific ingress gateway. - ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toystore example API: @@ -15,6 +14,7 @@ Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/ kubectl apply -f examples/toystore/toystore.yaml ``` + ### Create the ingress gateways ```sh diff --git a/doc/user-guides/ratelimiting/multi-auth-rlp-diff-section.md b/doc/user-guides/ratelimiting/multi-auth-rlp-diff-section.md index 5ab10a97b..feffc70fc 100644 --- a/doc/user-guides/ratelimiting/multi-auth-rlp-diff-section.md +++ b/doc/user-guides/ratelimiting/multi-auth-rlp-diff-section.md @@ -4,7 +4,7 @@ This user guide walks you through an example of how to configure multiple rate l ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the sample API: @@ -80,7 +80,7 @@ spec: name: environment sectionName: external defaults: - strategy: merge + strategy: merge limits: "external": rates: @@ -104,7 +104,7 @@ spec: name: environment sectionName: local defaults: - strategy: merge + strategy: merge limits: "local": rates: @@ -115,8 +115,6 @@ EOF > **Note:** It may take a couple of minutes for the RateLimitPolicy to be applied depending on your cluster. - - ### Verify the rate limiting works by sending requests in a loop Expose the gateways, respectively at the port numbers `9081` and `9082` of the local host: diff --git a/doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md b/doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md index ef972f227..e53712cd1 100644 --- a/doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md +++ b/doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md @@ -19,7 +19,7 @@ We will define 2 users of the API, which can send requests to the API at differe ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toy Store API @@ -55,7 +55,7 @@ spec: method: GET backendRefs: - name: toystore - port: 80 + port: 80 EOF ``` @@ -168,9 +168,10 @@ EOF ### Enforce authenticated rate limiting on requests to the Toy Store API -Create Kuadrant `RateLimitPolicy's` to configure rate limiting for Bob and Alice: +Create Kuadrant `RateLimitPolicy's` to configure rate limiting for Bob and Alice: ### Bob + ```sh kubectl apply -f - <