Skip to content

Commit e3af284

Browse files
committed
Merge branch 'internal/nim-release-2.20.0' of github.com:nginx/internal-docs into internal/nim-release-2.20.0
2 parents ada7163 + 494c076 commit e3af284

File tree

2 files changed

+8
-14
lines changed

2 files changed

+8
-14
lines changed

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

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ 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.
92+
9193
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.
9294

9395
For instructions, see [Disable metrics collection]({{< ref "nim/system-configuration/configure-clickhouse.md#disable-metrics-collection" >}}).
@@ -104,18 +106,6 @@ NGINX Instance Manager uses the following default values for ClickHouse. To chan
104106

105107
---
106108

107-
## (Optional) Install and Configure Vault {#install-vault}
108-
109-
NGINX Instance Manager can use [Vault](https://www.vaultproject.io/) as a datastore for secrets.
110-
111-
To install and enable Vault, take the following steps:
112-
113-
- Follow Vault's instructions to [install Vault 1.8.8 or later](https://www.vaultproject.io/docs/install) for your distribution.
114-
- Ensure you are running Vault in a [Production Hardened Environment](https://learn.hashicorp.com/tutorials/vault/production-hardening).
115-
- After installing NGINX Instance Manager, follow the steps to [Configure Vault for Storing Secrets]({{< ref "nim/system-configuration/configure-vault.md" >}}).
116-
117-
---
118-
119109
## Add NGINX Instance Manager Repository {#add-nms-repo}
120110

121111
To install NGINX Instance Manager, you need to add the official repository to pull the pre-compiled `deb` and `rpm` packages from.
@@ -240,4 +230,4 @@ To install NGINX Instance Manager, you need to add the official repository to pu
240230

241231
## Next steps
242232

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

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,10 @@ The script supports only new installations. If NGINX Instance Manager is already
112112

113113
Ensure that the required `.crt` and `.key` files are available, preferably in the default **/etc/ssl/nginx** directory. Missing certificates or keys will prevent the script from completing the installation.
114114

115+
#### Verify If Metrics Are Required (Exclude ClickHouse)
116+
117+
In 2.20.0, we introduced Lightweight mode, which means you 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.
118+
115119
#### Use the manual installation steps if needed
116120

117121
If the script fails or if you prefer more control over the process, consider using the [manual installation steps]({{< ref "nim/deploy/vm-bare-metal/install-nim-manual.md" >}}). These steps provide a reliable alternative for troubleshooting or handling complex setups.
@@ -301,4 +305,4 @@ bash install-nim-bundle.sh -r
301305
302306
## Next steps
303307
304-
- [Add NGINX Open Source and NGINX Plus instances to NGINX Instance Manager]({{< ref "nim/nginx-instances/add-instance.md" >}})
308+
- [Add NGINX Open Source and NGINX Plus instances to NGINX Instance Manager]({{< ref "nim/nginx-instances/add-instance.md" >}})

0 commit comments

Comments
 (0)