Docs #127

alexsnaps · 2022-09-09T17:31:52Z

closes #114

eguzki

looking super good

eguzki · 2022-09-12T20:29:44Z

README.md

@@ -3,8 +3,8 @@
 [![Limitador GH Workflow](https://github.com/Kuadrant/limitador/actions/workflows/rust.yml/badge.svg)](https://github.com/Kuadrant/limitador/actions/workflows/rust.yml)
 [![docs.rs](https://docs.rs/limitador/badge.svg)](https://docs.rs/limitador)
 [![Crates.io](https://img.shields.io/crates/v/limitador)](https://crates.io/crates/limitador)
-[![Docker Repository on Quay](https://quay.io/repository/3scale/limitador/status


this badge only makes sense if the image is being build using quay.io building system. Currently it is being build using GH actions, so this badge should point to GH workflows status badge

alexsnaps · 2022-09-22T17:02:44Z

This will need changes on the site still, I'm on it, and in the source possibly...

doc/migrations/conditions.md

guicassolato · 2022-09-23T13:29:05Z

doc/server/configuration.md

+
+## Command line configuration
+
+The preferred way of starting and configuring the Limitador instance is using the command line:


Suggested change

The preferred way of starting and configuring the Limitador instance is using the command line:

The preferred way of starting and configuring the Limitador server is using the command line:

guicassolato · 2022-09-23T13:38:53Z

doc/server/configuration.md

+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "namespace": {
+      "type": "string"
+    },
+    "seconds": {
+      "type": "integer"
+    },
+    "max_value": {
+      "type": "integer"
+    },
+    "conditions": {
+      "type": "array",
+      "items": [
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "variables": {
+      "type": "array",
+      "items": [
+        {
+          "type": "string"
+        }
+      ]
+    }
+  },
+  "required": [
+    "namespace",
+    "seconds",
+    "max_value",
+    "conditions",
+    "variables"
+  ]
+}
+```


Although it doesn't change much, it could also be stated as a YAML schema:

--- "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string namespace: type: string seconds: type: integer max_value: type: integer conditions: type: array items: - type: string variables: type: array items: - type: string required: - namespace - seconds - max_value - conditions - variables

guicassolato · 2022-09-23T13:39:58Z

doc/server/configuration.md

+ - `namespace` namespaces the limit, will generally be the domain, [see here](../how-it-works.md)
+ - `seconds` is the duration for which the limit applies, in seconds: e.g. `60` is a span of time of one minute
+ - `max_value` is the actual limit, e.g. `100` would limit to 100 requests
+ - `name` lets the user _optionally_ name the limit


I didn't know we had this option. Nice! 🙂

guicassolato · 2022-09-23T13:42:16Z

doc/server/configuration.md

+
+#### `redis`
+
+When you want persistence of your counters, such as for DR or across restarts, using `redis` will store the counters in 


I'd avoid the acronym here.

guicassolato · 2022-09-23T13:44:21Z

doc/server/configuration.md

+
+When you want persistence of your counters, such as for DR or across restarts, using `redis` will store the counters in 
+a redis instance using the provided `URL`. Increments to _individual_ counters is made within redis itself, providing 
+accuracy over these, races tho can occur when multiple limitador servers are used against a single redis and using 


Suggested change

accuracy over these, races tho can occur when multiple limitador servers are used against a single redis and using

accuracy over these, races tho can occur when multiple Limitador servers are used against a single redis and using

guicassolato · 2022-09-23T13:44:47Z

doc/server/configuration.md

+#### `redis_cached`
+
+In order to avoid some communication overhead to redis, `redis_cached` adds an in memory caching layer within the 
+limitador servers. This lowers the latency, but sacrifices some accuracy as it will not only cache counters, but also


Suggested change

limitador servers. This lowers the latency, but sacrifices some accuracy as it will not only cache counters, but also

Limitador servers. This lowers the latency, but sacrifices some accuracy as it will not only cache counters, but also

guicassolato · 2022-09-23T13:46:20Z

doc/server/configuration.md

+
+#### `LIMITS_FILE`
+
+- YAML file that contains the limits to create when limitador boots. If the


Suggested change

- YAML file that contains the limits to create when limitador boots. If the

- YAML file that contains the limits to create when Limitador boots. If the

guicassolato · 2022-09-23T13:46:28Z

doc/server/configuration.md

+#### `LIMITS_FILE`
+
+- YAML file that contains the limits to create when limitador boots. If the
+limits specified already have counters associated, limitador will not delete them.


Suggested change

limits specified already have counters associated, limitador will not delete them.

limits specified already have counters associated, Limitador will not delete them.

Removed limit modifying end points

0024a79

alexsnaps added area/doc Improvements or additions to documentation target/current labels Sep 9, 2022

alexsnaps added this to the Limitador Server v1.0.0 milestone Sep 9, 2022

alexsnaps requested a review from eguzki September 9, 2022 17:31

alexsnaps self-assigned this Sep 9, 2022

eguzki reviewed Sep 12, 2022

View reviewed changes

alexsnaps force-pushed the docs branch 5 times, most recently from 01b9004 to 50c8737 Compare September 22, 2022 15:48

alexsnaps marked this pull request as ready for review September 22, 2022 17:02

alexsnaps requested review from eguzki and guicassolato September 22, 2022 17:02

alexsnaps added 5 commits September 23, 2022 08:28

Initial README split

4c7512e

Moved site docs to project's root

0903a16

Phase one

e77cebc

added migration guide for limit's condition syntax

67313d2

URL chang to migration guide

1576eeb

alexsnaps force-pushed the docs branch from 07d8d80 to 1576eeb Compare September 23, 2022 12:28

guicassolato reviewed Sep 23, 2022

View reviewed changes

doc/migrations/conditions.md Show resolved Hide resolved

guicassolato reviewed Sep 23, 2022

View reviewed changes

Fix

2d77ddf

guicassolato reviewed Sep 23, 2022

View reviewed changes

Addressing PR comments

411f95a

guicassolato approved these changes Sep 27, 2022

View reviewed changes

alexsnaps merged commit 27c106f into main Sep 28, 2022

eguzki deleted the docs branch October 4, 2022 14:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs #127

Docs #127

alexsnaps commented Sep 9, 2022

eguzki left a comment

eguzki Sep 12, 2022

alexsnaps commented Sep 22, 2022

guicassolato Sep 23, 2022

guicassolato Sep 23, 2022

guicassolato Sep 23, 2022

guicassolato Sep 23, 2022

guicassolato Sep 23, 2022

guicassolato Sep 23, 2022

guicassolato Sep 23, 2022

guicassolato Sep 23, 2022


		## Command line configuration

		The preferred way of starting and configuring the Limitador instance is using the command line:


		#### `redis`

		When you want persistence of your counters, such as for DR or across restarts, using `redis` will store the counters in

	accuracy over these, races tho can occur when multiple limitador servers are used against a single redis and using
	accuracy over these, races tho can occur when multiple Limitador servers are used against a single redis and using

	limitador servers. This lowers the latency, but sacrifices some accuracy as it will not only cache counters, but also
	Limitador servers. This lowers the latency, but sacrifices some accuracy as it will not only cache counters, but also


		#### `LIMITS_FILE`

		- YAML file that contains the limits to create when limitador boots. If the

	limits specified already have counters associated, limitador will not delete them.
	limits specified already have counters associated, Limitador will not delete them.

Docs #127

Docs #127

Conversation

alexsnaps commented Sep 9, 2022

eguzki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexsnaps commented Sep 22, 2022

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