diff --git a/changelogs/unreleased/6143-skriss-docs.md b/changelogs/unreleased/6143-skriss-docs.md new file mode 100644 index 00000000000..2c702c3f738 --- /dev/null +++ b/changelogs/unreleased/6143-skriss-docs.md @@ -0,0 +1 @@ +Document that Gateway names should be 63 characters or shorter to avoid issues with generating dependent resources when using the Gateway provisioner. \ No newline at end of file diff --git a/site/content/docs/1.26/config/gateway-api.md b/site/content/docs/1.26/config/gateway-api.md index 80ffcd26991..d3efc944353 100644 --- a/site/content/docs/1.26/config/gateway-api.md +++ b/site/content/docs/1.26/config/gateway-api.md @@ -30,7 +30,7 @@ If configured with a specific gateway, Contour will process that `Gateway` and i In **dynamic** provisioning, the platform operator first deploys Contour's Gateway provisioner. Then, the platform operator defines a `Gateway` resource, and the provisioner automatically deploys a Contour instance that corresponds to the `Gateway's` configuration and will process that `Gateway` and its routes. -Static provisioning makes sense for users who: +Static provisioning makes sense for users who: - prefer the traditional model of deploying Contour - have only a single Gateway - want to use just the standard listener ports (80/443) @@ -64,6 +64,8 @@ To dynamically provision Contour with Gateway API enabled: The Contour Gateway Provisioner will deploy an instance of Contour in the Gateway's namespace implementing the Gateway spec. +**Note:** Gateway names must be 63 characters or shorter, to avoid issues when generating dependent resources. See [projectcontour/contour#5970][13] and [kubernetes-sigs/gateway-api#2592][14] for more information. + ## Gateway Listeners Each unique Gateway Listener port requires the Envoy service to expose that port, and to map it to an underlying port in the Envoy daemonset/deployment that Envoy is configured to listen on. @@ -180,7 +182,7 @@ When the Contour Gateway Provisioner is upgraded to a new version, it will upgra ## Disabling Experimental Resources Some users may want to use Contour with the [Gateway API standard channel][4] instead of the experimental channel, to avoid installing alpha resources into their clusters. -To do this, Contour must be told to disable informers for the experimental resources. +To do this, Contour must be told to disable informers for the experimental resources. In the Contour (control plane) deployment, use the `--disable-feature` flag for `contour serve` to disable informers for the experimental resources: ```yaml @@ -212,4 +214,6 @@ containers: [9]: https://projectcontour.io/quickstart/contour-gateway-provisioner.yaml [10]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.GatewayClass [11]: https://gateway-api.sigs.k8s.io/concepts/api-overview/#route-resources -[12]: /docs/{{< param version >}}/guides/gateway-api \ No newline at end of file +[12]: /docs/{{< param version >}}/guides/gateway-api +[13]: https://github.com/projectcontour/contour/issues/5970 +[14]: https://github.com/kubernetes-sigs/gateway-api/issues/2592 \ No newline at end of file diff --git a/site/content/docs/1.27/config/gateway-api.md b/site/content/docs/1.27/config/gateway-api.md index 80ffcd26991..d3efc944353 100644 --- a/site/content/docs/1.27/config/gateway-api.md +++ b/site/content/docs/1.27/config/gateway-api.md @@ -30,7 +30,7 @@ If configured with a specific gateway, Contour will process that `Gateway` and i In **dynamic** provisioning, the platform operator first deploys Contour's Gateway provisioner. Then, the platform operator defines a `Gateway` resource, and the provisioner automatically deploys a Contour instance that corresponds to the `Gateway's` configuration and will process that `Gateway` and its routes. -Static provisioning makes sense for users who: +Static provisioning makes sense for users who: - prefer the traditional model of deploying Contour - have only a single Gateway - want to use just the standard listener ports (80/443) @@ -64,6 +64,8 @@ To dynamically provision Contour with Gateway API enabled: The Contour Gateway Provisioner will deploy an instance of Contour in the Gateway's namespace implementing the Gateway spec. +**Note:** Gateway names must be 63 characters or shorter, to avoid issues when generating dependent resources. See [projectcontour/contour#5970][13] and [kubernetes-sigs/gateway-api#2592][14] for more information. + ## Gateway Listeners Each unique Gateway Listener port requires the Envoy service to expose that port, and to map it to an underlying port in the Envoy daemonset/deployment that Envoy is configured to listen on. @@ -180,7 +182,7 @@ When the Contour Gateway Provisioner is upgraded to a new version, it will upgra ## Disabling Experimental Resources Some users may want to use Contour with the [Gateway API standard channel][4] instead of the experimental channel, to avoid installing alpha resources into their clusters. -To do this, Contour must be told to disable informers for the experimental resources. +To do this, Contour must be told to disable informers for the experimental resources. In the Contour (control plane) deployment, use the `--disable-feature` flag for `contour serve` to disable informers for the experimental resources: ```yaml @@ -212,4 +214,6 @@ containers: [9]: https://projectcontour.io/quickstart/contour-gateway-provisioner.yaml [10]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.GatewayClass [11]: https://gateway-api.sigs.k8s.io/concepts/api-overview/#route-resources -[12]: /docs/{{< param version >}}/guides/gateway-api \ No newline at end of file +[12]: /docs/{{< param version >}}/guides/gateway-api +[13]: https://github.com/projectcontour/contour/issues/5970 +[14]: https://github.com/kubernetes-sigs/gateway-api/issues/2592 \ No newline at end of file diff --git a/site/content/docs/main/config/gateway-api.md b/site/content/docs/main/config/gateway-api.md index 80ffcd26991..d3efc944353 100644 --- a/site/content/docs/main/config/gateway-api.md +++ b/site/content/docs/main/config/gateway-api.md @@ -30,7 +30,7 @@ If configured with a specific gateway, Contour will process that `Gateway` and i In **dynamic** provisioning, the platform operator first deploys Contour's Gateway provisioner. Then, the platform operator defines a `Gateway` resource, and the provisioner automatically deploys a Contour instance that corresponds to the `Gateway's` configuration and will process that `Gateway` and its routes. -Static provisioning makes sense for users who: +Static provisioning makes sense for users who: - prefer the traditional model of deploying Contour - have only a single Gateway - want to use just the standard listener ports (80/443) @@ -64,6 +64,8 @@ To dynamically provision Contour with Gateway API enabled: The Contour Gateway Provisioner will deploy an instance of Contour in the Gateway's namespace implementing the Gateway spec. +**Note:** Gateway names must be 63 characters or shorter, to avoid issues when generating dependent resources. See [projectcontour/contour#5970][13] and [kubernetes-sigs/gateway-api#2592][14] for more information. + ## Gateway Listeners Each unique Gateway Listener port requires the Envoy service to expose that port, and to map it to an underlying port in the Envoy daemonset/deployment that Envoy is configured to listen on. @@ -180,7 +182,7 @@ When the Contour Gateway Provisioner is upgraded to a new version, it will upgra ## Disabling Experimental Resources Some users may want to use Contour with the [Gateway API standard channel][4] instead of the experimental channel, to avoid installing alpha resources into their clusters. -To do this, Contour must be told to disable informers for the experimental resources. +To do this, Contour must be told to disable informers for the experimental resources. In the Contour (control plane) deployment, use the `--disable-feature` flag for `contour serve` to disable informers for the experimental resources: ```yaml @@ -212,4 +214,6 @@ containers: [9]: https://projectcontour.io/quickstart/contour-gateway-provisioner.yaml [10]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.GatewayClass [11]: https://gateway-api.sigs.k8s.io/concepts/api-overview/#route-resources -[12]: /docs/{{< param version >}}/guides/gateway-api \ No newline at end of file +[12]: /docs/{{< param version >}}/guides/gateway-api +[13]: https://github.com/projectcontour/contour/issues/5970 +[14]: https://github.com/kubernetes-sigs/gateway-api/issues/2592 \ No newline at end of file