Skip to content
Merged
Changes from 9 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
734adc6
Docs: Added Support page
mrajagopal Sep 20, 2024
83528ff
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 20, 2024
ac39819
Merge branch 'main' into mrajagopal-supportpkg-docs
mrajagopal Sep 22, 2024
d4a168f
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 22, 2024
05a460b
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 22, 2024
8f1f29d
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 22, 2024
1181fa7
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 22, 2024
2bf923f
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 22, 2024
079db48
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 22, 2024
d25249c
Merge branch 'main' into mrajagopal-supportpkg-docs
ADubhlaoich Sep 23, 2024
1c72489
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
3848e99
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
65515f7
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
2bedfeb
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
881c48f
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
22cea53
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
576e574
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
d72cb7b
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
55cb550
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
edb3764
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
93d66eb
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
7a609ac
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal Sep 23, 2024
f798658
docs: Adopt various review suggestions
mrajagopal Sep 23, 2024
55f43d2
Merge branch 'main' into mrajagopal-supportpkg-docs
mrajagopal Sep 23, 2024
f303165
Merge branch 'main' into mrajagopal-supportpkg-docs
ADubhlaoich Sep 24, 2024
e845477
Merge branch 'main' into mrajagopal-supportpkg-docs
ADubhlaoich Sep 24, 2024
a6101b4
fix: set appropriate weights to sub pages of the troubleshoot section
mrajagopal Sep 24, 2024
dea59d3
Merge branch 'main' into mrajagopal-supportpkg-docs
mrajagopal Sep 24, 2024
04b3358
Merge branch 'main' into mrajagopal-supportpkg-docs
ADubhlaoich Sep 25, 2024
68b024d
fix: set appropriate weights to sub pages of the troubleshoot section
mrajagopal Sep 25, 2024
a03b905
Merge branch 'main' into mrajagopal-supportpkg-docs
mrajagopal Sep 25, 2024
9b61529
Merge branch 'main' into mrajagopal-supportpkg-docs
jjngx Sep 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/content/troubleshooting/troubleshoot-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
docs: DOCS-1648
doctypes:
- troubleshooting
draft: false
tags:
- docs
title: Support
toc: true
weight: 100
---

F5 NGINX Ingress Controller adheres to the support policy detailed in the following knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156).

In order to open a support ticket, F5 would like 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 leverages [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:

* k8s version, nodes information, and CRDs
* Pods' logs
* list of Pods, events, ConfigMaps, Services, Deployments, StatefulSets, ReplicaSets, and Leases
* k8s metrics
* helm Deployments
* `nginx -T` output from NGINX-related pods

This plugin **DOES NOT** collect secrets or coredumps.

Please visit the [project’s GitHub repo](https://github.com/nginxinc/nginx-supportpkg-for-k8s) for further details.

When used, the plugin will generate a tarball of the collected information which can be shared via the support channels.


**Support Channels:**

- If you experience issues with NGINX Ingress Controller, please [open an issue](https://github.com/nginxinc/kubernetes-ingress/issues/new?assignees=&labels=bug%2Cneeds+triage&projects=&template=BUG-REPORT.yml&title=%5BBug%5D%3A+) in GitHub.

- If you have any enhancement requests, please [open a feature request](https://github.com/nginxinc/kubernetes-ingress/issues/new?assignees=&labels=proposal&projects=&template=feature_request.md&title=) in GitHub.

- If you have any ideas or suggestions to discuss, please [open an idea discussion](https://github.com/nginxinc/kubernetes-ingress/discussions/categories/ideas) in Github.

- You can contact us directly, by sending an email to [[email protected]](mailto:[email protected]) or on the [NGINX Community Slack channel of NGINX Ingress Controller](https://nginxcommunity.slack.com/channels/nginx-ingress-controller).