-
Notifications
You must be signed in to change notification settings - Fork 2k
Added Support page #6467
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Added Support page #6467
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 83528ff
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] ac39819
Merge branch 'main' into mrajagopal-supportpkg-docs
mrajagopal d4a168f
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 05a460b
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 8f1f29d
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 1181fa7
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 2bf923f
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 079db48
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal d25249c
Merge branch 'main' into mrajagopal-supportpkg-docs
ADubhlaoich 1c72489
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 3848e99
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 65515f7
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 2bedfeb
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 881c48f
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 22cea53
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 576e574
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal d72cb7b
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 55cb550
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal edb3764
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 93d66eb
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal 7a609ac
Update docs/content/troubleshooting/troubleshoot-support.md
mrajagopal f798658
docs: Adopt various review suggestions
mrajagopal 55f43d2
Merge branch 'main' into mrajagopal-supportpkg-docs
mrajagopal f303165
Merge branch 'main' into mrajagopal-supportpkg-docs
ADubhlaoich e845477
Merge branch 'main' into mrajagopal-supportpkg-docs
ADubhlaoich a6101b4
fix: set appropriate weights to sub pages of the troubleshoot section
mrajagopal dea59d3
Merge branch 'main' into mrajagopal-supportpkg-docs
mrajagopal 04b3358
Merge branch 'main' into mrajagopal-supportpkg-docs
ADubhlaoich 68b024d
fix: set appropriate weights to sub pages of the troubleshoot section
mrajagopal a03b905
Merge branch 'main' into mrajagopal-supportpkg-docs
mrajagopal 9b61529
Merge branch 'main' into mrajagopal-supportpkg-docs
jjngx File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
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. | ||
mrajagopal marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
The plugin may collect some or all of the following global and namespace-specific information: | ||
|
||
* k8s version, nodes information, and CRDs | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
* Pods' logs | ||
* list of Pods, events, ConfigMaps, Services, Deployments, StatefulSets, ReplicaSets, and Leases | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
* k8s metrics | ||
* helm Deployments | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
* `nginx -T` output from NGINX-related pods | ||
|
||
This plugin **DOES NOT** collect secrets or coredumps. | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Please visit the [project’s GitHub repo](https://github.com/nginxinc/nginx-supportpkg-for-k8s) for further details. | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
When used, the plugin will generate a tarball of the collected information which can be shared via the support channels. | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
|
||
mrajagopal marked this conversation as resolved.
Show resolved
Hide resolved
|
||
**Support Channels:** | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
- 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. | ||
mrajagopal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
- 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). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.