Skip to content

Commit dcc9029

Browse files
committed
Docs: Update support referencing support package tool (nginx#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
1 parent fd3633a commit dcc9029

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

site/content/support.md

+21-1
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)