From deac3d08280bda470a2d2bc1b89687894099e7e4 Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Tue, 28 May 2024 15:53:05 -0400 Subject: [PATCH 1/3] Add provisional Enhancement Proposal-2035: Advanced NGINX Extensions Corresponding Enhancement Proposal issue -- https://github.com/nginxinc/nginx-gateway-fabric/issues/2035 CLOSES https://github.com/nginxinc/nginx-gateway-fabric/issues/1897 --- docs/proposals/advanced-nginx-extensions.md | 28 +++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/proposals/advanced-nginx-extensions.md diff --git a/docs/proposals/advanced-nginx-extensions.md b/docs/proposals/advanced-nginx-extensions.md new file mode 100644 index 0000000000..0672fb248f --- /dev/null +++ b/docs/proposals/advanced-nginx-extensions.md @@ -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 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. +- Don't require building a custom NGF binary (source code modifications). + +## 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. From aa07abab2913d150cf53db3e62f994e9a07f8418 Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Wed, 29 May 2024 12:05:59 -0400 Subject: [PATCH 2/3] Update docs/proposals/advanced-nginx-extensions.md Co-authored-by: Saylor Berman --- docs/proposals/advanced-nginx-extensions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/proposals/advanced-nginx-extensions.md b/docs/proposals/advanced-nginx-extensions.md index 0672fb248f..052b231a0b 100644 --- a/docs/proposals/advanced-nginx-extensions.md +++ b/docs/proposals/advanced-nginx-extensions.md @@ -7,7 +7,7 @@ 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 most common NGINX configuration. As we implement more Gateway API resources and NGINX extensions, +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. From 3c5c7162177901fe82300b08b016d73b87321087 Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Fri, 7 Jun 2024 17:59:56 -0400 Subject: [PATCH 3/3] rewrite no source code modification goal --- docs/proposals/advanced-nginx-extensions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/proposals/advanced-nginx-extensions.md b/docs/proposals/advanced-nginx-extensions.md index 052b231a0b..0f80e170ff 100644 --- a/docs/proposals/advanced-nginx-extensions.md +++ b/docs/proposals/advanced-nginx-extensions.md @@ -20,7 +20,7 @@ NGINX use cases. To allow them to implement those use cases, we need to bring a - 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. -- Don't require building a custom NGF binary (source code modifications). +- Advanced NGINX extensions can be used without source code modification. ## Non-Goals