mirror of
https://github.com/CloudNebulaProject/vm-manager.git
synced 2026-04-10 13:20:41 +00:00
b37beea0f5
Comprehensive docs covering CLI reference, VMFile.kdl format, architecture, library API, tutorials, and advanced topics. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
311 lines
14 KiB
HTML
311 lines
14 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="navy sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Debugging and Logs - vmctl Documentation</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="../favicon.svg">
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|
<link rel="stylesheet" href="../css/general.css">
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
|
|
<!-- Provide site root and default themes to javascript -->
|
|
<script>
|
|
const path_to_root = "../";
|
|
const default_light_theme = "navy";
|
|
const default_dark_theme = "navy";
|
|
window.path_to_searchindex_js = "../searchindex.js";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="../toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="mdbook-help-container">
|
|
<div id="mdbook-help-popup">
|
|
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
|
<div>
|
|
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
|
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
|
<p>Press <kbd>?</kbd> to show this help</p>
|
|
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
let theme = localStorage.getItem('mdbook-theme');
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
|
let theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('navy')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
let sidebar = null;
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
sidebar_toggle.checked = false;
|
|
}
|
|
if (sidebar === 'visible') {
|
|
sidebar_toggle.checked = true;
|
|
} else {
|
|
html.classList.remove('sidebar-visible');
|
|
}
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">vmctl Documentation</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://github.com/toasty/vm-manager" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<div class="search-wrapper">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
<div class="spinner-wrapper">
|
|
<i class="fa fa-spinner fa-spin"></i>
|
|
</div>
|
|
</div>
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="debugging-and-logs"><a class="header" href="#debugging-and-logs">Debugging and Logs</a></h1>
|
|
<h2 id="log-verbosity"><a class="header" href="#log-verbosity">Log Verbosity</a></h2>
|
|
<p>vmctl uses the <code>tracing</code> crate with <code>RUST_LOG</code> environment variable support:</p>
|
|
<pre><code class="language-bash"># Default (info level)
|
|
vmctl up
|
|
|
|
# Debug logging
|
|
RUST_LOG=debug vmctl up
|
|
|
|
# Trace logging (very verbose)
|
|
RUST_LOG=trace vmctl up
|
|
|
|
# Target specific modules
|
|
RUST_LOG=vm_manager::ssh=debug vmctl ssh myvm
|
|
</code></pre>
|
|
<h2 id="vm-logs"><a class="header" href="#vm-logs">VM Logs</a></h2>
|
|
<h3 id="console-log"><a class="header" href="#console-log">Console Log</a></h3>
|
|
<p>The serial console output is captured to <code>console.log</code> in the VM's work directory. This includes boot messages and cloud-init output:</p>
|
|
<pre><code class="language-bash">vmctl log myvm --console
|
|
</code></pre>
|
|
<h3 id="provision-log"><a class="header" href="#provision-log">Provision Log</a></h3>
|
|
<p>Provisioner stdout/stderr is captured to <code>provision.log</code>:</p>
|
|
<pre><code class="language-bash">vmctl log myvm --provision
|
|
</code></pre>
|
|
<h3 id="tail-recent-output"><a class="header" href="#tail-recent-output">Tail Recent Output</a></h3>
|
|
<pre><code class="language-bash">vmctl log myvm --console --tail 50
|
|
</code></pre>
|
|
<h2 id="work-directory"><a class="header" href="#work-directory">Work Directory</a></h2>
|
|
<p>Each VM's files are in <code>~/.local/share/vmctl/vms/<name>/</code>:</p>
|
|
<pre><code class="language-bash">ls ~/.local/share/vmctl/vms/myvm/
|
|
</code></pre>
|
|
<p>Contents:</p>
|
|
<ul>
|
|
<li><code>overlay.qcow2</code> - Disk overlay</li>
|
|
<li><code>seed.iso</code> - Cloud-init ISO</li>
|
|
<li><code>console.log</code> - Serial output</li>
|
|
<li><code>provision.log</code> - Provisioner output</li>
|
|
<li><code>qmp.sock</code> - QMP control socket</li>
|
|
<li><code>console.sock</code> - Console socket</li>
|
|
<li><code>pidfile</code> - QEMU PID</li>
|
|
<li><code>id_ed25519_generated</code> - Auto-generated SSH key</li>
|
|
<li><code>id_ed25519_generated.pub</code> - Public key</li>
|
|
</ul>
|
|
<h2 id="qmp-socket"><a class="header" href="#qmp-socket">QMP Socket</a></h2>
|
|
<p>You can interact with the QEMU Machine Protocol directly for advanced debugging:</p>
|
|
<pre><code class="language-bash"># Using socat
|
|
socat - UNIX-CONNECT:~/.local/share/vmctl/vms/myvm/qmp.sock
|
|
</code></pre>
|
|
<p>After connecting, send <code>{"execute": "qmp_capabilities"}</code> to initialize, then commands like:</p>
|
|
<pre><code class="language-json">{"execute": "query-status"}
|
|
{"execute": "query-vnc"}
|
|
{"execute": "human-monitor-command", "arguments": {"command-line": "info network"}}
|
|
</code></pre>
|
|
<h2 id="common-issues"><a class="header" href="#common-issues">Common Issues</a></h2>
|
|
<h3 id="qemu-spawn-failed"><a class="header" href="#qemu-spawn-failed">"QEMU spawn failed"</a></h3>
|
|
<ul>
|
|
<li>Verify <code>qemu-system-x86_64</code> is in your PATH.</li>
|
|
<li>Check <code>/dev/kvm</code> exists and is accessible.</li>
|
|
<li>Ensure your user is in the <code>kvm</code> group.</li>
|
|
</ul>
|
|
<h3 id="cloud-init-iso-failed"><a class="header" href="#cloud-init-iso-failed">"Cloud-init ISO failed"</a></h3>
|
|
<ul>
|
|
<li>Install <code>genisoimage</code> or <code>mkisofs</code>.</li>
|
|
<li>Or rebuild with <code>--features vm-manager/pure-iso</code>.</li>
|
|
</ul>
|
|
<h3 id="ssh-failed"><a class="header" href="#ssh-failed">"SSH failed"</a></h3>
|
|
<ul>
|
|
<li>Check the console log for cloud-init errors: <code>vmctl log myvm --console</code></li>
|
|
<li>Verify the guest is reachable (check <code>vmctl status myvm</code> for SSH port).</li>
|
|
<li>Ensure sshd is running in the guest.</li>
|
|
<li>Try connecting manually: <code>ssh -p <port> -i <key> user@127.0.0.1</code></li>
|
|
</ul>
|
|
<h3 id="ip-discovery-timeout-tap-networking"><a class="header" href="#ip-discovery-timeout-tap-networking">"IP discovery timeout" (TAP networking)</a></h3>
|
|
<ul>
|
|
<li>Verify the bridge exists and has DHCP.</li>
|
|
<li>Check <code>ip neigh show</code> for the guest's MAC address.</li>
|
|
<li>Ensure the guest has obtained a DHCP lease (check console log).</li>
|
|
</ul>
|
|
<h3 id="vm-stuck-in-stopped-state-but-qemu-still-running"><a class="header" href="#vm-stuck-in-stopped-state-but-qemu-still-running">VM stuck in "Stopped" state but QEMU still running</a></h3>
|
|
<ul>
|
|
<li>Check <code>vmctl status myvm</code> for the PID.</li>
|
|
<li>Verify: <code>kill -0 <pid></code> - if the process is alive, the QMP socket may be stale.</li>
|
|
<li>Destroy and recreate: <code>vmctl destroy myvm</code>.</li>
|
|
</ul>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../advanced/custom-cloud-init.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../advanced/custom-cloud-init.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="../elasticlunr.min.js"></script>
|
|
<script src="../mark.min.js"></script>
|
|
<script src="../searcher.js"></script>
|
|
|
|
<script src="../clipboard.min.js"></script>
|
|
<script src="../highlight.js"></script>
|
|
<script src="../book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|