Skip to content

Update SnippetFilter validation rules in enhancement proposal #2471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 28, 2024
Merged

Update SnippetFilter validation rules in enhancement proposal #2471

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45a0e65
Update SnippetFilter validation rules in enhancement proposal
Aug 27, 2024
c7219fa
Add link to API
Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/proposals/advanced-nginx-extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,23 @@ one `http` snippet with multiple `http` snippets scattered around in the spec.

NGF will not validate the values of snippets. See the next section.

When a SnippetsFilter is specified in a routing rule and one of the following is true:

- the SnippetsFilter does not exist
- the SnippetsFilter referenced is invalid
- the same SnippetsFilter is referenced multiple times

the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a 500 HTTP error code response.
In addition, the `ResolvedRefs` condition should be set to `False` with one of the following reasons:

- `FilterNotFound`
- `InvalidFilter`

These reasons are not defined in the Gateway API library, so they will need to be added and documented.
In addition, the `Accepted` route condition should be set to `True`.

Refer to [HTTPRouteFilter API](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteFilter) for more implementation details.

#### NGINX Values

An invalid snippet can break NGINX config. When this happens, NGINX will continue to use the last valid configuration.
Expand Down
Loading