From 5b9780e2eb49371d18f960487af52ef0eb1de191 Mon Sep 17 00:00:00 2001 From: Adam Cattermole Date: Fri, 27 Oct 2023 15:59:55 +0100 Subject: [PATCH] Update docs to gateway-api/v1 --- README.md | 36 ++++++++++--------- doc/auth.md | 2 +- doc/rate-limiting.md | 2 +- doc/reference/route-selectors.md | 6 ++-- ...uth-for-app-devs-and-platform-engineers.md | 4 +-- .../authenticated-rl-for-app-developers.md | 2 +- .../gateway-rl-for-cluster-operators.md | 6 ++-- .../simple-rl-for-app-developers.md | 2 +- 8 files changed, 31 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index c8dd8694b..e793a8ef9 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,23 @@ The Operator to install and manage the lifecycle of the [Kuadrant](https://github.com/Kuadrant/) components deployments. -* [Overview](#overview) -* [Architecture](#architecture) - * [Kuadrant components](#kuadrant-components) - * [Provided APIs](#provided-apis) -* [Getting started](#getting-started) - * [Pre-requisites](#pre-requisites) - * [Installing Kuadrant](#installing-kuadrant) - * [Protect Your Service](#protect-your-service) - * [If you are an API Provider](#if-you-are-an-api-provider) - * [If you are a Cluster Operator](#if-you-are-a-cluster-operator) -* [User guides](#user-guides) -* [Kuadrant Rate Limiting](#kuadrant-rate-limiting) -* [Documentation](#documentation) -* [Contributing](#contributing) -* [Licensing](#licensing) +- [Overview](#overview) +- [Architecture](#architecture) + - [Kuadrant components](#kuadrant-components) + - [Provided APIs](#provided-apis) +- [Getting started](#getting-started) + - [Pre-requisites](#pre-requisites) + - [Installing Kuadrant](#installing-kuadrant) + - [1. Install the Kuadrant Operator](#1-install-the-kuadrant-operator) + - [2. Request a Kuadrant instance](#2-request-a-kuadrant-instance) + - [Protect your service](#protect-your-service) + - [If you are an *API Provider*](#if-you-are-an-api-provider) + - [If you are a *Cluster Operator*](#if-you-are-a-cluster-operator) +- [User guides](#user-guides) +- [Kuadrant Rate Limiting](#kuadrant-rate-limiting) +- [Documentation](#documentation) +- [Contributing](#contributing) +- [Licensing](#licensing) @@ -144,7 +146,7 @@ EOF * Deploy the service/API to be protected ("Upstream") * Expose the service/API using the kubernetes Gateway API, ie - [HTTPRoute](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1beta1.HTTPRoute) object. + [HTTPRoute](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute) object. * Write and apply the Kuadrant's [RateLimitPolicy](doc/rate-limiting.md) and/or [AuthPolicy](doc/auth.md) custom resources targeting the HTTPRoute resource to have your API protected. @@ -152,7 +154,7 @@ EOF #### If you are a *Cluster Operator* * (Optionally) deploy istio ingress gateway using the - [Gateway](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1beta1.Gateway) resource. + [Gateway](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.Gateway) resource. * Write and apply the Kuadrant's [RateLimitPolicy](doc/rate-limiting.md) and/or [AuthPolicy](doc/auth.md) custom resources targeting the Gateway resource to have your gateway traffic protected. diff --git a/doc/auth.md b/doc/auth.md index ae2796287..92934b1bd 100644 --- a/doc/auth.md +++ b/doc/auth.md @@ -2,7 +2,7 @@ A Kuadrant AuthPolicy custom resource: -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 enforce auth. +1. Targets Gateway API networking resources such as [HTTPRoutes](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute) and [Gateways](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.Gateway), using these resources to obtain additional context, i.e., which traffic workload (HTTP attributes, hostnames, user attributes, etc) to enforce auth. 2. Supports targeting subsets (sections) of a network resource to apply the auth rules to. 3. Abstracts the details of the underlying external authorization 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. diff --git a/doc/rate-limiting.md b/doc/rate-limiting.md index 25aa329d5..24db2c435 100644 --- a/doc/rate-limiting.md +++ b/doc/rate-limiting.md @@ -2,7 +2,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. +1. Targets Gateway API networking resources such as [HTTPRoutes](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute) and [Gateways](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.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 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. diff --git a/doc/reference/route-selectors.md b/doc/reference/route-selectors.md index 45f499611..66a38b134 100644 --- a/doc/reference/route-selectors.md +++ b/doc/reference/route-selectors.md @@ -12,12 +12,12 @@ The `routeSelectors` field can be found in policy specs and policy rules (limit ### RouteSelector -Each `RouteSelector` is an object composed of a set of [HTTPRouteMatch](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.HTTPPathMatch) objects (from Gateway API), and an additional `hostnames` field. +Each `RouteSelector` is an object composed of a set of [HTTPRouteMatch](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPPathMatch) objects (from Gateway API), and an additional `hostnames` field. | **Field** | **Type** | **Required** | **Description** | |-------------|--------------------------------------------------------------------------------------------------------------------------------|:------------:|---------------------------------------------------------------------------------------------| -| `matches` | [][HTTPRouteMatch](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1beta1.HTTPRouteMatch) | No | List of selectors of HTTPRouteRules whose matching rules activate the policy or policy rule | -| `hostnames` | [][Hostname](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1beta1.Hostname) | No | List of hostnames of the HTTPRoute that activate the policy or policy rule | +| `matches` | [][HTTPRouteMatch](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteMatch) | No | List of selectors of HTTPRouteRules whose matching rules activate the policy or policy rule | +| `hostnames` | [][Hostname](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.Hostname) | No | List of hostnames of the HTTPRoute that activate the policy or policy rule | ## Mechanics of the route selectors diff --git a/doc/user-guides/auth-for-app-devs-and-platform-engineers.md b/doc/user-guides/auth-for-app-devs-and-platform-engineers.md index 4e1b13551..3e736a00e 100644 --- a/doc/user-guides/auth-for-app-devs-and-platform-engineers.md +++ b/doc/user-guides/auth-for-app-devs-and-platform-engineers.md @@ -77,7 +77,7 @@ EOF kubectl apply -f examples/toystore/toystore.yaml kubectl apply -f - <