docs: add troubleshooting guide for common urunc issues#591
Closed
mn-ram wants to merge 1 commit intourunc-dev:mainfrom
Closed
docs: add troubleshooting guide for common urunc issues#591mn-ram wants to merge 1 commit intourunc-dev:mainfrom
mn-ram wants to merge 1 commit intourunc-dev:mainfrom
Conversation
Adds docs/developer-guide/troubleshooting.md, a single landing page that collects the recurring failure modes users hit on installation, image packaging, monitor launch, networking (TAP/MTU), and Kubernetes, along with concrete diagnostic commands and fixes. The page complements the existing debugging guide: debugging.md covers the interactive workflow (cntr, syslog) while this one is a problem-first index a user can grep when something is broken.
✅ Deploy Preview for urunc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
docs/developer-guide/troubleshooting.md, a problem-first reference covering installation, image packaging, monitor launch, networking (TAP leak / MTU), and Kubernetes failure modes.debugging.md(interactive workflow) and references the recent fixes for the TAP-device leak and MTU propagation so users know which release to upgrade to.Why
The repo currently has
debugging.md(how to attach to a running container withcntrand read logs) but no problem-first page. New users hitting a brokencontainerdconfiguration, missing/dev/kvmaccess, or stale TAP interfaces had no landing page to grep — they had to dig through issues. This guide consolidates the recurring questions into a single navigable document.Test plan
mkdocs servedeveloper-guide/*.mdliterate-nav globdebugging.md,installation.md,package/index.md,tutorials/How-to-urunc-on-k8s.md) resolve