Skip to content

Commit d95865c

Browse files
sjbermantravisamartin
authored andcommitted
Fix missing quote (#676)
A quotation was missing that was not caught by the original PR pipeline.
1 parent 911202b commit d95865c

File tree

2 files changed

+55
-29
lines changed

2 files changed

+55
-29
lines changed

content/ngf/overview/gateway-api-compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ For a description of each field, visit the [Gateway API documentation](https://g
5757

5858
{{< /bootstrap-table >}}
5959

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

6262
**Fields**:
6363

content/nim/deploy/kubernetes/deploy-using-helm.md

Lines changed: 54 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,14 @@ You can deploy F5 NGINX Instance Manager on Kubernetes using Helm. This method i
1313

1414
### New in 2.20.0
1515

16-
Starting with version 2.20.0, NGINX Instance Manager supports **lightweight mode**. This mode skips ClickHouse and disables metrics collectionideal 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.
1717

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

20-
{{< call-out "note" "Chart renamed in NIM 2.20.0" "" >}}
20+
{{< call-out "note" "Chart renamed in NIM 2.20.0" >}}
2121
The Helm chart has been renamed from `nginx-stable/nms-hybrid` to `nginx-stable/nim`.
2222
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 >}}
2624

2725

2826
---
@@ -31,20 +29,22 @@ You can choose standard (with ClickHouse and metrics) or lightweight mode by set
3129

3230
To deploy NGINX Instance Manager using a Helm chart, you need:
3331

34-
{{< bootstrap-table "table table-striped table-bordered" >}}
35-
| Requirements | Notes |
36-
|--------------|-------|
37-
| 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
4633

34+
To deploy NGINX Instance Manager using a Helm chart, you need:
4735

36+
{{< bootstrap-table "table table-striped table-bordered" >}}
37+
| Requirements | Notes |
38+
|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
39+
| 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 >}}
4848

4949
---
5050

@@ -125,17 +125,27 @@ The values file lets you:
125125
- Provide registry credentials
126126
- Specify image sources for each NIM service
127127

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:
129129

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. |
130+
| Mode | Description |
131+
|------------|--------------------------------------------------------------------------------------------|
132+
| `internal` | Deploys ClickHouse in the cluster (default). |
133+
| `external` | Connects to an external ClickHouse instance and requires `nim.externalClickhouse.address`. |
134+
| `disabled` | Disables ClickHouse and enables lightweight mode (no metrics). |
135+
136+
{{< call-out "note" "See also" >}}
137+
See the [Helm chart configuration settings](
138+
https://docs.nginx.com/nginx-instance-manager/deploy/kubernetes/helm-config-settings/
139+
) guide for a complete list of chart parameters.
140+
{{< /call-out >}}
135141

136142
```yaml
137143
nmsClickhouse:
138-
mode: internal # change to "disabled" for lightweight mode
144+
mode: internal # options: internal, external, disabled
145+
146+
# when mode is external, uncomment and set this:
147+
# externalClickhouse:
148+
# address: <clickhouse-host>:<port>
139149
140150
imagePullSecrets:
141151
- name: regcred
@@ -185,7 +195,6 @@ OpenShift support was added in NGINX Instance Manager 2.19. To enable it, add th
185195
For more details, see [Appendix: OpenShift security constraints](#appendix-openshift-security-constraints).
186196
{{< /call-out >}}
187197

188-
189198
---
190199

191200
## Install the chart
@@ -206,6 +215,23 @@ helm install nim nginx-stable/nim \
206215
- Replace `<your-values.yaml>` with the path to your customized values.yaml file.
207216
- Replace `<chart-version>` with the version you want to install (for example, `2.20.0`).
208217

218+
**Note:** You can set the ClickHouse mode at install time instead of editing `values.yaml`:
219+
220+
For lightweight mode (no ClickHouse):
221+
222+
```shell
223+
--set nmsClickhouse.mode=disabled
224+
```
225+
226+
For external ClickHouse:
227+
228+
```shell
229+
--set nmsClickhouse.mode=external \
230+
--set nim.externalClickhouse.address=<clickhouse-host>:<port>
231+
```
232+
233+
**Validate the deployment**
234+
209235
After installation, run the following command to confirm the deployment was successful:
210236

211237
```shell
@@ -315,7 +341,7 @@ secmon app.kubernetes.io/name=secmon 2m
315341

316342
If you’re using lightweight mode, your output may include fewer entries.
317343

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:
319345

320346
```yaml
321347
networkPolicies:
@@ -380,7 +406,7 @@ Run the `helm install` command to deploy NGINX Instance Manager:
380406

381407
{{< 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 >}}
382408
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.
384410
385411
```shell
386412
helm install -n nms \

0 commit comments

Comments
 (0)