Skip to content

Commit

Permalink
Docs: Added Support page (#6467)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrajagopal authored Sep 26, 2024
1 parent 4ee3676 commit 3f47e40
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/content/troubleshooting/troubleshoot-common.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- docs
title: Troubleshooting common issues
toc: true
weight: 100
weight: 200
---

This page describes how to troubleshoot common issues with NGINX Ingress Controller. Instruction for specific resources is available in the [Troubleshooting]({{< relref "troubleshooting/" >}}) section.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ doctypes:
- ''
title: Troubleshooting Policy resources
toc: true
weight: 200
weight: 300
---

This page describes how to troubleshoot NGINX Ingress Controller Policy Resources.
Expand Down
40 changes: 40 additions & 0 deletions docs/content/troubleshooting/troubleshoot-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Commercial support
weight: 100
docs: DOCS-000
---

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).

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.

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


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:

* K8s version, nodes information, and Custom Resources (kubectl describe output)
* Pods' logs
* List of Pods, events, ConfigMaps, Services, Deployments, Daemonsets, StatefulSets, ReplicaSets, and Leases
* K8s metrics
* Helm deployments
* `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

- 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]).
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ doctypes:
- ''
draft: true
title: Troubleshooting TransportServer Resources
weight: 400
weight: 500
---

# Troubleshooting TransportServer Resources
2 changes: 1 addition & 1 deletion docs/content/troubleshooting/troubleshoot-virtualserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ doctypes:
- ''
title: Troubleshooting VirtualServer resources
toc: true
weight: 500
weight: 600
---

This page describes how to troubleshoot VirtualServer and VirtualServer resource events.
Expand Down

0 comments on commit 3f47e40

Please sign in to comment.