added NGINX Agent version requirement for lightweight NIM

travisamartin · travisamartin · commit 97889263e0dc · 2025-05-29T09:53:18.000-07:00
diff --git a/content/includes/nim/clickhouse/cli-skip-clickhouse.md b/content/includes/nim/clickhouse/cli-skip-clickhouse.md
@@ -5,4 +5,6 @@ files:
 - content/nim/disconnected/offline-install-guide.md
 ---
 
-If you skip installing ClickHouse, make sure to [disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}) in the `/etc/nms/nms.conf` file after installation.
+If you skip installing ClickHouse, you need NGINX Agent 2.41.1 or later.
+
+After installation, make sure to [disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}) in the `/etc/nms/nms.conf` file.
diff --git a/content/includes/nim/installation/optional-steps/disable-metrics-collection.md b/content/includes/nim/installation/optional-steps/disable-metrics-collection.md
@@ -6,6 +6,6 @@ files:
 - content/nim/disconnected/offline-install-guide.md
 ---
 
-If you are not collecting metrics—either because you did not install ClickHouse or no longer want to use it—you must disable metrics collection by editing the `/etc/nms/nms.conf` file.
+If you’re not collecting metrics—because you didn’t install ClickHouse or don’t plan to use it—you must disable metrics collection in the `/etc/nms/nms.conf` file. This setup requires NGINX Agent version 2.41.1 or later.
 
 For instructions, see [Disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}).
diff --git a/content/nim/deploy/vm-bare-metal/install-nim-deprecated.md b/content/nim/deploy/vm-bare-metal/install-nim-deprecated.md
@@ -76,7 +76,7 @@ Install NGINX Open Source or NGINX Plus on the host where you'll install NGINX I
 
 </details>
 
-{{<see-also>}}Make sure to review the [Technical Specifications]({{< ref "/nim/fundamentals/tech-specs" >}}) guide for sizing requirements and other recommended specs.{{</see-also>}}
+{{< see-also >}} Make sure to review the [Technical Specifications]({{< ref "/nim/fundamentals/tech-specs" >}}) guide for sizing requirements and other recommended specs. {{< /see-also >}}
 
 ---
 
@@ -86,7 +86,7 @@ Install NGINX Open Source or NGINX Plus on the host where you'll install NGINX I
 
 NGINX Instance Manager uses ClickHouse to store metrics, events, alerts, and configuration data.
 
-If you do not need to store metrics, you can skip the installation steps in this section. Instead, you must disable metrics collection in the `/etc/nms/nms.conf` configuration file.
+If you don’t need to store metrics, you can skip installing ClickHouse. But you must use NGINX Agent version 2.41.1 or later, and you must disable metrics collection in the `/etc/nms/nms.conf` file.
 
 For instructions, see [Disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}).
 
diff --git a/content/nim/deploy/vm-bare-metal/install.md b/content/nim/deploy/vm-bare-metal/install.md
@@ -129,41 +129,17 @@ By default, the script:
 - Installs the latest version of NGINX Instance Manager
 - Requires an active internet connection
 
-You can customize the installation using the following options:
-
-**Installation platform**
-
-- {{< include "nim/installation/install-script-flags/distribution.md" >}}
-
-**SSL certificate and key**
-
-- {{< include "nim/installation/install-script-flags/cert.md" >}}
-- {{< include "nim/installation/install-script-flags/key.md" >}}
-
-
-**NGINX installation**
-
-You can install either NGINX Open Source or NGINX Plus—but not both.  
+#### Installation script options
 
-If you don’t specify `-n` or `-p`, the script installs the latest version of NGINX Open Source by default.
-
-- `-n`: Install the latest version of NGINX Open Source.
-- `-p`: Install the latest version of NGINX Plus as the API gateway. Must be used with `-j` to provide a JWT license.
-- `-j <path/to/license.jwt>`: Path to the `license.jwt` file (required if using `-p` to install NGINX Plus).  
-
-    A JWT license is required for NGINX Plus R33 and later (see [NGINX Plus R33 release notes]({{< ref "nginx/releases.md#r33" >}})).
-
-    By default, the script looks for the license at `/etc/nginx/license.jwt` (or `/usr/local/etc/nginx/license.jwt` on FreeBSD).
-
-    If you use a custom path, note that custom paths aren’t supported until after the R33 upgrade.  
-    See [About subscription licenses]({{< ref "solutions/about-subscription-licenses.md#apply-the-jwt" >}}) for details and a workaround.
-
-**ClickHouse installation**
-
-- {{< include "nim/installation/install-script-flags/skip-clickhouse.md" >}}
+You can customize the installation using the following options:
 
-- {{< include "nim/installation/install-script-flags/clickhouse-version.md" >}}
 
