From 4ad7473dc35bd98fe4392c83b3bbc2fa5b32a9dd Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Mon, 25 Nov 2024 16:52:17 +0000 Subject: [PATCH] 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 Co-authored-by: Saylor Berman Co-authored-by: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com> --- .../how-to/monitoring/troubleshooting.md | 2 +- .../installation/installing-ngf/helm.md | 13 ++++++----- site/content/installation/nginx-plus-jwt.md | 2 ++ site/content/support.md | 22 ++++++++++++++++++- 4 files changed, 32 insertions(+), 7 deletions(-) diff --git a/site/content/how-to/monitoring/troubleshooting.md b/site/content/how-to/monitoring/troubleshooting.md index b5159d73a7..5c8cc89e4c 100644 --- a/site/content/how-to/monitoring/troubleshooting.md +++ b/site/content/how-to/monitoring/troubleshooting.md @@ -469,7 +469,7 @@ If you check your _nginx_ container logs and see the following error: 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: -- Unassign the field [`rewriteClientIP.mode`](({{< relref "reference/api.md" >}})) in the NginxProxy configuration. +- Unassign the field [`rewriteClientIP.mode`]({{< relref "reference/api.md" >}}) in the NginxProxy configuration. - Send valid proxy information with requests being handled by your application. diff --git a/site/content/installation/installing-ngf/helm.md b/site/content/installation/installing-ngf/helm.md index 02cfbf9490..fb82c553d7 100644 --- a/site/content/installation/installing-ngf/helm.md +++ b/site/content/installation/installing-ngf/helm.md @@ -49,6 +49,8 @@ To complete this guide, you'll need to install: ### Install from the OCI registry +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. + {{}} {{%tab name="NGINX"%}} @@ -68,7 +70,7 @@ helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-nam To install the latest stable release of NGINX Gateway Fabric in the **nginx-gateway** namespace, run the following command: ```shell -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 +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 ``` {{% /tab %}} @@ -77,7 +79,7 @@ helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --set nginx `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. -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. +If you want the latest version from the **main** branch, add `--version 0.0.0-edge` to your install command. 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: @@ -87,6 +89,7 @@ kubectl wait --timeout=5m -n nginx-gateway deployment/ngf-nginx-gateway-fabric - ### Install from sources {#install-from-sources} +If you prefer to install directly from sources, instead of through the OCI helm registry, use the following steps. {{}} @@ -109,7 +112,7 @@ helm install ngf . --create-namespace -n nginx-gateway To install the chart into the **nginx-gateway** namespace, run the following command: ```shell -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 +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 ``` {{% /tab %}} @@ -118,8 +121,6 @@ helm install ngf . --set nginx.image.repository=private-registry.nginx.com/nginx `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. - If the namespace already exists, you can omit the optional `--create-namespace` flag. - 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: ```shell @@ -212,6 +213,8 @@ To upgrade the CRDs, take the following steps: {{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.0 need to install an NGINX Plus JWT 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=` when running `helm upgrade`. {{}} +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. + #### Upgrade from the OCI registry - To upgrade to the latest stable release of NGINX Gateway Fabric, run: diff --git a/site/content/installation/nginx-plus-jwt.md b/site/content/installation/nginx-plus-jwt.md index 220fd0ef32..a2f79792a1 100644 --- a/site/content/installation/nginx-plus-jwt.md +++ b/site/content/installation/nginx-plus-jwt.md @@ -83,6 +83,8 @@ and the following volume mount to the `nginx` container: {{}} +**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.** + ### Reporting to NGINX Instance Manager {#nim} 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. diff --git a/site/content/support.md b/site/content/support.md index 5fda3b44b7..061929b2c9 100644 --- a/site/content/support.md +++ b/site/content/support.md @@ -5,7 +5,27 @@ weight: 600 docs: "DOCS-1411" --- -NGINX Gateway Fabric adheres to the support policy detailed in the following knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156). +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). + +After opening a support ticket, F5 staff will request additional information to better understand the problem. + +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. + +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. + +The plugin may collect some or all of the following global and namespace-specific information: + +- Kubernetes version and information about Nodes and Custom Resources +- Kubernetes metrics +- Helm deployments +- List of Pods, Events, ConfigMaps, Services, Deployments, Daemonsets, StatefulSets, ReplicaSets, and Leases +- Pod log output +- `nginx -T` output from NGINX-related Pods + +This plugin **does not** collect secrets or coredumps. + +Visit the [project’s GitHub repository](https://github.com/nginxinc/nginx-supportpkg-for-k8s) for further details. + **Support Channels:**