From dce6a86900ae56740c2d1e73ee5305f1229f1478 Mon Sep 17 00:00:00 2001 From: Kevin Pollet Date: Fri, 19 Feb 2021 17:16:03 +0100 Subject: [PATCH] Fix Kubernetes Gateway API documentation links --- docs/content/providers/kubernetes-gateway.md | 14 +++++++------- .../routing/providers/kubernetes-gateway.md | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/content/providers/kubernetes-gateway.md b/docs/content/providers/kubernetes-gateway.md index 761444ae3..0ba84abd6 100644 --- a/docs/content/providers/kubernetes-gateway.md +++ b/docs/content/providers/kubernetes-gateway.md @@ -6,7 +6,7 @@ The Kubernetes Gateway API, The Experimental Way. Gateway API is the evolution of Kubernetes APIs that relate to `Services`, such as `Ingress`. The Gateway API project is part of Kubernetes, working under SIG-NETWORK. -The Kubernetes Gateway provider is a Traefik implementation of the [Service APIs](https://kubernetes-sigs.github.io/gateway-api/) +The Kubernetes Gateway provider is a Traefik implementation of the [Gateway API](https://gateway-api.sigs.k8s.io/) specifications from the Kubernetes Special Interest Groups (SIGs). This provider is proposed as an experimental feature and partially supports the Service APIs [v0.1.0](https://github.com/kubernetes-sigs/service-apis/releases/tag/v0.1.0) specification. @@ -71,9 +71,9 @@ This provider is proposed as an experimental feature and partially supports the --8<-- "content/reference/dynamic-configuration/kubernetes-gateway-rbac.yml" ``` -The Kubernetes Service APIs project provides several [guides](https://kubernetes-sigs.github.io/gateway-api/guides/) on how to use the APIs. +The Kubernetes Gateway API project provides several [guides](https://gateway-api.sigs.k8s.io/guides/) on how to use the APIs. These guides can help you to go further than the example above. -The [getting started guide](https://kubernetes-sigs.github.io/gateway-api/getting-started/) details how to install the CRDs from their repository. +The [getting started guide](https://gateway-api.sigs.k8s.io/getting-started/) details how to install the CRDs from their repository. !!! note "" @@ -81,9 +81,9 @@ The [getting started guide](https://kubernetes-sigs.github.io/gateway-api/gettin For now, the Traefik Gateway Provider can be used while following the below guides: -* [Simple Gateway](https://kubernetes-sigs.github.io/gateway-api/simple-gateway/) -* [HTTP routing](https://kubernetes-sigs.github.io/gateway-api/http-routing/) -* [TLS](https://kubernetes-sigs.github.io/gateway-api/tls/) (Partial support: only on listeners with terminate mode) +* [Simple Gateway](https://gateway-api.sigs.k8s.io/simple-gateway/) +* [HTTP routing](https://gateway-api.sigs.k8s.io/http-routing/) +* [TLS](https://gateway-api.sigs.k8s.io/tls/) (Partial support: only on listeners with terminate mode) ## Resource Configuration @@ -91,7 +91,7 @@ When using Kubernetes Gateway API as a provider, Traefik uses Kubernetes [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) to retrieve its routing configuration. -All concepts can be found in the official API concepts [documentation](https://kubernetes-sigs.github.io/gateway-api/api-overview/). +All concepts can be found in the official API concepts [documentation](https://gateway-api.sigs.k8s.io/api-overview/). Traefik implements the following resources: * `GatewayClass` defines a set of Gateways that share a common configuration and behaviour. diff --git a/docs/content/routing/providers/kubernetes-gateway.md b/docs/content/routing/providers/kubernetes-gateway.md index 69289a6d7..ab283b97e 100644 --- a/docs/content/routing/providers/kubernetes-gateway.md +++ b/docs/content/routing/providers/kubernetes-gateway.md @@ -33,16 +33,16 @@ The Kubernetes Gateway API, The Experimental Way. You can find an excerpt of the supported Kubernetes Gateway API resources in the table below: -| Kind | Purpose | Concept Behind | -|------------------------------------|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| -| [GatewayClass](#kind-gatewayclass) | Defines a set of Gateways that share a common configuration and behaviour | [GatewayClass](https://kubernetes-sigs.github.io/gateway-api/api-overview/#gatewayclass) | -| [Gateway](#kind-gateway) | Describes how traffic can be translated to Services within the cluster | [Gateway](https://kubernetes-sigs.github.io/gateway-api/api-overview/#gateway) | -| [HTTPRoute](#kind-httproute) | HTTP rules for mapping requests from a Gateway to Kubernetes Services | [Route](https://kubernetes-sigs.github.io/gateway-api/api-overview/#httptcpfooroute) | +| Kind | Purpose | Concept Behind | +|------------------------------------|---------------------------------------------------------------------------|-----------------------------------------------------------------------------| +| [GatewayClass](#kind-gatewayclass) | Defines a set of Gateways that share a common configuration and behaviour | [GatewayClass](https://gateway-api.sigs.k8s.io/api-overview/#gatewayclass) | +| [Gateway](#kind-gateway) | Describes how traffic can be translated to Services within the cluster | [Gateway](https://gateway-api.sigs.k8s.io/api-overview/#gateway) | +| [HTTPRoute](#kind-httproute) | HTTP rules for mapping requests from a Gateway to Kubernetes Services | [Route](https://gateway-api.sigs.k8s.io/api-overview/#httptcpfooroute) | ### Kind: `GatewayClass` `GatewayClass` is cluster-scoped resource defined by the infrastructure provider. This resource represents a class of Gateways that can be instantiated. -More details on the GatewayClass [official documentation](https://kubernetes-sigs.github.io/gateway-api/gatewayclass/). +More details on the GatewayClass [official documentation](https://gateway-api.sigs.k8s.io/gatewayclass/). The `GatewayClass` should be declared by the infrastructure provider, otherwise please register the `GatewayClass` [definition](../../reference/dynamic-configuration/kubernetes-gateway.md#definitions) in the Kubernetes cluster before @@ -65,7 +65,7 @@ creating `GatewayClass` objects. A `Gateway` is 1:1 with the life cycle of the configuration of infrastructure. When a user creates a Gateway, some load balancing infrastructure is provisioned or configured by the GatewayClass controller. -More details on the Gateway [official documentation](https://kubernetes-sigs.github.io/gateway-api/gateway/). +More details on the Gateway [official documentation](https://gateway-api.sigs.k8s.io/gateway/). Register the `Gateway` [definition](../../reference/dynamic-configuration/kubernetes-gateway.md#definitions) in the Kubernetes cluster before creating `Gateway` objects.