Adding/updating RLP use cases to docs #964

R-Lawton · 2024-10-29T16:09:27Z

WHAT

Added or modified docs to add more scenarios for RLP
Updated current docs to be more cohesive.
Linter updated spacing etc

TODO:

eguzki · 2024-11-06T14:28:26Z

Heads up! RLP API is changing #976

R-Lawton · 2024-11-22T17:58:21Z

config/install/README.md

@@ -10,7 +10,7 @@
 - Accessible Redis instance, for persistent storage for your rate limit counters. (Optional)


-> Note: By default the following guide will install the "latest" or "main" version of Kuadrant. To pick a specific version, change the image in the `config/deploy/install/standard/kustomization.yaml`. All versions available can be found on the Kuadrant operator [release page](https://github.com/Kuadrant/kuadrant-operator/releases)


this directory doesnt exist

R-Lawton · 2024-11-22T17:58:46Z

config/install/standard/kuadrant-version.yaml

@@ -3,4 +3,4 @@ kind: CatalogSource
 metadata:
  name: kuadrant-operator-catalog
 spec:
-  image: quay.io/kuadrant/kuadrant-operator-catalog:v1.0.0-rc6 #change this to the version you want to install


default should be latest

R-Lawton · 2024-11-22T18:14:14Z

doc/apis-overview/tls.md

@@ -2,7 +2,7 @@

 A Kuadrant TLSPolicy custom resource:

-1. Targets Gateway API networking resources [Gateways](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.Gateway) to provide tls for gateway listeners by managing the lifecycle of tls certificates using [`CertManager`](https://cert-manager.io).
+Targets Gateway API networking resources [Gateways](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.Gateway) to provide tls for gateway listeners by managing the lifecycle of tls certificates using [`CertManager`](https://cert-manager.io).

 ## How it works



If you expand this file theres a lot of to do's. Do we plan on updating it for GA?

R-Lawton · 2024-11-22T18:20:59Z

doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md

-```
-
-### ② Deploy the Toy Store sample application (Persona: _App developer_)
+### Deploy the Toy Store sample application (Persona: _App developer_)


Removing the unicode numbering to match the rest of the docs and to make writing docs easier

R-Lawton · 2024-11-22T18:21:30Z

doc/user-guides/dns/gateway-dns.md

@@ -2,46 +2,32 @@

 This user guide walks you through an example of how to configure DNS for all routes attached to an ingress gateway.

-<br/>


no needed for docs website

R-Lawton · 2024-11-22T18:22:40Z

doc/user-guides/dns/orphan-dns-records.md

@@ -24,33 +24,37 @@ On cluster 2 the DNS Operator managing the existing DNSRecord in that cluster ha
 In prometheus alerts, it spots that the number of owners does not correlate to the number of DNSRecord resources and triggers an alert. 
 To remedy this rather than going to the DNS provider directly and trying to figure out which records to remove, you can instead follow the steps below.

-1) Get the owner id of the DNSRecord on cluster 2 for the shared host 
+Get the owner id of the DNSRecord on cluster 2 for the shared host 


We dont use numbering in a lot of our docs so removing to match

R-Lawton · 2024-11-22T18:25:36Z

doc/user-guides/ratelimiting/authenticated-rl-for-app.md

@@ -1,4 +1,4 @@
-# Authenticated Rate Limiting for Application Developers
+# Authenticated Rate Limiting for Applications


I think having the persona might put people off but happy to change

It is referring to the persona defined by Gateway API https://gateway-api.sigs.k8s.io/

R-Lawton · 2024-11-22T18:32:25Z

doc/user-guides/ratelimiting/multi-rlp-multi-listener.md

@@ -1,43 +1,19 @@
-# Gateway Rate Limiting for Cluster Operators
+# Rate limiting for ingress gateway


This was just confusing i didnt understand what cluster operators mean. So it would be confusing for users to

Same comment as https://github.com/Kuadrant/kuadrant-operator/pull/964/files#r1854464214

Maybe a reference to Gateway API docs could help on the confusion

jasonmadigan

couple of small suggestions

jasonmadigan · 2024-11-26T11:23:16Z

doc/install/install-kubernetes.md

@@ -1,7 +1,6 @@
 # Install Kuadrant on a Kubernetes cluster

 !!! note
-


does this render ok with mkdocs (checkout a branch locally, update mkdocs.yaml to point to this branch for the kuadrant-operator component) ? could be wrong by I vaguely recall that maybe these newlines were needed - worth a quick check

no i havent checked good shout ill double check

doc/install/install-make.md

doc/overviews/tls.md

doc/reference/ratelimitpolicy.md

doc/user-guides/dns/orphan-dns-records.md

doc/user-guides/ratelimiting/authenticated-rl-for-app.md

jasonmadigan · 2024-11-26T12:00:47Z

Is there a docs.kuadrant.io PR to go with this to shift some of the nav items (or add the newer guides)?

R-Lawton · 2024-11-26T12:15:30Z

Is there a docs.kuadrant.io PR to go with this to shift some of the nav items (or add the newer guides)?

Yeah i have a pr on hold to match these changes

eguzki

Overall looks good. Great job 🎖️

I left some comments

eguzki · 2024-11-29T12:30:34Z

README.md

@@ -35,7 +35,7 @@ to operate the cluster ingress gateway to provide API management with **authenti
 ### Kuadrant components

 | CRD                                                                  | Description                                                                                                                                                                                                                                                                               |
-|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |


I did not know you could do this. Certainly is working (I can see in https://github.com/R-Lawton/kuadrant-operator/tree/doc-updates)

I cant take credit was my linter 😁

eguzki · 2024-11-29T12:33:19Z

config/install/README.md

@@ -10,7 +10,7 @@
 - Accessible Redis instance, for persistent storage for your rate limit counters. (Optional)


-> Note: By default the following guide will install the "latest" or "main" version of Kuadrant. To pick a specific version, change the image in the `config/deploy/install/standard/kustomization.yaml`. All versions available can be found on the Kuadrant operator [release page](https://github.com/Kuadrant/kuadrant-operator/releases)
+> Note: By default the following guide will install the "latest" or "main" version of Kuadrant. To pick a specific version, change the image in the `config/install/standard/kustomization.yaml`. All versions available can be found on the Kuadrant operator [release page](https://github.com/Kuadrant/kuadrant-operator/releases)


maybe referring to config/install/standard/kuadrant-version.yaml ?

Oops yes this is old

doc/install/install-make.md

doc/overviews/rate-limiting.md

eguzki · 2024-11-29T13:33:45Z

doc/user-guides/ratelimiting/authenticated-rl-for-app.md

@@ -1,4 +1,4 @@
-# Authenticated Rate Limiting for Application Developers
+# Authenticated Rate Limiting for Applications


It is referring to the persona defined by Gateway API https://gateway-api.sigs.k8s.io/

doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md

eguzki · 2024-11-29T13:38:40Z

doc/user-guides/ratelimiting/multi-rlp-multi-listener.md

@@ -1,43 +1,19 @@
-# Gateway Rate Limiting for Cluster Operators
+# Rate limiting for ingress gateway


Same comment as https://github.com/Kuadrant/kuadrant-operator/pull/964/files#r1854464214

eguzki · 2024-11-29T13:39:19Z

doc/user-guides/ratelimiting/multi-rlp-multi-listener.md

@@ -1,43 +1,19 @@
-# Gateway Rate Limiting for Cluster Operators
+# Rate limiting for ingress gateway


Maybe a reference to Gateway API docs could help on the confusion

R-Lawton · 2024-11-29T17:42:55Z

/hold
Double checking all looks ok on docs website

eguzki

This rocks!

Signed-off-by: R-Lawton <[email protected]>

R-Lawton · 2024-12-02T11:23:43Z

/unhold

jasonmadigan · 2024-12-02T14:40:22Z

@R-Lawton can you cherry-pick this into release-v1.0.0? Will get picked up by Kuadrant/docs.kuadrant.io#148 then

R-Lawton changed the title ~~Adding RLP use cases~~ Adding RLP use cases to docs Oct 29, 2024

R-Lawton assigned R-Lawton and unassigned R-Lawton Oct 30, 2024

R-Lawton force-pushed the doc-updates branch from 12d8c11 to 2227487 Compare November 7, 2024 11:26

R-Lawton force-pushed the doc-updates branch 3 times, most recently from 8dc13be to c9d98b4 Compare November 22, 2024 17:55

R-Lawton changed the title ~~Adding RLP use cases to docs~~ Adding/updating RLP use cases to docs Nov 22, 2024

R-Lawton force-pushed the doc-updates branch from c9d98b4 to bd681a2 Compare November 22, 2024 17:57

R-Lawton commented Nov 22, 2024

View reviewed changes

R-Lawton force-pushed the doc-updates branch from 5c03c8a to 65e93a2 Compare November 22, 2024 18:42

R-Lawton marked this pull request as ready for review November 22, 2024 18:43

R-Lawton force-pushed the doc-updates branch from 65e93a2 to f8d0443 Compare November 22, 2024 18:46

jasonmadigan reviewed Nov 26, 2024

View reviewed changes

R-Lawton force-pushed the doc-updates branch 2 times, most recently from d5a54fa to 4984c20 Compare November 29, 2024 11:38

eguzki reviewed Nov 29, 2024

View reviewed changes

eguzki approved these changes Dec 2, 2024

View reviewed changes

Adding new RLP scnerios and updating exisiting docs

d65966b

Signed-off-by: R-Lawton <[email protected]>

R-Lawton force-pushed the doc-updates branch from d3c2c62 to d65966b Compare December 2, 2024 11:18

R-Lawton merged commit 9e8480c into Kuadrant:main Dec 2, 2024
26 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding/updating RLP use cases to docs #964

Adding/updating RLP use cases to docs #964

R-Lawton commented Oct 29, 2024 •

edited

Loading

eguzki commented Nov 6, 2024

R-Lawton Nov 22, 2024

R-Lawton Nov 22, 2024

R-Lawton Nov 22, 2024

R-Lawton Nov 22, 2024

R-Lawton Nov 22, 2024

R-Lawton Nov 22, 2024

R-Lawton Nov 22, 2024

eguzki Nov 29, 2024

R-Lawton Nov 22, 2024

eguzki Nov 29, 2024

eguzki Nov 29, 2024

jasonmadigan left a comment

jasonmadigan Nov 26, 2024

R-Lawton Nov 26, 2024 •

edited

Loading

jasonmadigan commented Nov 26, 2024

R-Lawton commented Nov 26, 2024

eguzki left a comment

eguzki Nov 29, 2024

R-Lawton Nov 29, 2024

eguzki Nov 29, 2024

R-Lawton Nov 29, 2024

eguzki Nov 29, 2024

eguzki Nov 29, 2024

eguzki Nov 29, 2024

R-Lawton commented Nov 29, 2024

eguzki left a comment

R-Lawton commented Dec 2, 2024

jasonmadigan commented Dec 2, 2024

		@@ -10,7 +10,7 @@
		- Accessible Redis instance, for persistent storage for your rate limit counters. (Optional)


		> Note: By default the following guide will install the "latest" or "main" version of Kuadrant. To pick a specific version, change the image in the `config/deploy/install/standard/kustomization.yaml`. All versions available can be found on the Kuadrant operator [release page](https://github.com/Kuadrant/kuadrant-operator/releases)

		@@ -2,46 +2,32 @@

		This user guide walks you through an example of how to configure DNS for all routes attached to an ingress gateway.

		<br/>

		@@ -1,4 +1,4 @@
		# Authenticated Rate Limiting for Application Developers
		# Authenticated Rate Limiting for Applications

		@@ -1,43 +1,19 @@
		# Gateway Rate Limiting for Cluster Operators
		# Rate limiting for ingress gateway

		@@ -1,7 +1,6 @@
		# Install Kuadrant on a Kubernetes cluster

		!!! note

Adding/updating RLP use cases to docs #964

Adding/updating RLP use cases to docs #964

Conversation

R-Lawton commented Oct 29, 2024 • edited Loading

WHAT

eguzki commented Nov 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasonmadigan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

R-Lawton Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

jasonmadigan commented Nov 26, 2024

R-Lawton commented Nov 26, 2024

eguzki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

R-Lawton commented Nov 29, 2024

eguzki left a comment

Choose a reason for hiding this comment

R-Lawton commented Dec 2, 2024

jasonmadigan commented Dec 2, 2024

R-Lawton commented Oct 29, 2024 •

edited

Loading

R-Lawton Nov 26, 2024 •

edited

Loading