Skip to content

Commit f744d7a

Browse files
vvnginxmjang
andauthored
Add Directory storage requirements. Also, dependency requirements for NIM, NGINX and Clickhouse in offline mode (#1038)
* fix: Add directory storage recommendations for NIM * fix: Remove unwanted content * fix: Add NGINX, NIM and Clickhouse dependency list, Directory requirements * Update content/nim/disconnected/offline-install-guide.md Co-authored-by: Mike Jang <[email protected]> * Update content/nim/disconnected/offline-install-guide.md Co-authored-by: Mike Jang <[email protected]> * Update content/nim/disconnected/offline-install-guide.md Co-authored-by: Mike Jang <[email protected]> * Update content/nim/disconnected/offline-install-guide.md Co-authored-by: Mike Jang <[email protected]> * Update content/nim/disconnected/offline-install-guide.md Co-authored-by: Mike Jang <[email protected]> * Update content/nim/disconnected/offline-install-guide.md Co-authored-by: Mike Jang <[email protected]> * Update content/nim/fundamentals/tech-specs.md Co-authored-by: Mike Jang <[email protected]> * Update content/nim/fundamentals/tech-specs.md Co-authored-by: Mike Jang <[email protected]> * Update content/nim/disconnected/offline-install-guide.md Co-authored-by: Mike Jang <[email protected]> * Update content/nim/fundamentals/tech-specs.md Co-authored-by: Mike Jang <[email protected]> * Apply suggestion from @mjang --------- Co-authored-by: Mike Jang <[email protected]>
1 parent b1acd1a commit f744d7a

File tree

2 files changed

+53
-1
lines changed

2 files changed

+53
-1
lines changed

content/nim/disconnected/offline-install-guide.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,28 @@ Run the installation script in `offline` mode to download NGINX Instance Manager
9494

9595
After you’ve packaged the installation files on a connected system, copy the tarball, script, and SSL files to your disconnected system. Then, run the script again to install NGINX Instance Manager using the tarball.
9696

97+
## Dependencies needed for install script to run offline
98+
99+
There are OS dependencies we have for NGINX, NIM and Clickhouse. In offline mode we package only NGINX, NIM and Clickhouse packages, customers should first install OS dependencies also. Below are the dependencies list for Linux distributions with `.deb` (Debian/Ubuntu) and `.rpm` (Red Hat) packages. In online mode, these dependencies are auto resolved and installed.
100+
101+
### Debian/Ubuntu and similar operating systems
102+
103+
- NGINX : libc6, libcrypt1, libpcre2-8-0, libssl3, zlib1g,lsb-base
104+
- NIM : openssl, rsyslog, systemd, tar, lsb-release, openssl, gawk
105+
- ClickHouse: libcap2-bin
106+
107+
### Red Hat-based operating systems
108+
109+
- NGINX : bash, glibc, libxcrypt, openssl-libs, glibc, pcre2, openssl-libs, zlib, procps-ng, glibc , shadow-utils, systemd
110+
- NIM : glibc, openssl, rsyslog,systemd, tar, which,zlib, yum-utils
111+
- ClickHouse: None
112+
113+
You can find the latest dependencies with one of the following commands:
114+
115+
- Ubuntu/Debian: apt-cache depends <package_name>=<version>
116+
- Red Hat : yum deplist <packagename-version>
117+
118+
97119
### Required flags for installing in offline mode
98120

99121
- `-m offline`: Required to run the script in offline mode. When used with `-i`, the script installs NGINX Instance Manager and its dependencies from the specified tarball.
@@ -210,4 +232,4 @@ sudo systemctl restart nms-dpm
210232

211233
## Next steps
212234

213-
- [Add NGINX Open Source and NGINX Plus instances to NGINX Instance Manager]({{< ref "nim/nginx-instances/add-instance.md" >}})
235+
- [Add NGINX Open Source and NGINX Plus instances to NGINX Instance Manager]({{< ref "nim/nginx-instances/add-instance.md" >}})

content/nim/fundamentals/tech-specs.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,37 @@ The table below shows the estimated storage requirements for **NGINX OSS**, base
132132
| | 250 | 14 | 4 GiB |
133133
{{</bootstrap-table>}}
134134

135+
## Directory Requirements for NGINX Instance Manager
136+
137+
Below are the directory requirements and storage recommendations for fresh, minimal, and moderate usage (<100 instances) of NGINX Instance Manager (NIM).
138+
139+
{{< call-out "important" >}}
140+
These recommendations apply if you are using NGINX Agent to connect NGINX instances to NIM for full management capabilities, including:
141+
142+
- Managing configurations
143+
- Viewing metrics
144+
- Applying WAF policies
145+
- Managing certificates
146+
147+
If you're concerned solely on usage reporting, you do not need NGINX Agent. Required resources needed are significantly reduced. For usage reporting-only deployments, NIM receives and stores usage data sent directly from the instances.
148+
{{< /call-out >}}
149+
150+
{{<bootstrap-table "table table-striped table-bordered">}}
151+
| Directory path | Content | Recommendation |
152+
|-----------------------|-----------------|----------------------------------|
153+
| /usr/bin | Stores NIM binaries | 500MB |
154+
| /var/lib/nms/dqlite | Stores DQLite database data| 2GiB without NGINX App Protect; 5GiB with NGINX App Protect enabled and large compiled bundles |
155+
| /var/lib/nms/streaming | Stores NATS streaming messages | 500MiB |
156+
| /var/lib/nms/secrets | Stores secrets for LLM license handshakes | 10MiB |
157+
| /var/lib/nms/modules | Stores static content like manager.json | 100KiB (12KiB minimum) |
158+
| /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 |
159+
| /var/log/nms | Stores logs for NIM with rotation enabled | recommended 50MiB per week if archived once a month |
160+
| /etc/nms/ | Stores NIM configuration files | 50MiB |
161+
| /etc/nginx | Stores NGINX configuration files | typical size is 10MiB-50MiB |
162+
{{</bootstrap-table>}}
163+
135164
## ClickHouse tuning {#clickhouse-tuning}
165+
136166
The default ClickHouse configuration works efficiently with NGINX Instance Manager. If you change the configuration and ClickHouse runs out of memory, see the [ClickHouse configuration guide]({{< ref "/nim/system-configuration/configure-clickhouse.md#clickhouse-tuning" >}}) to adjust the settings.
137167

138168
## Firewall ports {#firewall}

0 commit comments

Comments
 (0)