From 4bf902a6187db3dfe6e3071c7f0c187bb679e8f1 Mon Sep 17 00:00:00 2001 From: Guilherme Cassolato Date: Fri, 20 Oct 2023 07:25:51 +0200 Subject: [PATCH] docs: fix typos --- doc/auth.md | 2 +- doc/rate-limiting.md | 4 ++-- doc/reference/authpolicy.md | 4 ++-- doc/reference/ratelimitpolicy.md | 12 ++++++------ 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/auth.md b/doc/auth.md index 73057723b..ae2796287 100644 --- a/doc/auth.md +++ b/doc/auth.md @@ -68,7 +68,7 @@ spec: value: "/admin" # Additional dynamic conditions to trigger the AuthPolicy. - # Use it for filterring attributes not supported by HTTPRouteRule or with AuthPolicies that target a Gateway. + # Use it for filtering attributes not supported by HTTPRouteRule or with AuthPolicies that target a Gateway. # Check out https://github.com/Kuadrant/architecture/blob/main/rfcs/0002-well-known-attributes.md to learn more # about the Well-known Attributes that can be used in this field. when: […] diff --git a/doc/rate-limiting.md b/doc/rate-limiting.md index b096ca083..25aa329d5 100644 --- a/doc/rate-limiting.md +++ b/doc/rate-limiting.md @@ -3,7 +3,7 @@ A Kuadrant RateLimitPolicy custom resource, often abbreviated "RLP": 1. Targets Gateway API networking resources such as [HTTPRoutes](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.HTTPRoute) and [Gateways](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.Gateway), using these resources to obtain additional context, i.e., which traffic workload (HTTP attributes, hostnames, user attributes, etc) to rate limit. -2. Supports targeting subsets (sections) of a network resource resource to apply the limits to. +2. Supports targeting subsets (sections) of a network resource to apply the limits to. 3. Abstracts the details of the underlying Rate Limit protocol and configuration resources, that have a much broader remit and surface area. 4. Enables cluster operators to set defaults that govern behavior at the lower levels of the network, until a more specific policy is applied. @@ -77,7 +77,7 @@ spec: routeSelectors: […] # (optional) additional dynamic conditions to trigger the limit. - # use it for filterring attributes not supported by HTTPRouteRule or with RateLimitPolicies that target a Gateway + # use it for filtering attributes not supported by HTTPRouteRule or with RateLimitPolicies that target a Gateway # check out Kuadrant RFC 0002 (https://github.com/Kuadrant/architecture/blob/main/rfcs/0002-well-known-attributes.md) to learn more about the Well-known Attributes that can be used in this field when: […] ``` diff --git a/doc/reference/authpolicy.md b/doc/reference/authpolicy.md index 5dbe273b4..7a8e0d85f 100644 --- a/doc/reference/authpolicy.md +++ b/doc/reference/authpolicy.md @@ -30,7 +30,7 @@ | `rules` | [AuthScheme](#authscheme) | No | Authentication/authorization rules | | `routeSelectors` | [][RouteSelector](route-selectors.md#routeselector) | No | List of selectors of HTTPRouteRules whose matching rules activate the policy. At least one HTTPRouteRule must be selected to activate the policy. If omitted, all HTTPRouteRules of the targeted HTTPRoute activate the policy. Do not use it in policies targeting a Gateway. | | `patterns` | Map | No | Named patterns of lists of `selector`, `operator` and `value` tuples, to be reused in `when` conditions and pattern-matching authorization rules. | -| `when` | [][PatternExpressionOrRef](https://docs.kuadrant.io/authorino/docs/features/#common-feature-conditions-when) | No | List of additional dynamic conditions (expressions) to activate the policy. Use it for filterring attributes that cannot be expressed in the targeted HTTPRoute's `spec.hostnames` and `spec.rules.matches` fields, or when targeting a Gateway. | +| `when` | [][PatternExpressionOrRef](https://docs.kuadrant.io/authorino/docs/features/#common-feature-conditions-when) | No | List of additional dynamic conditions (expressions) to activate the policy. Use it for filtering attributes that cannot be expressed in the targeted HTTPRoute's `spec.hostnames` and `spec.rules.matches` fields, or when targeting a Gateway. | ### AuthScheme @@ -47,7 +47,7 @@ | **Field** | **Type** | **Required** | **Description** | |-------------------------|--------------------------------------------------------------------------------------------------------------|:------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `routeSelectors` | [][RouteSelector](route-selectors.md#routeselector) | No | List of selectors of HTTPRouteRules whose matching rules activate the auth rule. At least one HTTPRouteRule must be selected to activate the auth rule. If omitted, the auth rule is activated at all requests where the policy is enforced. Do not use it in policies targeting a Gateway. | -| `when` | [][PatternExpressionOrRef](https://docs.kuadrant.io/authorino/docs/features/#common-feature-conditions-when) | No | List of additional dynamic conditions (expressions) to activate the auth rule. Use it for filterring attributes that cannot be expressed in the targeted HTTPRoute's `spec.hostnames` and `spec.rules.matches` fields, or when targeting a Gateway. | +| `when` | [][PatternExpressionOrRef](https://docs.kuadrant.io/authorino/docs/features/#common-feature-conditions-when) | No | List of additional dynamic conditions (expressions) to activate the auth rule. Use it for filtering attributes that cannot be expressed in the targeted HTTPRoute's `spec.hostnames` and `spec.rules.matches` fields, or when targeting a Gateway. | | `cache` | [Caching spec](https://docs.kuadrant.io/authorino/docs/features/#common-feature-caching-cache) | No | Caching options for the resolved object returned when applying this auth rule. (Default: disabled) | | `priority` | Integer | No | Priority group of the auth rule. All rules in the same priority group are evaluated concurrently; consecutive priority groups are evaluated sequentially. (Default: `0`) | | `metrics` | Boolean | No | Whether the auth rule emits individual observability metrics. (Default: `false`) | diff --git a/doc/reference/ratelimitpolicy.md b/doc/reference/ratelimitpolicy.md index 435f344f3..711b08569 100644 --- a/doc/reference/ratelimitpolicy.md +++ b/doc/reference/ratelimitpolicy.md @@ -24,12 +24,12 @@ ### Limit -| **Field** | **Type** | **Required** | **Description** | -|------------------|-----------------------------------------------------|:------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `rates` | [][RateLimit](#ratelimit) | No | List of rate limits associated with the limit definition | -| `counters` | []String | No | List of rate limit counter qualifiers. Items must be a valid [Well-known attribute](https://github.com/Kuadrant/architecture/blob/main/rfcs/0002-well-known-attributes.md). Each distinct value resolved in the data plane starts a separate counter for each rate limit. | -| `routeSelectors` | [][RouteSelector](route-selectors.md#routeselector) | No | List of selectors of HTTPRouteRules whose matching rules activate the limit. At least one HTTPRouteRule must be selected to activate the limit. If omitted, all HTTPRouteRules of the targeted HTTPRoute activate the limit. Do not use it in policies targeting a Gateway. | -| `when` | [][WhenCondition](#whencondition) | No | List of additional dynamic conditions (expressions) to activate the limit. All expression must evaluate to true for the limit to be applied. Use it for filterring attributes that cannot be expressed in the targeted HTTPRoute's `spec.hostnames` and `spec.rules.matches` fields, or when targeting a Gateway. | +| **Field** | **Type** | **Required** | **Description** | +|------------------|-----------------------------------------------------|:------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `rates` | [][RateLimit](#ratelimit) | No | List of rate limits associated with the limit definition | +| `counters` | []String | No | List of rate limit counter qualifiers. Items must be a valid [Well-known attribute](https://github.com/Kuadrant/architecture/blob/main/rfcs/0002-well-known-attributes.md). Each distinct value resolved in the data plane starts a separate counter for each rate limit. | +| `routeSelectors` | [][RouteSelector](route-selectors.md#routeselector) | No | List of selectors of HTTPRouteRules whose matching rules activate the limit. At least one HTTPRouteRule must be selected to activate the limit. If omitted, all HTTPRouteRules of the targeted HTTPRoute activate the limit. Do not use it in policies targeting a Gateway. | +| `when` | [][WhenCondition](#whencondition) | No | List of additional dynamic conditions (expressions) to activate the limit. All expression must evaluate to true for the limit to be applied. Use it for filtering attributes that cannot be expressed in the targeted HTTPRoute's `spec.hostnames` and `spec.rules.matches` fields, or when targeting a Gateway. | #### RateLimit