Skip to content

Commit

Permalink
Docs: Update support referencing support package tool (#2789)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
mrajagopal authored Nov 22, 2024
1 parent 975653a commit 1eeafe5
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion site/content/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down

0 comments on commit 1eeafe5

Please sign in to comment.