From 2183e3a55ff3e0055333dfeb9962886a149f5d44 Mon Sep 17 00:00:00 2001 From: salonichf5 <146118978+salonichf5@users.noreply.github.com> Date: Thu, 8 May 2025 12:08:23 -0600 Subject: [PATCH 1/4] docs: update gateway compatibility doc --- content/ngf/overview/gateway-api-compatibility.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/ngf/overview/gateway-api-compatibility.md b/content/ngf/overview/gateway-api-compatibility.md index 4e08a90de..2a5e6a99c 100644 --- a/content/ngf/overview/gateway-api-compatibility.md +++ b/content/ngf/overview/gateway-api-compatibility.md @@ -90,7 +90,7 @@ NGINX Gateway Fabric supports a single GatewayClass resource configured with the {{< /bootstrap-table >}} -NGINX Gateway Fabric supports a single Gateway resource. The Gateway resource must reference NGINX Gateway Fabric's corresponding GatewayClass. +NGINX Gateway Fabric supports a multiple Gateway resources. The Gateway resources must reference NGINX Gateway Fabric's corresponding GatewayClass. See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) command for more information. @@ -100,8 +100,8 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma - `gatewayClassName`: Supported. - `infrastructure`: Partially Supported. - `parametersRef`: NginxProxy resource supported. - - `labels`: Not supported. - - `annotations`: Not supported. + - `labels`: Supported. + - `annotations`: Supported. - `listeners` - `name`: Supported. - `hostname`: Supported. @@ -113,7 +113,6 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma - `options`: Not supported. - `allowedRoutes`: Supported. - `addresses`: Not supported. - - `infrastructure`: Not supported. - `backendTLS`: Not supported. - `status` - `addresses`: Partially supported (LoadBalancer and Pod IP). @@ -124,10 +123,9 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma - `Accepted/False/Invalid` - `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Gateway is invalid or not supported. - `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. - NGINX Gateway Fabric only supports a single Gateway. - `Programmed/True/Programmed` - `Programmed/False/Invalid` - - `Programmed/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. NGINX Gateway Fabric only supports a single Gateway. + - `Programmed/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. - `listeners` - `name`: Supported. - `supportedKinds`: Supported. @@ -139,7 +137,7 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma - `Accepted/False/ProtocolConflict` - `Accpeted/False/HostnameConflict` - `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Listener is invalid or not supported. - - `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. NGINX Gateway Fabric only supports a single Gateway. + - `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. - `Programmed/True/Programmed` - `Programmed/False/Invalid` - `ResolvedRefs/True/ResolvedRefs` @@ -389,3 +387,5 @@ Custom policies are NGINX Gateway Fabric-specific CRDs (Custom Resource Definiti While these CRDs are not part of the Gateway API, the mechanism to attach them to Gateway API resources is part of the Gateway API. See the [Policy Attachment documentation](https://gateway-api.sigs.k8s.io/references/policy-attachment/). See the [custom policies]({{< ref "/ngf/overview/custom-policies.md" >}}) document for more information. + +--- \ No newline at end of file From 148505682256822343d915d400591672245dd4c9 Mon Sep 17 00:00:00 2001 From: salonichf5 <146118978+salonichf5@users.noreply.github.com> Date: Thu, 15 May 2025 19:51:23 +0530 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Saylor Berman --- content/ngf/overview/gateway-api-compatibility.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/ngf/overview/gateway-api-compatibility.md b/content/ngf/overview/gateway-api-compatibility.md index 2a5e6a99c..ce11e68ba 100644 --- a/content/ngf/overview/gateway-api-compatibility.md +++ b/content/ngf/overview/gateway-api-compatibility.md @@ -90,7 +90,7 @@ NGINX Gateway Fabric supports a single GatewayClass resource configured with the {{< /bootstrap-table >}} -NGINX Gateway Fabric supports a multiple Gateway resources. The Gateway resources must reference NGINX Gateway Fabric's corresponding GatewayClass. +NGINX Gateway Fabric supports multiple Gateway resources. The Gateway resources must reference NGINX Gateway Fabric's corresponding GatewayClass. See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) command for more information. @@ -98,7 +98,7 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma - `spec` - `gatewayClassName`: Supported. - - `infrastructure`: Partially Supported. + - `infrastructure`: Supported. - `parametersRef`: NginxProxy resource supported. - `labels`: Supported. - `annotations`: Supported. From d9a769b14800b22e6ae2fe54daa051ad84bd146a Mon Sep 17 00:00:00 2001 From: salonichf5 <146118978+salonichf5@users.noreply.github.com> Date: Thu, 15 May 2025 08:49:46 -0600 Subject: [PATCH 3/4] update docs --- content/ngf/overview/gateway-api-compatibility.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/ngf/overview/gateway-api-compatibility.md b/content/ngf/overview/gateway-api-compatibility.md index ce11e68ba..52ab4d63e 100644 --- a/content/ngf/overview/gateway-api-compatibility.md +++ b/content/ngf/overview/gateway-api-compatibility.md @@ -115,17 +115,15 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma - `addresses`: Not supported. - `backendTLS`: Not supported. - `status` - - `addresses`: Partially supported (LoadBalancer and Pod IP). + - `addresses`: Partially supported (LoadBalancer and ClusterIP). - `conditions`: Supported (Condition/Status/Reason): - `Accepted/True/Accepted` - `Accepted/True/ListenersNotValid` - `Accepted/False/ListenersNotValid` - `Accepted/False/Invalid` - `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Gateway is invalid or not supported. - - `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. - `Programmed/True/Programmed` - `Programmed/False/Invalid` - - `Programmed/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. - `listeners` - `name`: Supported. - `supportedKinds`: Supported. @@ -137,7 +135,6 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma - `Accepted/False/ProtocolConflict` - `Accpeted/False/HostnameConflict` - `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Listener is invalid or not supported. - - `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. - `Programmed/True/Programmed` - `Programmed/False/Invalid` - `ResolvedRefs/True/ResolvedRefs` From 4c6df13f7da6c36a9fc968295d38c082d1f44b83 Mon Sep 17 00:00:00 2001 From: salonichf5 <146118978+salonichf5@users.noreply.github.com> Date: Tue, 20 May 2025 12:26:19 -0600 Subject: [PATCH 4/4] remove dashed lines --- content/ngf/overview/gateway-api-compatibility.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/content/ngf/overview/gateway-api-compatibility.md b/content/ngf/overview/gateway-api-compatibility.md index 52ab4d63e..8ff59d32e 100644 --- a/content/ngf/overview/gateway-api-compatibility.md +++ b/content/ngf/overview/gateway-api-compatibility.md @@ -383,6 +383,4 @@ Fields: Custom policies are NGINX Gateway Fabric-specific CRDs (Custom Resource Definitions) that support features such as tracing, and client connection settings. These important data-plane features are not part of the Gateway API specifications. While these CRDs are not part of the Gateway API, the mechanism to attach them to Gateway API resources is part of the Gateway API. See the [Policy Attachment documentation](https://gateway-api.sigs.k8s.io/references/policy-attachment/). -See the [custom policies]({{< ref "/ngf/overview/custom-policies.md" >}}) document for more information. - ---- \ No newline at end of file +See the [custom policies]({{< ref "/ngf/overview/custom-policies.md" >}}) document for more information. \ No newline at end of file