Skip to content

Commit d7a6304

Browse files
committed
edits to tech spec guide
1 parent 00f5573 commit d7a6304

File tree

2 files changed

+21
-10
lines changed

2 files changed

+21
-10
lines changed

content/nim/disconnected/add-license-disconnected-deployment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ type:
1818

1919
This guide shows you how to add a license to NGINX Instance Manager in a disconnected (offline) environment. In this setup, systems don’t have internet access. You’ll download and apply your subscription’s JSON Web Token (JWT) license, then verify your entitlements with F5.
2020

21-
{{< call-out "tip" "Using the REST API" "" >}}{{< include "nim/how-to-access-nim-api.md" >}}{{</call-out>}}
21+
{{< call-out "tip" "Using the REST API" "" >}}{{< include "nim/how-to-access-nim-api.md" >}}{{</ call-out >}}
2222

2323

2424
## Before you begin
@@ -39,7 +39,7 @@ To configure NGINX Instance Manager for a disconnected environment, you need to
3939
## Add license and submit initial usage report {#add-license-submit-initial-usage-report}
4040

4141

42-
{{<tabs name="submit-usage-report">}}
42+
{{< tabs name="submit-usage-report" >}}
4343

4444
{{%tab name="Bash script (recommended)"%}}
4545

@@ -86,7 +86,7 @@ To license NGINX Instance Manager, complete each of the following steps in order
8686
8787
Run these `curl` commands on a system that can access NGINX Instance Manager and connect to `https://product.apis.f5.com/` on port `443`. Replace each placeholder with your specific values.
8888
89-
{{<important>}}The `-k` flag skips SSL certificate validation. Use this only if your NGINX Instance Manager is using a self-signed certificate or if the certificate is not trusted by your system.{{</important>}}
89+
{{< important >}}The `-k` flag skips SSL certificate validation. Use this only if your NGINX Instance Manager is using a self-signed certificate or if the certificate is not trusted by your system.{{</ important >}}
9090
9191
1. **Add the license to NGINX Instance Manager**:
9292
@@ -117,7 +117,7 @@ Run these `curl` commands on a system that can access NGINX Instance Manager and
117117
--header "referer: https://<NIM-FQDN>/ui/settings/license"
118118
```
119119
120-
1. **Update the license configuration on NGINX Instance Manager**:
120+
1. **Update the license configuration on NGINX Instance Manager (not required in 2.20 or later)**:
121121
122122
This step ensures that the license configuration is fully applied.
123123

content/nim/fundamentals/tech-specs.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,36 +38,47 @@ This section outlines the recommendations for NGINX Instance Manager deployments
3838

3939
We recommend using SSDs to enhance storage performance.
4040

41-
{{<bootstrap-table "table table-striped table-bordered">}}
41+
{{< bootstrap-table "table table-striped table-bordered" >}}
4242
| Number of Data Plane Instances | CPU | Memory | Network | Storage |
4343
|--------------------------------|--------|----------|-----------|---------|
4444
| 10 | 2 vCPU | 4 GB RAM | 1 GbE NIC | 100 GB |
4545
| 100 | 2 vCPU | 4 GB RAM | 1 GbE NIC | 1 TB |
4646
| 1000 | 4 vCPU | 8 GB RAM | 1 GbE NIC | 3 TB |
47-
{{</bootstrap-table>}}
47+
{{</ bootstrap-table >}}
4848

4949
These values represent the minimum resources needed for deployments that fall under standard configurations.
5050

5151
### Large NGINX configuration deployments
5252

5353
For environments requiring more resources, **large configurations** are suitable. These configurations can support up to **300 upstream servers** and are designed for enterprise environments or applications handling high traffic and complex configurations, without NGINX App Protect.
5454

55-
{{<bootstrap-table "table table-striped table-bordered">}}
55+
{{< bootstrap-table "table table-striped table-bordered" >}}
5656
| Number of Data Plane Instances | CPU | Memory | Network | Storage |
5757
|--------------------------------|--------|----------|-----------|---------|
5858
| 50 | 4 vCPU | 8 GB RAM | 1 GbE NIC | 1 TB |
5959
| 250 | 4 vCPU | 8 GB RAM | 1 GbE NIC | 2 TB |
60-
{{</bootstrap-table>}}
60+
{{</ bootstrap-table >}}
6161

6262
### NGINX configuration deployments with NGINX App Protect {#system-sizing-app-protect}
6363

6464
If using NGINX App Protect features in NGINX Instance Manager, this requires additional CPU and Memory for policy compilation and security monitoring features. At a minimum, 8gb Memory and 4 CPUs are required for a standard NGINX App Protect use case (under 20 NGINX Plus instances). The requirements are heavily dependent on the number of policies being managed, the frequency of updates and the number of events being that occur in the security monitoring feature.
6565

66+
### Lightweight mode {#lightweight-mode}
67+
68+
(New in 2.20.0) You can run NGINX Instance Manager without installing ClickHouse. This setup is useful if you don’t need monitoring data or prefer a simpler deployment. It reduces system requirements and removes the need to manage a metrics database. You can add ClickHouse later if your needs change. For instructions, see [Disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}).
69+
70+
In Lightweight mode, we tested NGINX Instance Manager with ten managed NGINX instances and configuration publishing. It ran with as little as 1 CPU core and 1 GB of memory (without App Protect). When App Protect was enabled, we needed 2 CPU cores and 4 GB of memory to compile policies.
71+
72+
These figures are guidelines only. They reflect the minimum tested configuration and may cause performance issues depending on your setup. For better performance, consider allocating more system resources.
73+
74+
6675
### License and usage reporting only {#reporting-sizing}
6776

68-
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]({{< ref "/solutions/about-subscription-licenses.md#set-up-environment" >}}).
77+
This section applies when you’ve set up NGINX Instance Manager to handle licensing and usage reporting only. In this setup, NGINX instances report license and usage data in an "unmanaged" way. Each instance sends periodic updates to NGINX Instance Manager for counting purposes only.
78+
79+
For details on how to configure this setup, see [Prepare your environment for reporting]({{< ref "/solutions/about-subscription-licenses.md#set-up-environment" >}}).
6980

70-
Therefore, the requirements for NGINX Instance Manager when used solely for licensing and usage reporting are minimal.
81+
When used only for licensing and usage reporting, NGINX Instance Manager has minimal system requirements. We recommend using [Lightweight mode](#lightweight-mode) in this case to avoid the ClickHouse dependency, especially if you don’t plan to use other features.
7182

7283
{{<bootstrap-table "table table-striped table-bordered">}}
7384
| Number of Data Plane Instances | CPU | Memory | Network | Storage |

0 commit comments

Comments
 (0)