Skip to content

Update tech-specs.md for ev reporting #35

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

Merged
merged 2 commits into from
Jan 3, 2025
Merged

Update tech-specs.md for ev reporting #35

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eabd6ad
Update tech-specs.md
mkingst Jan 2, 2025
cbe0c32
Suggested changes to PR #35
mjang Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions content/nim/fundamentals/tech-specs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@ You can deploy NGINX Instance Manager in the following environments:

{{< include "nim/tech-specs/supported-nginx-versions.md" >}}

## 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.

Therefore, the requirements for NGINX Instance Manager when it is just used for licensing and usage reporting is minimal (2 CPU, 4gb memory, 20gb storage).

## Sizing recommendations for Managing NGINX Instances {#system-sizing}

The following recommendations provide the minimum guidelines for NGINX Instance Manager. These guidelines ensure adequate performance, but for optimal results, we strongly recommend using solid-state drives (SSDs) for storage.
Expand Down Expand Up @@ -64,6 +58,18 @@ For environments requiring more resources, **large configurations** are suitable
| 250 | 4 vCPU | 8 GB RAM | 1 GbE NIC | 2 TB |
{{</bootstrap-table>}}

### 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" >}}).
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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?


Therefore, the requirements for NGINX Instance Manager when used solely for licensing and usage reporting are minimal.

{{<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 |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

{{</bootstrap-table>}}

### Sizing benchmarks for storage

The following benchmarks focus on **disk storage** requirements for NGINX Instance Manager. Storage needs depend on the **number of instances** and **data retention periods** (in days). The benchmarks are divided into three configuration sizes:
Expand Down
Loading