Skip to content

Commit d06ffe0

Browse files
committed
added variable for lightweight NIM NGINX Agent requirement
1 parent dcd4cda commit d06ffe0

File tree

7 files changed

+14
-13
lines changed

7 files changed

+14
-13
lines changed

content/includes/nim/clickhouse/cli-skip-clickhouse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ files:
55
- content/nim/disconnected/offline-install-guide.md
66
---
77

8-
If you skip installing ClickHouse, you need NGINX Agent 2.41.1 or later.
8+
If you skip installing ClickHouse, you need NGINX Agent {{< lightweight-nim-nginx-agent-version >}}.
99

1010
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.

content/includes/nim/clickhouse/clickhouse-install.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,12 @@ files:
66

77
NGINX Instance Manager uses [ClickHouse](https://clickhouse.com) to store metrics, events, alerts, and configuration settings.
88

9-
{{< call-out "important" "ClickHouse configuration requirements" "" >}}
10-
If you install ClickHouse and choose to set a password (the default is an empty string), you must add it to the `clickhouse.password` setting in the `/etc/nms/nms.conf` file. If the password is missing or incorrect, NGINX Instance Manager will not start.
9+
If you install ClickHouse and choose to set a password (the default is an empty string), you must add it to the `clickhouse.password` setting in the `/etc/nms/nms.conf` file. If the password is missing or incorrect, NGINX Instance Manager **will not start**.
1110

1211
For instructions and additional configuration options, including TLS settings, see [Configure ClickHouse]({{< ref "nim/system-configuration/configure-clickhouse.md" >}}).
13-
{{< /call-out >}}
1412

15-
{{< call-out "note" "ClickHouse version requirement" "" >}}NGINX Instance Manager requires ClickHouse version {{< clickhouse-version >}} or later.
16-
{{< /call-out >}}
13+
NGINX Instance Manager requires ClickHouse version {{< clickhouse-version >}} or later.
14+
1715

1816
Follow these steps to install and enable ClickHouse on supported Linux distributions.
1917

content/includes/nim/installation/install-script-flags/skip-clickhouse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ files:
55
- content/nim/disconnected/offline-install-guide.md
66
---
77

8-
`-s`: Skip installing ClickHouse (useful if you don’t require metrics).
8+
`-s`: Skip installing ClickHouse. This lightweight option reduces system requirements and simplifies installation for users who do not need metrics.
99

1010
{{< include "nim/clickhouse/cli-skip-clickhouse.md" >}}

content/includes/nim/installation/optional-steps/disable-metrics-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ files:
66
- content/nim/disconnected/offline-install-guide.md
77
---
88

9-
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.
9+
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 {{< lightweight-nim-nginx-agent-version >}}.
1010

1111
For instructions, see [Disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}).

content/nim/deploy/vm-bare-metal/install-nim-manual.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Follow these steps to download the certificate and private key for NGINX Instanc
5050
sudo mv <nginx-mgmt-suite-trial.key> /etc/ssl/nginx/nginx-repo.key
5151
```
5252

53-
{{<note>}}The downloaded filenames may vary depending on your subscription type. Modify the commands above accordingly to match the actual filenames.{{</note>}}
53+
The downloaded filenames may vary depending on your subscription type. Modify the commands above accordingly to match the actual filenames.
5454

5555
---
5656

@@ -60,7 +60,9 @@ Install NGINX Open Source or NGINX Plus on the host where you'll install NGINX I
6060

6161
- [Installing NGINX and NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/)
6262

63-
{{<note>}}If you're installing NGINX Plus, you can use the `nginx-repo.key` and `nginx-repo.crt` that you added in the [previous section](#download-cert-key).{{</note>}}
63+
<br>
64+
65+
If you're installing NGINX Plus, you can use the `nginx-repo.key` and `nginx-repo.crt` that you added in the [previous section](#download-cert-key).
6466

6567
<details open>
6668
<summary><i class="fa-solid fa-circle-info"></i> Supported NGINX versions</summary>
@@ -76,7 +78,7 @@ Install NGINX Open Source or NGINX Plus on the host where you'll install NGINX I
7678

7779
</details>
7880

79-
{{< see-also >}} Make sure to review the [Technical Specifications]({{< ref "/nim/fundamentals/tech-specs" >}}) guide for sizing requirements and other recommended specs. {{< /see-also >}}
81+
Make sure to review the [Technical Specifications]({{< ref "/nim/fundamentals/tech-specs" >}}) guide for sizing requirements and other recommended specs.
8082

8183
---
8284

@@ -86,7 +88,7 @@ Install NGINX Open Source or NGINX Plus on the host where you'll install NGINX I
8688

8789
NGINX Instance Manager uses ClickHouse to store metrics, events, alerts, and configuration data.
8890

89-
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.
91+
If you don’t need to store metrics, you can skip installing ClickHouse. But you must use NGINX Agent version {{< lightweight-nim-nginx-agent-version >}}, and you must disable metrics collection in the `/etc/nms/nms.conf` file.
9092

9193
For instructions, see [Disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}).
9294

content/nim/system-configuration/configure-clickhouse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Unless otherwise specified in the `/etc/nms/nms.conf` file, NGINX Instance Manag
3838

3939
## Disable metrics collection
4040

41-
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.
41+
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 {{< lightweight-nim-nginx-agent-version >}}.
4242

4343
To disable metrics collection after installing NGINX Instance Manager:
4444

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.41.1 or later

0 commit comments

Comments
 (0)