Update RLP docs and examples for v1beta2 #233

guicassolato · 2023-08-22T18:57:15Z

Main Rate limit docs page located at doc/rate-limiting.md
RateLimitPolicy CRD reference doc
Basic RLP examples of targeting a HTTPRoute and targeting a Gateway
User guides
- Simple Rate Limiting for Application Developers
- Authenticated Rate Limiting for Application Developers
- Rate Limiting for Cluster Operators
- Authenticated Rate Limiting with JWTs and Kubernetes RBAC

Closes #215

codecov · 2023-08-22T19:00:44Z

Codecov Report

Merging #233 (7b50255) into main (6f3b3fd) will decrease coverage by 2.21%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #233      +/-   ##
==========================================
- Coverage   64.79%   62.59%   -2.21%     
==========================================
  Files          33       33              
  Lines        3224     3224              
==========================================
- Hits         2089     2018      -71     
- Misses        972     1021      +49     
- Partials      163      185      +22

Flag	Coverage Δ
integration	`67.18% <ø> (-4.63%)`	⬇️
unit	`58.41% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
api/v1beta1 (u)	`∅ <ø> (∅)`
pkg/common (u)	`76.99% <ø> (ø)`
pkg/istio (u)	`29.69% <ø> (ø)`
pkg/log (u)	`31.81% <ø> (ø)`
pkg/reconcilers (u)	`33.68% <ø> (ø)`
pkg/rlptools (u)	`57.63% <ø> (ø)`
controllers (i)	`67.18% <ø> (-4.63%)`	⬇️

see 7 files with indirect coverage changes

eguzki

Excellent work 🎖️

Minor changes requested

eguzki · 2023-08-29T17:00:19Z

doc/rate-limiting.md

-
-## How: Implementation details
-
-### The WASM Filter


kind of pity to lose this piece of information. People will recurrently ask the famous question: "why are you guys using Wasm module instead of Envoy's rate limit filter?" This section captures the rationale behind that decision.

What about moving this part to a separated file called rate-limiting-using-wasm-module.md?

It took me a little while to re-write it, but I've added the section back to the doc.

eguzki · 2023-08-29T17:15:27Z

doc/user-guides/authenticated-rl-with-jwt-and-k8s-authnz.md


 Create the namesapce:

 ```sh
 kubectl create namespace keycloak
 ```

-Deploy Keycloak:
+Deploy Keycloak with a [bootstrap](https://github.com/kuadrant/authorino-examples#keycloak) realm, users, and clients:

 ```sh
 kubectl apply -n keycloak -f https://raw.githubusercontent.com/Kuadrant/authorino-examples/main/keycloak/keycloak-deploy.yaml


maybe not for this PR, but we may want to bring (a copy of) these resources to this repo.

I believe that having a shared repo that the different components can pull sample apps from may contribute to keeping consistent user guides and user stories across. Maybe we could make https://github.com/Kuadrant/authorino-examples more about Kuadrant as well? I wouldn't mind renaming it to "kuadrant-examples" if we think that would help.

My request was not about ownership. In other words authorino-examples is ok for me. It was about, what if you change those resources to accommodate to new features or spec of Authorino? I fear that it would break the guides in the kuadrant operator. Anyway, raising this for awareness, not for this PR.

eguzki · 2023-08-29T17:20:46Z

doc/user-guides/authenticated-rl-with-jwt-and-k8s-authnz.md

@@ -1,41 +1,77 @@
-# Rate-limiting and protecting an API with JSON Web Tokens (JWTs) and Kubernetes authnz using Kuadrant
+# Authenticated Rate Limiting with JWTs and Kubernetes RBAC


Just an idea for the future. It would be very nice to run e2e tests exactly as the user guides define, adding some assertions. Even better would be to run tests reading the markdown files.

doc/user-guides/gateway-rl-for-cluster-operators.md

eguzki · 2023-08-29T18:44:56Z

doc/user-guides/simple-rl-for-app-developers.md

