From 1eeafe5565f353f435be7e432f1cad60184b534b Mon Sep 17 00:00:00 2001 From: Madhu Rajagopal Date: Sat, 23 Nov 2024 06:58:48 +1300 Subject: [PATCH] Docs: Update support referencing support package tool (#2789) Troubleshooting in Kubernetes requires collecting data from various sources of the kubernetes API. The nginx-supportpkg-for-k8s is such a tool that NGINX has created to make this data collection as easy as possible. This PR updates the support page of NGF docs referencing this tool in a similar manner to what was added to NIC docs --- site/content/support.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) 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:**