-
Notifications
You must be signed in to change notification settings - Fork 118
Add provisional Enhancement Proposal-2035: Advanced NGINX Extensions #2039
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
Merged
pleshakov
merged 6 commits into
nginx:main
from
pleshakov:enh/advanced-nginx-extensions
Jun 11, 2024
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
deac3d0
Add provisional Enhancement Proposal-2035: Advanced NGINX Extensions
pleshakov aa07aba
Update docs/proposals/advanced-nginx-extensions.md
pleshakov 3c5c716
rewrite no source code modification goal
pleshakov e3fb975
Merge branch 'main' into enh/advanced-nginx-extensions
pleshakov 51cb4c7
Merge branch 'main' into enh/advanced-nginx-extensions
pleshakov 54744be
Merge branch 'main' into enh/advanced-nginx-extensions
pleshakov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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. | ||
- 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
|
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.