Skip to content

Conversation

@ciarams87
Copy link
Contributor

Proposed changes

Problem: As a user of NGF
I want a design to configure NGINX's proxy buffer configuration for my applications through the use of ProxySettingsPolicy
So that I can implement the ProxySettingsPolicy CRD

Solution: Create the provisional ProxySettingsPolicy enhancement proposal

Partially implements #4067

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.


@ciarams87 ciarams87 requested review from a team as code owners November 7, 2025 10:14
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 7, 2025
@codecov
Copy link

codecov bot commented Nov 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.11%. Comparing base (a5a0f72) to head (0b3608c).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4237      +/-   ##
==========================================
+ Coverage   86.10%   86.11%   +0.01%     
==========================================
  Files         131      131              
  Lines       14162    14162              
  Branches       35       35              
==========================================
+ Hits        12194    12196       +2     
+ Misses       1765     1764       -1     
+ Partials      203      202       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment on lines +11 to +16
## Goals

- Define proxy settings for buffering configuration.
- Define an API for proxy settings that is extensible to support additional proxy directives in the future.
- Outline the attachment points (Gateway and HTTPRoute/GRPCRoute) for the proxy settings policy.
- Describe the inheritance behavior of proxy settings when multiple policies exist at different levels.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the initial design and implementation is explicitly supporting proxy_buffer_size, proxy_buffers, proxy_buffering and proxy_busy_buffers_size, should we call that out in the goals?

I see the non-goals says "only buffering directives are in scope for initial implementation", which might cover the same point. I can see that being a point of confusion in the design review.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have in the first goal - Define proxy settings for buffering configuration. The specific directives feel like implementation details to me.


## Non-Goals

- Define the complete set of all proxy directives (only buffering directives are in scope for initial implementation).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw these directives don't get applied to stream blocks, so support for this will only be for GRPC and HTTRoutes right?
We should add info in non-goal about this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: 🆕 New

Development

Successfully merging this pull request may close these issues.

4 participants