-
Notifications
You must be signed in to change notification settings - Fork 766
Closed as not planned
Labels
Description
PR DESCRIPTION
markdown
Description
This PR adds a comprehensive troubleshooting guide to help users resolve common issues with Multipass launch, network configuration, mount operations, and performance optimization. The guide addresses multiple pain points reported in open issues.
Related Issues
Fixes aspects of:
- Update ip for running instance #2834 (Network connectivity problems)
- Configfile for multi VM environments #2751 (Launch failures on different platforms)
- Add core 20/22 images and use UEFI images #2698 (Mount and shared folder issues)
- mount failed: cannot connect to the multipass socket Please ensure multipassd is running and 'localhost:50051' is accessible #2619 (Performance optimization needs)
Changes Made
- Created new
docs/troubleshooting.mdwith common issues and solutions - Added link to troubleshooting guide in main documentation index (
docs/index.md) - Organized content by problem categories for easy navigation
- Included platform-specific instructions for Windows, macOS, and Linux
Testing
- Verified markdown formatting renders correctly
- Tested command examples for syntax accuracy
- Ensured all internal links work properly
- Validated platform-specific instructions are accurate
Files Changed
docs/troubleshooting.md(new file)docs/index.md(updated)
FILES TO CREATE/CHANGE
- New File: docs/troubleshooting.md
markdown
Troubleshooting Guide
Common Launch Issues
"No available images" Error
# Refresh the image list
multipass find
# Set alternative image source
multipass set local.driver=qemu
Launch Failures on Specific Platforms
Windows:
Ensure Hyper-V is enabled
Run PowerShell as Administrator
macOS:
Check Virtualization support in System Information
Ensure HyperKit is properly installed
Linux:
Verify KVM support: egrep -c '(vmx|svm)' /proc/cpuinfo
Check user is in kvm group: groups $USER
Network Connectivity Issues
DNS Resolution Problems
bash
# Check DNS configuration inside instance
multipass exec <instance-name> -- cat /etc/resolv.conf
# Restart the instance to refresh network
multipass restart <instance-name>
Port Forwarding Setup
yaml
# In multipassd configuration
network:
forward:
- from: host:8080
to: instance:80
Mount and Shared Folder Issues
Permission Denied Errors
bash
# Mount with proper permissions
multipass mount --uid-map $(id -u):1000 --gid-map $(id -g):1000 /local/path <instance-name>:~/mount_point
Mount Point Not Accessible
Ensure the instance is running
Check if path exists in the instance
Verify mount command syntax
Performance Optimization
Memory and CPU Allocation
bash
# Launch with specific resources
multipass launch --memory 4G --cpus 2
Disk Space Management
bash
# Check disk usage
multipass info <instance-name>
# Clean up unused instances
multipass delete <instance-name>
multipass purge
Getting Help
Gathering Logs
bash
# Collect debug information
multipass logs --latest
multipass info --all
Common Error Messages and Solutions
"Instance not found" → Verify instance name with multipass list
"Already exists" → Use different instance name or delete existing
"Permission denied" → Run with appropriate privileges
text
### **2. Updated File: `docs/index.md`**
Add this line to the documentation section:
```markdown
## Documentation
- [Troubleshooting Guide](troubleshooting.md)
- [Installing Multipass](installing.md)
- [Using Multipass](using.md)Reactions are currently unavailable