Skip to content

Commit 4ad7473

Browse files
ADubhlaoichmrajagopalsjbermannginx-aoife
authored
Cherry pick recent documentation changes (#2815)
This commit cherry-picks changes from 3 recent documentation PRs from main to the 1.5 release branch. More specifically, the work in the following PRs: - Update support referencing support package tool #2789 - Docs: remove () typo from troubleshooting doc #2803 - Clear up installation language #2808 --------- Co-authored-by: Madhu Rajagopal <[email protected]> Co-authored-by: Saylor Berman <[email protected]> Co-authored-by: nginx-aoife <[email protected]>
1 parent 4c1f7d3 commit 4ad7473

File tree

4 files changed

+32
-7
lines changed

4 files changed

+32
-7
lines changed

site/content/how-to/monitoring/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ If you check your _nginx_ container logs and see the following error:
469469

470470
It indicates that `proxy_protocol` is enabled for the gateway listeners, but the request sent to the application endpoint does not contain proxy information. To **resolve** this, you can do one of the following:
471471

472-
- Unassign the field [`rewriteClientIP.mode`](({{< relref "reference/api.md" >}})) in the NginxProxy configuration.
472+
- Unassign the field [`rewriteClientIP.mode`]({{< relref "reference/api.md" >}}) in the NginxProxy configuration.
473473

474474
- Send valid proxy information with requests being handled by your application.
475475

site/content/installation/installing-ngf/helm.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ To complete this guide, you'll need to install:
4949

5050
### Install from the OCI registry
5151

52+
The following steps install NGINX Gateway Fabric directly from the OCI helm registry. If you prefer, you can [install from sources](#install-from-sources) instead.
53+
5254
{{<tabs name="install-helm-oci">}}
5355

5456
{{%tab name="NGINX"%}}
@@ -68,7 +70,7 @@ helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-nam
6870
To install the latest stable release of NGINX Gateway Fabric in the **nginx-gateway** namespace, run the following command:
6971

7072
```shell
71-
helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret --create-namespace -n nginx-gateway
73+
helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret -n nginx-gateway
7274
```
7375

7476
{{% /tab %}}
@@ -77,7 +79,7 @@ helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --set nginx
7779

7880
`ngf` is the name of the release, and can be changed to any name you want. This name is added as a prefix to the Deployment name.
7981

80-
If the namespace already exists, you can omit the optional `--create-namespace` flag. If you want the latest version from the **main** branch, add `--version 0.0.0-edge` to your install command.
82+
If you want the latest version from the **main** branch, add `--version 0.0.0-edge` to your install command.
8183

8284
To wait for the Deployment to be ready, you can either add the `--wait` flag to the `helm install` command, or run the following after installing:
8385

@@ -87,6 +89,7 @@ kubectl wait --timeout=5m -n nginx-gateway deployment/ngf-nginx-gateway-fabric -
8789

8890
### Install from sources {#install-from-sources}
8991

92+
If you prefer to install directly from sources, instead of through the OCI helm registry, use the following steps.
9093

9194
{{<include "installation/helm/pulling-the-chart.md" >}}
9295

@@ -109,7 +112,7 @@ helm install ngf . --create-namespace -n nginx-gateway
109112
To install the chart into the **nginx-gateway** namespace, run the following command:
110113

111114
```shell
112-
helm install ngf . --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret --create-namespace -n nginx-gateway
115+
helm install ngf . --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret -n nginx-gateway
113116
```
114117

115118
{{% /tab %}}
@@ -118,8 +121,6 @@ helm install ngf . --set nginx.image.repository=private-registry.nginx.com/nginx
118121

119122
`ngf` is the name of the release, and can be changed to any name you want. This name is added as a prefix to the Deployment name.
120123

121-
If the namespace already exists, you can omit the optional `--create-namespace` flag.
122-
123124
To wait for the Deployment to be ready, you can either add the `--wait` flag to the `helm install` command, or run the following after installing:
124125

125126
```shell
@@ -212,6 +213,8 @@ To upgrade the CRDs, take the following steps:
212213
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.0 need to install an NGINX Plus JWT
213214
Secret before upgrading. Follow the steps in the [Before you begin](#before-you-begin) section to create the Secret. If you use a different name than the default `nplus-license` name, specify the Secret name by setting `--set nginx.usage.secretName=<secret-name>` when running `helm upgrade`. {{</ important >}}
214215

216+
There are two possible ways to upgrade NGINX Gateway Fabric. You can either upgrade from the OCI registry, or download the chart and upgrade from the source.
217+
215218
#### Upgrade from the OCI registry
216219

217220
- To upgrade to the latest stable release of NGINX Gateway Fabric, run:

site/content/installation/nginx-plus-jwt.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ and the following volume mount to the `nginx` container:
8383

8484
{{</tabs>}}
8585

86+
**If you are reporting to the default licensing endpoint, then you can now proceed with [installing NGINX Gateway Fabric]({{< relref "installation/installing-ngf" >}}). Otherwise, follow the steps below to configure reporting to NGINX Instance Manager.**
87+
8688
### Reporting to NGINX Instance Manager {#nim}
8789

8890
If you are deploying NGINX Gateway Fabric in an environment where you need to report to NGINX Instance Manager instead of the default licensing endpoint, a few extra steps may be required.

site/content/support.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,27 @@ weight: 600
55
docs: "DOCS-1411"
66
---
77

8-
NGINX Gateway Fabric adheres to the support policy detailed in the following knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156).
8+
F5 NGINX Gateway Fabric adheres to the support policy detailed in the following knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156).
9+
10+
After opening a support ticket, F5 staff will request additional information to better understand the problem.
11+
12+
The [nginx-supportpkg-for-k8s](https://github.com/nginxinc/nginx-supportpkg-for-k8s) plugin collects the information needed by F5 Technical Support to assist with troubleshooting your issue.
13+
14+
The plugin uses [krew](https://krew.sigs.k8s.io), the plugin manager for the Kubernetes [kubectl](https://kubernetes.io/docs/reference/kubectl/) command-line tool.
15+
16+
The plugin may collect some or all of the following global and namespace-specific information:
17+
18+
- Kubernetes version and information about Nodes and Custom Resources
19+
- Kubernetes metrics
20+
- Helm deployments
21+
- List of Pods, Events, ConfigMaps, Services, Deployments, Daemonsets, StatefulSets, ReplicaSets, and Leases
22+
- Pod log output
23+
- `nginx -T` output from NGINX-related Pods
24+
25+
This plugin **does not** collect secrets or coredumps.
26+
27+
Visit the [project’s GitHub repository](https://github.com/nginxinc/nginx-supportpkg-for-k8s) for further details.
28+
929

1030
**Support Channels:**
1131

0 commit comments

Comments
 (0)