Skip to content

CP/DP split: Support nginx debug mode when provisioning Data Plane #3147

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
merged 5 commits into from
Feb 20, 2025

Conversation

bjee19
Copy link
Contributor

@bjee19 bjee19 commented Feb 19, 2025

Proposed changes

Support nginx debug mode when provisioning the Data Plane.

Problem: We want to have the option to provision nginx instances in debug mode.

Solution: Add debug field to NginxProxy CRD. Also user can set debug field when installing through Helm by setting the nginx.debug flag.

Testing:

Manually tested that:

When an NginxProxy is attached to a GatewayClass (and there are no other NginxProxy resources on Gateways), if the debug field is changed, all gateway/nginx instances will be restarted and the new instances will use the nginx binary which matches the debug field.

When an NginxProxy is attached to a Gateway, if the debug field is changed, all corresponding nginx instances will be restarted and use the nginx binary which matches the debug fields. This overwrites any setting on the NginxProxy set on the GatewayClass. When the NginxProxy is removed/deleted from the Gateway, the NginxProxy settings on the GatewayClass take over and if they were different, nginx instances are restarted with the settings from the NginxProxy on the GatewayClass.

Initial NginxProxy on installation through Helm correctly has the debug field set if it was specified on installation.

Closes #3115

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.

none

@bjee19 bjee19 requested a review from a team as a code owner February 19, 2025 19:45
@github-actions github-actions bot added enhancement New feature or request helm-chart Relates to helm chart labels Feb 19, 2025
@bjee19
Copy link
Contributor Author

bjee19 commented Feb 19, 2025

I will link the documentation changes once I open a PR for it.

Copy link

codecov bot commented Feb 19, 2025

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 79.51%. Comparing base (6337c97) to head (c517dca).
Report is 125 commits behind head on change/control-data-plane-split.

Files with missing lines Patch % Lines
internal/mode/static/provisioner/objects.go 0.00% 5 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (6337c97) and HEAD (c517dca). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (6337c97) HEAD (c517dca)
3 2
Additional details and impacted files
@@                         Coverage Diff                          @@
##           change/control-data-plane-split    #3147       +/-   ##
====================================================================
- Coverage                            89.74%   79.51%   -10.24%     
====================================================================
  Files                                  109      124       +15     
  Lines                                11150    13475     +2325     
  Branches                                50       62       +12     
====================================================================
+ Hits                                 10007    10714      +707     
- Misses                                1083     2688     +1605     
- Partials                                60       73       +13     

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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 19, 2025
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Feb 19, 2025
Copy link
Contributor

@salonichf5 salonichf5 left a comment

Choose a reason for hiding this comment

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

lgtm

@bjee19
Copy link
Contributor Author

bjee19 commented Feb 20, 2025

Corresponding docs pr here: nginx/documentation#215

@bjee19 bjee19 merged commit 4d5dd43 into change/control-data-plane-split Feb 20, 2025
31 of 44 checks passed
@bjee19 bjee19 deleted the enh/support-nginx-debug-mode branch February 20, 2025 20:57
sjberman pushed a commit that referenced this pull request Feb 25, 2025
…3147)

Support nginx debug mode when provisioning the Data Plane.

Problem: We want to have the option to provision nginx instances in debug mode.

Solution: Add debug field to NginxProxy CRD. Also user can set debug field when installing through Helm by setting the nginx.debug flag.
sjberman pushed a commit that referenced this pull request Mar 4, 2025
…3147)

Support nginx debug mode when provisioning the Data Plane.

Problem: We want to have the option to provision nginx instances in debug mode.

Solution: Add debug field to NginxProxy CRD. Also user can set debug field when installing through Helm by setting the nginx.debug flag.
sjberman pushed a commit that referenced this pull request Apr 23, 2025
…3147)

Support nginx debug mode when provisioning the Data Plane.

Problem: We want to have the option to provision nginx instances in debug mode.

Solution: Add debug field to NginxProxy CRD. Also user can set debug field when installing through Helm by setting the nginx.debug flag.
sjberman pushed a commit that referenced this pull request May 6, 2025
…3147)

Support nginx debug mode when provisioning the Data Plane.

Problem: We want to have the option to provision nginx instances in debug mode.

Solution: Add debug field to NginxProxy CRD. Also user can set debug field when installing through Helm by setting the nginx.debug flag.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request helm-chart Relates to helm chart
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants