-
Notifications
You must be signed in to change notification settings - Fork 138
NGINX Plus: support enforce_initial_report
field
#3899
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
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3899 +/- ##
==========================================
+ Coverage 86.82% 86.86% +0.04%
==========================================
Files 128 128
Lines 16503 16519 +16
Branches 62 62
==========================================
+ Hits 14329 14350 +21
+ Misses 1996 1990 -6
- Partials 178 179 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
enforce_initial_report
field
afbabc2
to
2fa4641
Compare
2fa4641
to
be6b05d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one small comment, otherwise looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work!
Proposed changes
Problem:
As a potential NGINX Plus user,
I want to have a grace period for my initial licensing report,
So that I can validate NGF as a PoC without restriction.
NGF currently sets enforce_initial_report off; for NGINX Plus data planes when initially installing, but once the first configuration is sent from the control plane to the data plane, this directive is removed (defaulting to on). Users should be able to set this field themselves for other circumstances, like PoC testing or exemptions.
For reference: https://nginx.org/en/docs/ngx_mgmt_module.html#enforce_initial_report
Solution:
add a CLI argument to the controller to enable or disable the initial report enforcement
set the field in the nginx config based on the user input
the existing bootstrap config that sets this field to off should be left as-is to ensure startup succeeds
update the cli flag document
add helm chart flag to the existing nginx plus usage section
Testing:
make install-ngf-local-build-with-plus HELM_PARAMETERS="--set nginx.usage.enforceInitialReport=false"
result:
make install-ngf-local-build-with-plus HELM_PARAMETERS="--set nginx.usage.enforceInitialReport=true"
result:
make install-ngf-local-build-with-plus
result:
Please focus on (optional):
Closes #3790
Checklist
Before creating a PR, run through this checklist and mark each as complete.
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.