Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Support NGINX Plus usage reporting #1544

Merged
merged 6 commits into from
Feb 20, 2024
Merged

Support NGINX Plus usage reporting #1544

merged 6 commits into from
Feb 20, 2024

Conversation

sjberman
Copy link
Collaborator

@sjberman sjberman commented Feb 6, 2024 •
edited by salonichf5
Loading

Problem: As part of the Flexible Consumption Plan, NGINX Plus users are required to report usage to NGINX Instance Manager.

Solution: Provide configuration options when deploying NGF to acquire credentials and send basic usage data (clusterUID, podCount, nodeCount) to the NGINX Instance Manager k8s API endpoint. Doc included to inform users how to do this.

Testing: Verified that data is properly uploaded to a running NIM deployment.

Closes #1451

  • 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

@github-actions github-actions bot added documentation Improvements or additions to documentation chore Pull requests for routine tasks helm-chart Relates to helm chart labels Feb 6, 2024
pleshakov
pleshakov reviewed Feb 8, 2024
View reviewed changes
site/content/usage-reporting.md Outdated Show resolved Hide resolved
site/content/usage-reporting.md Outdated Show resolved Hide resolved
site/content/usage-reporting.md Outdated Show resolved Hide resolved
site/content/usage-reporting.md Outdated Show resolved Hide resolved
cmd/gateway/commands.go Outdated Show resolved Hide resolved
cmd/gateway/commands.go Outdated Show resolved Hide resolved
internal/mode/static/handler.go Outdated Show resolved Hide resolved
internal/mode/static/usage/reporter.go Show resolved Hide resolved
internal/mode/static/usage/reporter.go Outdated Show resolved Hide resolved
internal/mode/static/usage/reporter.go Outdated Show resolved Hide resolved
@sjberman sjberman force-pushed the chore/nplus-usage-reporting branch 3 times, most recently from 3f4076d to c0482aa Compare February 9, 2024 20:21
@sjberman sjberman requested a review from pleshakov February 12, 2024 21:13
kate-osborn
kate-osborn requested changes Feb 13, 2024
View reviewed changes
cmd/gateway/commands.go Show resolved Hide resolved
cmd/gateway/commands.go Show resolved Hide resolved
cmd/gateway/commands.go Show resolved Hide resolved
internal/mode/static/handler.go Outdated Show resolved Hide resolved
internal/mode/static/handler.go Outdated Show resolved Hide resolved
internal/mode/static/manager.go Show resolved Hide resolved
internal/mode/static/manager.go Outdated Show resolved Hide resolved
internal/mode/static/usage/reporter.go Outdated Show resolved Hide resolved
internal/mode/static/usage/secret.go Outdated Show resolved Hide resolved
internal/mode/static/usage/secret.go Outdated Show resolved Hide resolved
@sjberman sjberman force-pushed the chore/nplus-usage-reporting branch 2 times, most recently from e491fcc to eb1f1a6 Compare February 14, 2024 16:07
pleshakov
pleshakov reviewed Feb 14, 2024
View reviewed changes
cmd/gateway/commands.go Show resolved Hide resolved
cmd/gateway/commands.go Show resolved Hide resolved
internal/mode/static/manager.go Outdated Show resolved Hide resolved
cmd/gateway/validation.go Show resolved Hide resolved
deploy/helm-chart/templates/deployment.yaml Outdated Show resolved Hide resolved
internal/mode/static/handler.go Outdated Show resolved Hide resolved
internal/mode/static/usage/job_worker_test.go Show resolved Hide resolved
internal/mode/static/usage/secret.go Outdated Show resolved Hide resolved
internal/mode/static/usage/secret.go Outdated Show resolved Hide resolved
internal/mode/static/manager.go Outdated Show resolved Hide resolved
@sjberman sjberman force-pushed the chore/nplus-usage-reporting branch 4 times, most recently from 101c7c9 to 839641b Compare February 15, 2024 22:06
@sjberman sjberman marked this pull request as ready for review February 15, 2024 22:06
@sjberman sjberman requested review from a team as code owners February 15, 2024 22:06
@sjberman sjberman force-pushed the chore/nplus-usage-reporting branch from 839641b to 7472ea0 Compare February 15, 2024 22:19
kate-osborn
kate-osborn approved these changes Feb 15, 2024
View reviewed changes
Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

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

🚀

@sjberman sjberman force-pushed the chore/nplus-usage-reporting branch from b7b1d7e to 3a55f50 Compare February 16, 2024 19:11
@pleshakov pleshakov mentioned this pull request Feb 16, 2024
Merged
6 tasks
@sjberman sjberman requested a review from ADubhlaoich February 20, 2024 15:11
ADubhlaoich
ADubhlaoich approved these changes Feb 20, 2024
View reviewed changes
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

Approved with a handful of comments. The big thing to consider addressing is inconsistencies in Usage Reporting as a proper noun.

site/content/installation/installing-ngf/helm.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
site/content/installation/usage-reporting.md Outdated Show resolved Hide resolved
@sjberman
Support NGINX Plus usage reporting
4cf456d 
Problem: As part of the Flexible Consumption Plan, NGINX Plus users are required to report usage to NGINX Instance Manager.

Solution: Provide configuration options when deploying NGF to acquire credentials and send basic usage data (clusterUID, podCount, nodeCount) to the NGINX Instance Manager k8s API endpoint. Doc included to inform users how to do this.
@sjberman
Docs updates
4886651
@sjberman
add experimental files
c9674ea
@sjberman sjberman force-pushed the chore/nplus-usage-reporting branch from 552d7ad to 2ca1fa6 Compare February 20, 2024 20:49
@sjberman sjberman force-pushed the chore/nplus-usage-reporting branch from 4fa6b7b to 2458c46 Compare February 20, 2024 21:21
@pleshakov pleshakov mentioned this pull request Feb 20, 2024
Closed
kate-osborn
kate-osborn requested changes Feb 20, 2024
View reviewed changes
Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

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

Just one suggestion, but otherwise LGTM

internal/mode/static/usage/job_worker_test.go Show resolved Hide resolved
@sjberman sjberman requested a review from kate-osborn February 20, 2024 22:07
@sjberman sjberman merged commit dec2f1b into nginx:main Feb 20, 2024
34 checks passed
@sjberman sjberman deleted the chore/nplus-usage-reporting branch February 20, 2024 23:19
@kate-osborn kate-osborn mentioned this pull request Feb 20, 2024
Merged
6 tasks
@shaun-nx shaun-nx mentioned this pull request Apr 3, 2024
Closed
miledxz added a commit to miledxz/nginx-gateway-fabric that referenced this pull request Jan 14, 2025
@miledxz
Support NGINX Plus usage reporting (nginx#1544)
2bdd175 
Problem: As part of the Flexible Consumption Plan, NGINX Plus users are required to report usage to NGINX Instance Manager.

Solution: Provide configuration options when deploying NGF to acquire credentials and send basic usage data (clusterUID, podCount, nodeCount) to the NGINX Instance Manager k8s API endpoint. Doc included to inform users how to do this.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@salonichf5 salonichf5 salonichf5 left review comments

@ciarams87 ciarams87 ciarams87 left review comments

@kate-osborn kate-osborn kate-osborn approved these changes

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

@pleshakov pleshakov pleshakov approved these changes

Assignees
No one assigned
Labels
chore Pull requests for routine tasks documentation Improvements or additions to documentation helm-chart Relates to helm chart
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

NGINX+ Usage Reporting
6 participants
@sjberman @pleshakov @ADubhlaoich @ciarams87 @kate-osborn @salonichf5