You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/ngf/overview/gateway-api-compatibility.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ For a description of each field, visit the [Gateway API documentation](https://g
57
57
58
58
{{< /bootstrap-table >}}
59
59
60
-
NGINX Gateway Fabric supports a single GatewayClass resource configured with the `--gatewayclass` flag of the [controller]({{< ref "/ngf/reference/cli-help.md#controller>}}) command.
60
+
NGINX Gateway Fabric supports a single GatewayClass resource configured with the `--gatewayclass` flag of the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command.
Copy file name to clipboardExpand all lines: content/nim/deploy/kubernetes/deploy-using-helm.md
+54-28Lines changed: 54 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -13,16 +13,14 @@ You can deploy F5 NGINX Instance Manager on Kubernetes using Helm. This method i
13
13
14
14
### New in 2.20.0
15
15
16
-
Starting with version 2.20.0, NGINX Instance Manager supports **lightweight mode**. This mode skips ClickHouse and disables metrics collection—ideal for simpler setups or resource-limited environments.
16
+
Starting with version 2.20.0, NGINX Instance Manager supports **lightweight mode**, which skips ClickHouse and disables metrics collection, ideal for simpler setups or resource-limited environments.
17
17
18
-
Also new in this release: the Helm chart has moved to a dedicated location:
18
+
- Lightweight mode requires NGINX Agent v2.41.1 or later.
19
19
20
-
{{< call-out "note" "Chart renamed in NIM 2.20.0" "" >}}
20
+
{{< call-out "note" "Chart renamed in NIM 2.20.0" >}}
21
21
The Helm chart has been renamed from `nginx-stable/nms-hybrid` to `nginx-stable/nim`.
22
22
Make sure to update your chart references if you’re using version 2.20.0 or later.
23
-
{{</ call-out >}}
24
-
25
-
You can choose standard (with ClickHouse and metrics) or lightweight mode by setting the `clickhouse.mode` value in your `values.yaml` file. We show both deployment examples below.
23
+
{{< /call-out >}}
26
24
27
25
28
26
---
@@ -31,20 +29,22 @@ You can choose standard (with ClickHouse and metrics) or lightweight mode by set
31
29
32
30
To deploy NGINX Instance Manager using a Helm chart, you need:
| Docker 20.10 or later (linux/amd64) |[Docker documentation](https://docs.docker.com/get-docker/)|
38
-
| Kubernetes 1.21.3 or later (linux/amd64) | Ensure your client can [access the Kubernetes API server](https://kubernetes.io/docs/concepts/overview/components/#kube-apiserver). Helm uses the default storage class for persistent volume provisioning. |
39
-
|`kubectl` 1.21.3 or later |[kubectl documentation](https://kubernetes.io/docs/reference/kubectl/)|
40
-
| Helm 3.10.0 or later |[Helm installation guide](https://helm.sh/docs/intro/install/)|
41
-
| OpenSSL 1.1.1 or later |[OpenSSL source](https://www.openssl.org/source/)|
42
-
|`tar` 1.20 or later | The `tar` tool is usually installed by default. Check with `tar --version`. |
43
-
|`values.yaml` file with `clickhouse.mode` setting | Required in version 2.20.0 and later. Set to `standalone` or `disabled`. |
44
-
| NGINX subscription JWT | Required to authenticate with `private-registry.nginx.com` to pull the image. Download your JWT from [MyF5](https://my.f5.com/manage/s/) under **My Products & Plans > Subscriptions**. |
45
-
{{</ bootstrap-table >}}
32
+
## Requirements
46
33
34
+
To deploy NGINX Instance Manager using a Helm chart, you need:
| Docker 20.10 or later (linux/amd64) |[Docker documentation](https://docs.docker.com/get-docker/)|
40
+
| Kubernetes 1.21.3 or later (linux/amd64) | Ensure your client can [access the Kubernetes API server](https://kubernetes.io/docs/concepts/overview/components/#kube-apiserver). Helm uses the default storage class for persistent volume provisioning. |
41
+
|`kubectl` 1.21.3 or later |[kubectl documentation](https://kubernetes.io/docs/reference/kubectl/)|
42
+
| Helm 3.10.0 or later |[Helm installation guide](https://helm.sh/docs/intro/install/)|
43
+
| OpenSSL 1.1.1 or later |[OpenSSL source](https://www.openssl.org/source/)|
44
+
|`tar` 1.20 or later | The `tar` tool is usually installed by default. Check with `tar --version`. |
45
+
|`values.yaml` file with `nmsClickhouse.mode`| Optional. Defaults to `internal`. Set to `external` or `disabled` to use an external ClickHouse instance or enable lightweight mode. In `external` mode, set `nim.externalClickhouse.address` to your ClickHouse host. |
46
+
| NGINX subscription JWT | Required to authenticate with `private-registry.nginx.com` to pull the image. Download your JWT from [MyF5](https://my.f5.com/manage/s/) under **My Products & Plans > Subscriptions**. |
47
+
{{</ bootstrap-table >}}
48
48
49
49
---
50
50
@@ -125,17 +125,27 @@ The values file lets you:
125
125
- Provide registry credentials
126
126
- Specify image sources for each NIM service
127
127
128
-
Set `nmsClickhouse.mode` to control how ClickHouse is deployed. This determines whether you run in standard mode (with internal or external ClickHouse) or lightweight mode (no metrics).
128
+
Set `nmsClickhouse.mode` to control ClickHouse deployment:
129
129
130
-
| Mode | Description |
131
-
|------------|-------------|
132
-
|`internal`| Deploys ClickHouse in the cluster (default). |
133
-
|`external`| Connects to an external ClickHouse instance. |
134
-
|`disabled`| Disables ClickHouse completely and enables lightweight mode. |
If you’re using lightweight mode, your output may include fewer entries.
317
343
318
-
To disable network policies, add the following to your values.yaml file:
344
+
To disable network policies, add the following to your `values.yaml` file:
319
345
320
346
```yaml
321
347
networkPolicies:
@@ -380,7 +406,7 @@ Run the `helm install` command to deploy NGINX Instance Manager:
380
406
381
407
{{< important >}} Remember to save the password for future use. Only the encrypted password is stored, and there's no way to recover or reset it if lost. {{< /important >}}
382
408
383
-
3. Replace `<chart-version>` with the desired chart version 1.15.0 or lower. If omitted, it will lead to an unsuccessful deployment as it will try to install the latest vesrion 1.16.0 or later.
409
+
3. (Optional) Replace `<chart-version>` with the desired chart version. If omitted, the latest version will be installed.
0 commit comments