Update tech-specs.md for ev reporting #35

mkingst · 2025-01-02T15:21:46Z

Proposed changes

Updated tech specs to account for this issue:

https://github.com/nginxinc/docs/issues/1528

Problem: Give a brief overview of the problem or feature being addressed.

Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
considerations.

Testing: Describe any testing that you did.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

Checklist

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

I have read the contributing guidelines
I have signed the F5 Contributor License Agreement (CLA)
If applicable, I have added tests that prove my fix is effective or that my feature works
If applicable, I have checked that any relevant tests pass after adding my changes
I have updated any relevant documentation (README.md and CHANGELOG.md)
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
If the change involves:
- Code
- Anything that resembles Personally identifying information (PII)
  - Make sure to use placeholders such as <username> in place of PII
- URLs (watch for typosquatting)
- Significant new/revised content
In these cases, the change will require at least two (2) approvals before merging

github-actions · 2025-01-02T15:22:02Z

🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree:

I have hereby read the F5 CLA and agree to its terms

1 out of 2 committers have signed the CLA.
✅ (mjang)[https://github.com/mjang]
❌ @mkingst
_{You can retrigger this bot by commenting recheck in this Pull Request.}_{Posted by the CLA Assistant Lite bot.}

mkingst · 2025-01-02T15:32:13Z

I have hereby read the F5 CLA and agree to its terms

…

________________________________ From: github-actions[bot] ***@***.***> Sent: Thursday 2 January 2025 15:22 To: nginx/documentation ***@***.***> Cc: Micheal Kingston ***@***.***>; Author ***@***.***> Subject: Re: [nginx/documentation] Update tech-specs.md for ev reporting (PR #35) 🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA)<https://github.com/f5/.github/blob/main/CLA/cla-markdown.md>, which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA<https://github.com/f5/.github/blob/main/CLA/cla-markdown.md> and reply on a new comment with the following text to agree:

________________________________ I have hereby read the F5 CLA and agree to its terms

________________________________ You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. — Reply to this email directly, view it on GitHub<#35 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AKTJQU7GL7XYOLBSEE2IJ6L2IVKTBAVCNFSM6AAAAABUQEOG6KVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNRXHEZTSNJSGA>. You are receiving this because you authored the thread.Message ID: ***@***.***>

mjang · 2025-01-02T15:52:14Z

recheck

mkingst · 2025-01-02T16:59:09Z

content/nim/fundamentals/tech-specs.md

+{{<bootstrap-table "table table-striped table-bordered">}}
+| Number of Data Plane Instances | CPU    | Memory   | Network   | Storage |
+|--------------------------------|--------|----------|-----------|---------|
+| n/a                            | 2 vCPU | 4 GB RAM | 1 GbE NIC | 20 GB   |


We successfully tested 50k instances "reporting" to NIM in an unmanaged way with this spec without issue.

mjang · 2025-01-02T17:01:10Z

The original PR added a section called "Sizing recommendations for License and Usage Reporting Only"

I think this belongs as a subsection of http://docs.nginx.com/nginx-instance-manager/fundamentals/tech-specs/#system-sizing, and have included a link to the "Prepare your environment" section of https://docs.nginx.com/solutions/about-subscription-licenses/#set-up-environment. Here's how my suggested change appears in the build. (@mkingst WDYT?) (I've also reorganized the data into tables compatible with previous sections.)

mjang

See #35 (comment)

mjang · 2025-01-02T15:47:05Z

content/nim/fundamentals/tech-specs.md

-## Sizing recommendations {#system-sizing}
+## Sizing recommendations for License and Usage Reporting Only {#reporting-sizing}
+
+This page assumes NGINX instances are being “managed” by NGINX Instance Manager. The sizing requirements are significantly less if you are just using NGINX Instance Manager for licensing and usage reporting only. NGINX commercial license and usage reporting is done in an “unmanaged” way, where NGINX simply sends a request periodically to NGINX Instance Manager for counting purposes. See the [Report Usage](https://docs.nginx.com/nginx-instance-manager/disconnected/report-usage-disconnected-deployment/) guide.


Suggested change

This page assumes NGINX instances are being “managed” by NGINX Instance Manager. The sizing requirements are significantly less if you are just using NGINX Instance Manager for licensing and usage reporting only. NGINX commercial license and usage reporting is done in an “unmanaged” way, where NGINX simply sends a request periodically to NGINX Instance Manager for counting purposes. See the [Report Usage](https://docs.nginx.com/nginx-instance-manager/disconnected/report-usage-disconnected-deployment/) guide.

This section assumes you've configured NGINX Instance Manager to manage your NGINX instances, for licensing and usage reporting only. NGINX commercial license and usage reporting is done in an “unmanaged” way, where NGINX sends a request periodically to NGINX Instance Manager solely for counting purposes. See the [Report Usage]({{< relref "/solutions/about-subscription-licenses.md#set-up-environment" >}}) guide.

mjang · 2025-01-02T17:05:34Z

I have hereby read the F5 CLA and agree to its terms

mjang · 2025-01-02T17:06:51Z

recheck

mjang

As agreed with @mkingst

mkingst

Looks good, thank you!

y82 · 2025-01-03T15:38:00Z

content/nim/fundamentals/tech-specs.md


+### License and usage reporting only {#reporting-sizing}
+
+This section assumes you've configured NGINX Instance Manager to manage your NGINX instances for licensing and usage reporting only. NGINX commercial license and usage reporting is done in an “unmanaged” way, where NGINX sends a request periodically to NGINX Instance Manager solely for counting purposes. For more information, see how you would [Prepare your environment for reporting]({{< relref "/solutions/about-subscription-licenses.md#set-up-environment" >}}).


I'd suggest adding "Plus" as it's Plus-only feature ("NGINX Plus instances", "NGINX Plus commercial license and usage reporting")

Doesn't this also apply to NIM?

If we're specifying licensed products, would we say "NGINX Plus and NGINX Instance Manager instances..."

Or is the reference to licensing in this paragraph enough?

Update tech-specs.md

eabd6ad

mkingst requested a review from a team as a code owner January 2, 2025 15:21

Suggested changes to PR #35

cbe0c32

mjang self-requested a review January 2, 2025 16:51

mjang assigned mkingst Jan 2, 2025

mkingst commented Jan 2, 2025

View reviewed changes

mjang reviewed Jan 2, 2025

View reviewed changes

This was referenced Jan 2, 2025

bug: the CLA Assistant Lite bot does not respond to recheck f5/.github#3

Closed

bug: the CLA Assistant Lite bot does not respond to recheck #37

Closed

mjang approved these changes Jan 3, 2025

View reviewed changes

mkingst commented Jan 3, 2025

View reviewed changes

mjang merged commit 3e99d18 into main Jan 3, 2025
3 of 5 checks passed

y82 reviewed Jan 3, 2025

View reviewed changes

mjang deleted the mkingst-tech-specs-update-for-ev branch January 7, 2025 17:20


		### License and usage reporting only {#reporting-sizing}

		This section assumes you've configured NGINX Instance Manager to manage your NGINX instances for licensing and usage reporting only. NGINX commercial license and usage reporting is done in an “unmanaged” way, where NGINX sends a request periodically to NGINX Instance Manager solely for counting purposes. For more information, see how you would [Prepare your environment for reporting]({{< relref "/solutions/about-subscription-licenses.md#set-up-environment" >}}).

Update tech-specs.md for ev reporting #35

Update tech-specs.md for ev reporting #35

Uh oh!

Conversation

mkingst commented Jan 2, 2025

Proposed changes

Checklist

Uh oh!

github-actions bot commented Jan 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mkingst commented Jan 2, 2025 via email

Uh oh!

mjang commented Jan 2, 2025

Uh oh!

mkingst Jan 2, 2025

Choose a reason for hiding this comment

Uh oh!

mjang commented Jan 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mjang left a comment

Choose a reason for hiding this comment

Uh oh!

mjang Jan 2, 2025

Choose a reason for hiding this comment

Uh oh!

mjang commented Jan 2, 2025

Uh oh!

mjang commented Jan 2, 2025

Uh oh!

mjang left a comment

Choose a reason for hiding this comment

Uh oh!

mkingst left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

y82 Jan 3, 2025

Choose a reason for hiding this comment

Uh oh!

mjang Jan 3, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Jan 2, 2025 •

edited

Loading

mjang commented Jan 2, 2025 •

edited

Loading