Skip to content

Mkingst tech specs updated #535

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Mkingst tech specs updated #535

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54ff399
Update tech-specs.md
mkingst May 8, 2025
284776f
Update install-nim-deprecated.md
mkingst May 8, 2025
99d37b0
Update tech-specs.md
mkingst Jun 11, 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
Prev Previous commit
Update tech-specs.md
  • Loading branch information
@mkingst
mkingst authored Jun 11, 2025
commit 99d37b0aa568a58eb808b445c006eca3ee89301c
5 changes: 3 additions & 2 deletions content/nim/fundamentals/tech-specs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ Below are the directory requirements and storage recommendations for fresh, mini

Important Note: These recommendations apply if you are using NGINX Agent to connect NGINX instances to NIM for full management capabilities (e.g., managing configurations, viewing metrics, applying WAF policies, managing certificates, etc.). If the use case is solely usage reporting, as introduced in R33+, the Agent is not required, and resources needed are significantly reduced. For usage reporting-only deployments, NIM simply receives and stores usage data sent directly from the instances, which does not require the same resource allocation outlined below.
Copy link
Contributor

Choose a reason for hiding this comment

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

I presume you're referring to volume requirements for each noted directory

Suggested change
Important Note: These recommendations apply if you are using NGINX Agent to connect NGINX instances to NIM for full management capabilities (e.g., managing configurations, viewing metrics, applying WAF policies, managing certificates, etc.). If the use case is solely usage reporting, as introduced in R33+, the Agent is not required, and resources needed are significantly reduced. For usage reporting-only deployments, NIM simply receives and stores usage data sent directly from the instances, which does not require the same resource allocation outlined below.
{{< note >}} These recommendations apply if you are using NGINX Agent to connect NGINX instances to NIM for full management capabilities, such as managing configurations, viewing metrics, applying WAF policies, and managing certificates.
If the use case is solely usage reporting, as introduced in R33+, you do not need to use NGINX Agent. This significantly reduces required resources. If your deployment is for reporting-only deployments, NIM receives and stores usage data sent directly from the instances, which do not require the same resources outlined here. {{< /note >}}


- /usr/bin: Stores NIM binaries; recommend 500MB (current size ~400MB).
- /var/lib/nms/dqlite: Stores DQLite database data; recommend 1GB (2GB without NAP, 5GB with NAP enabled and large compiled bundles).
- /usr/bin: Stores NIM binaries; recommend 500MB (usually ~400MB).
- /var/lib/nms/dqlite: Stores DQLite database data; recommend 1GB (2GB without NGINX App Protect, 5GB with NGINX App Protect enabled and large compiled bundles).
- /var/lib/nms/streaming: Stores NATS streaming messages; recommend 500MB.
- /var/lib/nms/secrets: Stores secrets for LLM license handshakes; recommend 10MB.
- /var/lib/nms/modules: Stores static content like manager.json; recommend 100KB (12KB minimum).
Expand All @@ -105,6 +105,7 @@ Important Note: These recommendations apply if you are using NGINX Agent to conn
-For usage reporting-only deployments (without management via Agent):
No ClickHouse metrics are collected.
Resource requirements are significantly reduced, as the usage data is only received and stored by NIM. This generally requires much less disk space and memory allocation. The intended use case (management vs. usage reporting) is critical to avoid allocating unnecessary resources. Regular monitoring, backups, and adjustments are still recommended to optimize operations.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Resource requirements are significantly reduced, as the usage data is only received and stored by NIM. This generally requires much less disk space and memory allocation. The intended use case (management vs. usage reporting) is critical to avoid allocating unnecessary resources. Regular monitoring, backups, and adjustments are still recommended to optimize operations.
Resource requirements are significantly reduced, as the usage data is only received and stored by NIM. This generally requires much less disk space and memory allocation. The intended use case (management versus usage reporting) is critical to avoid allocating unnecessary resources. We still recommend regular monitoring, backups, and adjustments to optimize operations.

-Lightweight Mode (v2.20+) will significantly reduce the storage required, since no Clickhouse database is needed.

#### Storage requirements for NGINX Plus

Expand Down
Loading