+| Category | Option or Flag |
+|----------|----------------|
+| **Installation platform** | {{< include "nim/installation/install-script-flags/distribution.md" >}} |
+| **SSL certificate and key** | {{< include "nim/installation/install-script-flags/cert.md" >}}<br>{{< include "nim/installation/install-script-flags/key.md" >}} |
+| **NGINX installation** | `-n` Install the latest version of NGINX Open Source. *(Default if `-n` or `-p` not specified)*<br><br>`-p` Install NGINX Plus as the API gateway. Must be used with `-j` to provide a JWT license.<br><br>`-j <path>` Path to the `license.jwt` file. Required when using `-p`. |
+| **ClickHouse installation** | {{< include "nim/installation/install-script-flags/skip-clickhouse.md" >}}<br>{{< include "nim/installation/install-script-flags/clickhouse-version.md" >}} |
 
 **Example: install with default key and certificate paths**
 
diff --git a/content/nim/disconnected/offline-install-guide-deprecated.md b/content/nim/disconnected/offline-install-guide-deprecated.md
@@ -14,9 +14,9 @@ This guide explains how to install and upgrade NGINX Instance Manager in environ
 
 ## Before you begin
 
-{{<call-out "important" "Complete the required prerequisites" "fas fa-exclamation-triangle">}}
+{{< call-out "important" "Complete the required prerequisites" "fas fa-exclamation-triangle" >}}
 You must complete the following prerequisite steps **before** installing NGINX Instance Manager. **Skipping these steps could cause installation issues**.
-{{</call-out>}}
+{{</ call-out >}}
 
 ### Security considerations
 
diff --git a/content/nim/disconnected/offline-install-guide.md b/content/nim/disconnected/offline-install-guide.md
@@ -68,33 +68,14 @@ Download the SSL certificate and private key required for NGINX Instance Manager
 
 Run the installation script in `offline` mode to download NGINX Instance Manager, NGINX Open Source, ClickHouse (unless skipped), and all required dependencies into a tarball for use in disconnected environments.
 
-### Required flags for packaging
-
-**Installation mode and platform**
-
-- `-m offline`: Required to package the installation files into a tarball for disconnected environments.
-- {{< include "nim/installation/install-script-flags/distribution.md" >}}
-
-**SSL certificate and key**
-
-- {{< include "nim/installation/install-script-flags/cert.md" >}}
-- {{< include "nim/installation/install-script-flags/key.md" >}}
-
-**NGINX installation**
-
-- `-n`: Include the latest version of NGINX Open Source in the tarball. 
-
-  This option is optional in `offline` mode—if not specified, the script installs the latest version of NGINX Open Source by default.
-
-  NGINX Plus is **not supported** when using the script in offline mode.  
-
-  To install NGINX Plus offline, see the [manual installation guide]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md#offline_install" >}}).
-
-**ClickHouse installation**
-
-- {{< include "nim/installation/install-script-flags/skip-clickhouse.md" >}}
-
-- {{< include "nim/installation/install-script-flags/clickhouse-version.md" >}}
+### Installation script options
+
+| Category | Option or Flag |
+|----------|----------------|
+| **Installation mode and platform** | `-m offline`: Required to package the installation files into a tarball for disconnected environments.<br>{{< include "nim/installation/install-script-flags/distribution.md" >}} |
+| **SSL certificate and key** | {{< include "nim/installation/install-script-flags/cert.md" >}}<br>{{< include "nim/installation/install-script-flags/key.md" >}} |
+| **NGINX installation** | `-n`: Include the latest version of NGINX Open Source in the tarball.<br><br>This option is optional in `offline` mode—if not specified, the script installs the latest version of NGINX Open Source by default.<br><br>NGINX Plus is **not supported** when using the script in offline mode.<br><br>To install NGINX Plus offline, see the [manual installation guide]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md#offline_install" >}}). |
+| **ClickHouse installation** | {{< include "nim/installation/install-script-flags/skip-clickhouse.md" >}}<br>{{< include "nim/installation/install-script-flags/clickhouse-version.md" >}} |
 
 ### Example: packaging command
 
diff --git a/content/nim/system-configuration/configure-clickhouse.md b/content/nim/system-configuration/configure-clickhouse.md
@@ -38,7 +38,7 @@ Unless otherwise specified in the `/etc/nms/nms.conf` file, NGINX Instance Manag
 
 ## Disable metrics collection
 
-As of version 2.20, NGINX Instance Manager can run without ClickHouse. This lightweight option reduces system requirements and simplifies installation for users who do not need metrics.
+As of version 2.20, NGINX Instance Manager can run without ClickHouse. This lightweight option reduces system requirements and simplifies installation for users who do not need metrics. To use this setup, you must run NGINX Agent version 2.41.1 or later.
 
 To disable metrics collection after installing NGINX Instance Manager:
 
