Skip to content
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.

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

Add provisional Enhancement Proposal-2035: Advanced NGINX Extensions #2039

Merged
merged 6 commits into from
Jun 11, 2024
Merged
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions docs/proposals/advanced-nginx-extensions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Enhancement Proposal-2035: Advanced NGINX Extensions

- Issue: https://github.com/nginxinc/nginx-gateway-fabric/issues/2035
- Status: Provisional

## Summary

NGINX Gateway Fabric (NGF) [exposes](/site/content/overview/gateway-api-compatibility.md) NGINX features via Gateway API
resources (like HTTPRoute) and [NGINX extensions](nginx-extensions.md) (like ClientSettingPolicy). Combined, they
expose a subset of the most common NGINX configuration. As we implement more Gateway API resources and NGINX extensions,
the subset will grow. However, it will take time. Additionally, because the number of NGINX configuration directives
and parameters is huge, not all of them will be supported that way. As a result, users are not able to implement certain
NGINX use cases. To allow them to implement those use cases, we need to bring a new extension mechanism to NGF.

## Goals

- Allow users to insert NGINX configuration not supported via Gateway API resources or NGINX extensions.
- Allow users to customize supported NGINX configuration (for example, add a parameter to an NGINX directive).
- Support configuration from modules not loaded in NGINX by default or third-party modules.
- Most of the configuration complexity should fall onto the cluster operator persona, not the application developer.
mpstefan marked this conversation as resolved.
Show resolved Hide resolved
- Provide security controls to prevent application developers from injecting arbitrary NGINX configuration.
- Ensure adequate configuration validation to prevent NGINX outages due to invalid configuration.
- Advanced NGINX extensions can be used without source code modification.

## Non-Goals

- Support configuration other than NGINX directives. For example, njs configuration files or TLS certificates.
- Reimplement already supported features through the new extension mechanism.
mpstefan marked this conversation as resolved.
Show resolved Hide resolved
Loading