Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Troubleshooting Guide #551

Closed
ja20222 opened this issue Apr 5, 2023 · 0 comments · Fixed by #2141
Closed

Troubleshooting Guide #551

ja20222 opened this issue Apr 5, 2023 · 0 comments · Fixed by #2141
Assignees
@salonichf5
Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Milestone
v1.4.0

Comments

@ja20222
Copy link

ja20222 commented Apr 5, 2023 •
edited by kate-osborn
Loading

Add a troubleshooting guide

See the NIC troubleshooting guides.

Things to include:

  • Steps on how to find if reload failed
  • Explain issues related to NGINX reloads
  • Explain NGINX high levels of the generated configuration and how trouble shoot it when things don’t work
  • How to check NGF logs for error messages. How to filter on errors. How to enable debug logging.
  • How to check NGINX logs for access logs. How to filter
  • Which metrics to look at for troubleshooting
  • Under general troubleshooting, say that these steps should be taken if the NGF Pod isn't running or ready. Describe what types of problems that general troubleshooting can help with.
  • What to do if there is no status written to resources. Check to see if the referenced resources exist and belong to NGF.
  • Link to Kubernetes troubleshooting guide at bottom of doc. In a Further Reading section.
@ja20222 ja20222 changed the title Documentation: Explain how NGINX reloads, why they can be harmful and how they are mitigated Create a documentation called troubleshoot guide Apr 19, 2023
@ja20222 ja20222 added the documentation Improvements or additions to documentation label Apr 19, 2023
@ja20222 ja20222 added this to the v1.0.0 milestone Apr 19, 2023
@mpstefan mpstefan modified the milestones: v1.0.0, v0.6.0 Jun 5, 2023
@mpstefan mpstefan mentioned this issue Jun 21, 2023
Closed
@mpstefan mpstefan changed the title Create a documentation called troubleshoot guide Troubleshooting Guide Jul 17, 2023
@mpstefan mpstefan modified the milestones: v0.6.0, v1.1.0 Jul 17, 2023
@mpstefan mpstefan mentioned this issue Jul 17, 2023
Closed
@nginxinc nginxinc deleted a comment from lauras21j Aug 1, 2023
@pleshakov pleshakov mentioned this issue Aug 21, 2023
Merged
6 tasks
@kate-osborn kate-osborn added refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week labels Oct 9, 2023
@mpstefan mpstefan modified the milestones: v1.1.0, v1.2.0 Oct 23, 2023
@mpstefan mpstefan modified the milestones: v1.2.0, v1.3.0 Dec 11, 2023
@mpstefan mpstefan modified the milestones: v1.3.0, v2.0.0 Mar 13, 2024
@salonichf5 salonichf5 self-assigned this Jun 11, 2024
@salonichf5 salonichf5 moved this from 🆕 New to 🏗 In Progress in NGINX Gateway Fabric Jun 11, 2024
@salonichf5 salonichf5 moved this from 🏗 In Progress to 👀 In Review in NGINX Gateway Fabric Jun 14, 2024
@salonichf5 salonichf5 mentioned this issue Jun 14, 2024
Merged
6 tasks
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in NGINX Gateway Fabric Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@salonichf5 salonichf5

Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Projects
NGINX Gateway Fabric
Archived in project
Milestone
v1.4.0
Development

Successfully merging a pull request may close this issue.

Update Troubleshooting guide salonichf5/nginx-gateway-fabric
4 participants
@mpstefan @kate-osborn @ja20222 @salonichf5