From 54ff3992e3a76b4095e69d38389a298e1316ebc3 Mon Sep 17 00:00:00 2001 From: Micheal Kingston <44472403+mkingst@users.noreply.github.com> Date: Thu, 8 May 2025 09:09:44 +0100 Subject: [PATCH 1/3] Update tech-specs.md --- content/nim/fundamentals/tech-specs.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/content/nim/fundamentals/tech-specs.md b/content/nim/fundamentals/tech-specs.md index d5035bac0..76c442895 100644 --- a/content/nim/fundamentals/tech-specs.md +++ b/content/nim/fundamentals/tech-specs.md @@ -83,6 +83,29 @@ The following benchmarks focus on **disk storage** requirements for NGINX Instan - **Medium configuration**: Usually includes about **50 servers**, **200 locations**, and **200 upstreams/backends**. Each instance generates **16,766 metrics per minute**. - **Generic Large configuration**: Handles up to **100 servers**, **1,000 locations**, and **900 upstreams/backends**. In **NGINX Plus**, each instance generates **59,484 metrics per minute**. + +#### Directory Requirements for NGINX Instance Manager + +Below are the directory requirements and storage recommendations for fresh, minimal, and moderate usage (<100 instances) of NGINX Instance Manager (NIM). + +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. + +- /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). +- /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). +- /var/lib/clickhouse: Stores ClickHouse metrics data; recommend 2.5GB per instance (25GB for 10 instances, 250GB for 100 instances). This is only required if ClickHouse metrics are enabled. In NIM 2.20, lightweight mode can be deployed without ClickHouse (no metrics collected). +- /var/log/nms: Stores logs for NIM with rotation enabled; recommend 50MB per week if archived once a month. +- /etc/nms/: Stores NIM configuration files; recommend 50MB. +- /etc/nginx: Stores NGINX configuration files; typical size is 10–50MB (confirm with specific deployments). + +**Key Considerations**: +-Resources listed above are necessary for instance management using NIM (via NGINX Agent). +-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. + #### Storage requirements for NGINX Plus The table below provides storage estimates for **NGINX Plus** based on configuration size, number of instances, and a 14-day data retention period. Larger configurations and longer retention periods will require proportionally more storage. From 284776f2926e6b058caeaaccf66be40a8fd5be63 Mon Sep 17 00:00:00 2001 From: Micheal Kingston <44472403+mkingst@users.noreply.github.com> Date: Thu, 8 May 2025 09:14:04 +0100 Subject: [PATCH 2/3] Update install-nim-deprecated.md --- content/nim/deploy/vm-bare-metal/install-nim-deprecated.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/nim/deploy/vm-bare-metal/install-nim-deprecated.md b/content/nim/deploy/vm-bare-metal/install-nim-deprecated.md index d5af56dd0..2b0190a9e 100644 --- a/content/nim/deploy/vm-bare-metal/install-nim-deprecated.md +++ b/content/nim/deploy/vm-bare-metal/install-nim-deprecated.md @@ -1,7 +1,7 @@ --- description: '' docs: DOCS-1211 -title: Manually install on a virtual machine or bare metal (deprecated) +title: Manually install on a virtual machine or bare metal (Manual Method) toc: true weight: 10 noindex: true @@ -14,7 +14,7 @@ type: Follow the steps in this guide to install or upgrade NGINX Instance Manager. {{}} -This document outlines manual steps that have been replaced by a simplified script-based process. For most users, we recommend using the updated process documented [here]({{< ref "nim/deploy/vm-bare-metal/install.md" >}}).{{}} +This document outlines manual steps to install NGINX Instance Manager. There is also a simplified script-based installation guide on the other section that we reccommend for faster deployment. For most users, we recommend using the updated process documented [here]({{< ref "nim/deploy/vm-bare-metal/install.md" >}}). If there are issues when running the script, these manual steps may be better suited to specific environments. {{}} ## Before You Begin From 99d37b0aa568a58eb808b445c006eca3ee89301c Mon Sep 17 00:00:00 2001 From: Micheal Kingston <44472403+mkingst@users.noreply.github.com> Date: Wed, 11 Jun 2025 15:24:57 +0100 Subject: [PATCH 3/3] Update tech-specs.md --- content/nim/fundamentals/tech-specs.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/nim/fundamentals/tech-specs.md b/content/nim/fundamentals/tech-specs.md index 76c442895..9bbfe007b 100644 --- a/content/nim/fundamentals/tech-specs.md +++ b/content/nim/fundamentals/tech-specs.md @@ -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. -- /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). @@ -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. +-Lightweight Mode (v2.20+) will significantly reduce the storage required, since no Clickhouse database is needed. #### Storage requirements for NGINX Plus