Update docs to gateway-api/v1

Kuadrant · Nov 1, 2023 · 5b9780e · 5b9780e
1 parent f07667b
commit 5b9780e
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 29 deletions.
diff --git 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.
 
 <!--ts-->
-* [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 <em>API Provider</em>](#if-you-are-an-api-provider)
-      * [If you are a <em>Cluster Operator</em>](#if-you-are-a-cluster-operator)
-* [User guides](#user-guides)
-* [<a href="doc/rate-limiting.md">Kuadrant Rate Limiting</a>](#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)
 
 <!--te-->
 
@@ -144,15 +146,15 @@ 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.
 
 #### 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
@@ -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
@@ -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
@@ -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
@@ -77,7 +77,7 @@ EOF
 kubectl apply -f examples/toystore/toystore.yaml
 
 kubectl apply -f - <<EOF
-apiVersion: gateway.networking.k8s.io/v1beta1
+apiVersion: gateway.networking.k8s.io/v1
 kind: HTTPRoute
 metadata:
   name: toystore
@@ -258,7 +258,7 @@ Create a route that will inherit the default policy attached to the gateway:
 
 ```sh
 kubectl apply -f -<<EOF
-apiVersion: gateway.networking.k8s.io/v1beta1
+apiVersion: gateway.networking.k8s.io/v1
 kind: HTTPRoute
 metadata:
   name: other

diff --git a/doc/user-guides/authenticated-rl-for-app-developers.md b/doc/user-guides/authenticated-rl-for-app-developers.md
@@ -69,7 +69,7 @@ Create a HTTPRoute to route traffic to the service via Istio Ingress Gateway:
 
 ```sh
 kubectl apply -f - <<EOF
-apiVersion: gateway.networking.k8s.io/v1beta1
+apiVersion: gateway.networking.k8s.io/v1
 kind: HTTPRoute
 metadata:
   name: toystore

diff --git a/doc/user-guides/gateway-rl-for-cluster-operators.md b/doc/user-guides/gateway-rl-for-cluster-operators.md
@@ -41,7 +41,7 @@ EOF
 
 ```sh
 kubectl -n istio-system apply -f - <<EOF
-apiVersion: gateway.networking.k8s.io/v1beta1
+apiVersion: gateway.networking.k8s.io/v1
 kind: Gateway
 metadata:
   name: external
@@ -59,7 +59,7 @@ spec:
       namespaces:
         from: All
 ---
-apiVersion: gateway.networking.k8s.io/v1beta1
+apiVersion: gateway.networking.k8s.io/v1
 kind: Gateway
 metadata:
   name: internal
@@ -156,7 +156,7 @@ Route traffic to the API from both gateways:
 
 ```sh
 kubectl apply -f - <<EOF
-apiVersion: gateway.networking.k8s.io/v1beta1
+apiVersion: gateway.networking.k8s.io/v1
 kind: HTTPRoute
 metadata:
   name: toystore

diff --git a/doc/user-guides/simple-rl-for-app-developers.md b/doc/user-guides/simple-rl-for-app-developers.md
@@ -57,7 +57,7 @@ Create a HTTPRoute to route traffic to the service via Istio Ingress Gateway:
 
 ```sh
 kubectl apply -f - <<EOF
-apiVersion: gateway.networking.k8s.io/v1beta1
+apiVersion: gateway.networking.k8s.io/v1
 kind: HTTPRoute
 metadata:
   name: toystore