+
+Create a HTTPRoute to route traffic to the service via Istio Ingress Gateway:
+
+![](https://i.imgur.com/rdN8lo3.png)


we should be moving to ascii diagrams at some point

not for this PR, unless you want to

eguzki · 2023-08-29T18:50:50Z

examples/toystore/ratelimitpolicy_gateway.yaml

@@ -1,5 +1,4 @@
---


I cannot find any reference to this file. It must be a leftover from and old user guide. I vote for deleting the files

decided offline to keep them for now.

eguzki · 2023-08-29T18:50:57Z

examples/toystore/ratelimitpolicy_httproute.yaml

@@ -1,5 +1,4 @@
---


I cannot find any reference to this file. It must be a leftover from and old user guide. I vote for deleting the files

… Ops user guide

… doc

guicassolato self-assigned this Aug 22, 2023

guicassolato force-pushed the docs/rlp-v2 branch 2 times, most recently from 7e8b911 to a6b9af4 Compare August 25, 2023 13:53

guicassolato added 2 commits August 25, 2023 15:55

Update RLP docs and examples for v1beta2

2e9ca55

docs: RateLimitPolicy CRD reference

2b08fb6

guicassolato force-pushed the docs/rlp-v2 branch from a6b9af4 to 7ff069f Compare August 25, 2023 13:55

guicassolato added 3 commits August 28, 2023 12:06

docs: Authenticated Rate Limiting for Application Developers

f24dea3

docs: Simple Rate Limiting for Application Developers

45afe3d

docs: Gateway Rate Limiting for Cluster Operators

03456eb

guicassolato force-pushed the docs/rlp-v2 branch from 7ff069f to 03456eb Compare August 28, 2023 10:08

docs: Authenticated Rate Limiting with JWTs and Kubernetes RBAC

ee6fbb7

guicassolato marked this pull request as ready for review August 28, 2023 11:26

guicassolato requested a review from a team as a code owner August 28, 2023 11:26

Pointing the main rate limiting page to the related user guides

a52e924

guicassolato force-pushed the docs/rlp-v2 branch from 0731f3b to a52e924 Compare August 29, 2023 15:09

eguzki requested changes Aug 29, 2023

View reviewed changes

guicassolato added 2 commits August 30, 2023 10:49

fix number of steps and gateway port numbers in the GW RL for Cluster…

c48d3c3

… Ops user guide

Added 'implementation details' section back to the rate limiting main…

7b50255

… doc

guicassolato requested a review from eguzki August 30, 2023 13:56

guicassolato mentioned this pull request Aug 30, 2023

feat: upgrade to Go 1.20 #239

Merged

eguzki approved these changes Aug 30, 2023

View reviewed changes

guicassolato merged commit aa05f01 into main Aug 30, 2023
16 of 17 checks passed

guicassolato deleted the docs/rlp-v2 branch August 30, 2023 16:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update RLP docs and examples for v1beta2 #233

Update RLP docs and examples for v1beta2 #233

guicassolato commented Aug 22, 2023 •

edited

Loading

codecov bot commented Aug 22, 2023 •

edited

Loading

eguzki left a comment

eguzki Aug 29, 2023

guicassolato Aug 30, 2023

eguzki Aug 29, 2023

guicassolato Aug 30, 2023

eguzki Aug 30, 2023

eguzki Aug 29, 2023

eguzki Aug 30, 2023

eguzki Aug 29, 2023

eguzki Aug 29, 2023

eguzki Aug 29, 2023

eguzki Aug 30, 2023

eguzki Aug 29, 2023

		@@ -1,41 +1,77 @@
		# Rate-limiting and protecting an API with JSON Web Tokens (JWTs) and Kubernetes authnz using Kuadrant
		# Authenticated Rate Limiting with JWTs and Kubernetes RBAC


		Create a HTTPRoute to route traffic to the service via Istio Ingress Gateway:

		![](https://i.imgur.com/rdN8lo3.png)

Update RLP docs and examples for v1beta2 #233

Update RLP docs and examples for v1beta2 #233

Conversation

guicassolato commented Aug 22, 2023 • edited Loading

codecov bot commented Aug 22, 2023 • edited Loading

Codecov Report

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

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

guicassolato commented Aug 22, 2023 •

edited

Loading

codecov bot commented Aug 22, 2023 •

edited

Loading