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
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]>
Copy file name to clipboardExpand all lines: site/content/how-to/monitoring/troubleshooting.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -469,7 +469,7 @@ If you check your _nginx_ container logs and see the following error:
469
469
470
470
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:
471
471
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.
473
473
474
474
- Send valid proxy information with requests being handled by your application.
Copy file name to clipboardExpand all lines: site/content/installation/installing-ngf/helm.md
+8-5Lines changed: 8 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -49,6 +49,8 @@ To complete this guide, you'll need to install:
49
49
50
50
### Install from the OCI registry
51
51
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.
`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.
79
81
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.
81
83
82
84
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:
`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.
120
123
121
-
If the namespace already exists, you can omit the optional `--create-namespace` flag.
122
-
123
124
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:
124
125
125
126
```shell
@@ -212,6 +213,8 @@ To upgrade the CRDs, take the following steps:
212
213
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.0 need to install an NGINX Plus JWT
213
214
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 >}}
214
215
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
+
215
218
#### Upgrade from the OCI registry
216
219
217
220
- To upgrade to the latest stable release of NGINX Gateway Fabric, run:
Copy file name to clipboardExpand all lines: site/content/installation/nginx-plus-jwt.md
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -83,6 +83,8 @@ and the following volume mount to the `nginx` container:
83
83
84
84
{{</tabs>}}
85
85
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
+
86
88
### Reporting to NGINX Instance Manager {#nim}
87
89
88
90
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.
Copy file name to clipboardExpand all lines: site/content/support.md
+21-1Lines changed: 21 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,27 @@ weight: 600
5
5
docs: "DOCS-1411"
6
6
---
7
7
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.
0 commit comments