NGF: Update Gateway Compatibility Document #540
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
✅ Deploy Preview will be available once build job completes!
|
salonichf5
force-pushed
the
docs/gateway-compatibility
branch
from
829a8b7 to
2183e3a
Compare
ADubhlaoich
approved these changes
May 13, 2025
sjberman
reviewed
May 13, 2025
| @@ -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. | |||
There was a problem hiding this comment.
Suggested change
| 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. |
| @@ -100,8 +100,8 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma | |||
| - `gatewayClassName`: Supported. | |||
| - `infrastructure`: Partially Supported. | |||
There was a problem hiding this comment.
Suggested change
| - `infrastructure`: Partially Supported. | |
| - `infrastructure`: Supported. |
| @@ -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. | |||
There was a problem hiding this comment.
It doesn't look like we actually use this condition anymore. so it can be removed.
| - `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. |
| @@ -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. | |||
| @@ -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. | |||
|
|
|||
| --- | |||
There was a problem hiding this comment.
Is this necessary at the end?
| - `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` |
There was a problem hiding this comment.
You're missing a piece of the acceptance criteria in the ticket. Relating to Gateway status address.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Updates Gateway Compatibility document to reflect new architecture changes.
Testing: Describe any testing that you did.
Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.
If this PR addresses an issue on GitHub, ensure that you link to it here:
Closes #ISSUE
Gateway Compatibility Updates for 2.0
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.mdandCHANGELOG.mdFootnotes
Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