Skip to content

Commit 1e9dc63

Browse files
committed
edits to NIM 2.20 docs and install script
1 parent d6f0e0a commit 1e9dc63

File tree

5 files changed

+943
-12
lines changed

5 files changed

+943
-12
lines changed

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 metricsbecause 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 >}}.
9+
If you’re not collecting metricsbecause you didn’t install ClickHouse or don’t plan to use it —y ou 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/kubernetes/deploy-using-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ kubectl create secret docker-registry regcred \
7272
### OpenShift
7373

7474
```shell
75-
oc new-project nms
75+
oc new-project nms && \
7676
oc create secret docker-registry regcred \
7777
--docker-server=private-registry.nginx.com \
7878
--docker-username=<NGINX JWT Token> \

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Follow these steps to download the certificate and private key for NGINX Instanc
5858

5959
Install NGINX Open Source or NGINX Plus on the host where you'll install NGINX Instance Manager. NGINX Instance Manager uses NGINX as a front-end proxy and for managing user access.
6060

61-
- [Installing NGINX and NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/)
61+
- [Installing NGINX and NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}})
6262

6363
<br>
6464

@@ -88,9 +88,9 @@ Make sure to review the [Technical Specifications]({{< ref "/nim/fundamentals/te
8888

8989
NGINX Instance Manager uses ClickHouse to store metrics, events, alerts, and configuration data.
9090

91-
In 2.20.0, we introduced Lightweight mode, which can skip the ClickHouse installation entirely. It’s ideal if you don’t need monitoring data or want a simpler setup. This reduces system requirements and avoids the work of managing a metrics database. You can add ClickHouse later if your needs change.
91+
Starting in version 2.20.0, you can run NGINX Instance Manager in Lightweight mode, which skips the ClickHouse installation entirely. This setup works well if you don’t need monitoring data or want to reduce system requirements. It also avoids the effort of managing a metrics database. You can add ClickHouse later if your needs change.
9292

93-
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.
93+
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` and `/etc/nms-sm.conf.yaml` files.
9494

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

@@ -203,7 +203,7 @@ To install NGINX Instance Manager, you need to add the official repository to pu
203203
1. To upgrade to the latest version of the Instance Manager, run the following command:
204204

205205
```bash
206-
sudo apt-get update
206+
sudo apt-get update && \
207207
sudo apt-get install -y --only-upgrade nms-instance-manager
208208
```
209209

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

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ type:
1313
## Overview
1414

1515
NGINX Instance Manager uses ClickHouse to store metrics, events, alerts, and configuration data.
16-
If your setup differs from the default configurationfor example, if you use a custom address, enable TLS, set a password, or turn off metricsyou need to update the `/etc/nms/nms.conf` file.
16+
If your setup differs from the default configurationfor example, if you use a custom address, enable TLS, set a password, or turn off metricsyou need to update the `/etc/nms/nms.conf` file.
1717

1818
This guide explains how to update those settings so that NGINX Instance Manager can connect to ClickHouse correctly.
1919

@@ -38,19 +38,27 @@ 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 mode 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 >}}.
41+
Starting in version 2.20, NGINX Instance Manager can run without ClickHouse. This lightweight mode reduces system requirements and simplifies installation for users who don't 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

45-
1. Open the configuration file at `/etc/nms/nms.conf`.
46-
45+
1. Open the config file at `/etc/nms/nms.conf`.
46+
4747
2. In the `[clickhouse]` section, set the following value:
4848

4949
```yaml
50-
enable = false
50+
clickhouse:
51+
enable = false
5152
```
5253
53-
3. Restart the NGINX Instance Manager service:
54+
3. Open the `/etc/nms-sm-conf.yaml` file and set:
55+
56+
```yaml
57+
clickhouse:
58+
enable = false
59+
```
60+
61+
4. Restart the NGINX Instance Manager service:
5462

5563
```shell
5664
sudo systemctl restart nms

0 commit comments

Comments
 (0)