6a59d34bb1
Update configuration files, templates, and internal documentation for the provisioning repository system. Configuration Updates: - KMS configuration modernization - Plugin system settings - Service port mappings - Test cluster topologies - Installation configuration examples - VM configuration defaults - Cedar authorization policies Documentation Updates: - Library module documentation - Extension API guides - AI system documentation - Service management guides - Test environment setup - Plugin usage guides - Validator configuration documentation All changes are backward compatible.
307 lines
16 KiB
HTML
307 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="ayu sidebar-visible" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>Structure Comparison - Provisioning Platform Documentation</title>
|
||
|
||
|
||
<!-- Custom HTML head -->
|
||
|
||
<meta name="description" content="Complete documentation for the Provisioning Platform - Infrastructure automation with Nushell, KCL, and Rust">
|
||
<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 = "ayu";
|
||
const default_dark_theme = "navy";
|
||
</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('ayu')
|
||
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 = sidebar === 'visible';
|
||
html.classList.remove('sidebar-visible');
|
||
html.classList.add("sidebar-" + sidebar);
|
||
</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">Provisioning Platform 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/provisioning/provisioning-platform" title="Git repository" aria-label="Git repository">
|
||
<i id="git-repository-button" class="fa fa-github"></i>
|
||
</a>
|
||
<a href="https://github.com/provisioning/provisioning-platform/edit/main/provisioning/docs/src/STRUCTURE_COMPARISON.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
</a>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="search-wrapper" class="hidden">
|
||
<form id="searchbar-outer" class="searchbar-outer">
|
||
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
</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="structure-comparison-templates-vs-extensions"><a class="header" href="#structure-comparison-templates-vs-extensions">Structure Comparison: Templates vs Extensions</a></h1>
|
||
<h2 id="-templates-structure-provisioningworkspacetemplatestaskservs"><a class="header" href="#-templates-structure-provisioningworkspacetemplatestaskservs">✅ <strong>Templates Structure</strong> (<code>provisioning/workspace/templates/taskservs/</code>)</a></h2>
|
||
<pre><code>taskservs/
|
||
├── container-runtime/
|
||
├── databases/
|
||
├── kubernetes/
|
||
├── networking/
|
||
└── storage/
|
||
</code></pre>
|
||
<h2 id="-extensions-structure-provisioningextensionstaskservs"><a class="header" href="#-extensions-structure-provisioningextensionstaskservs">✅ <strong>Extensions Structure</strong> (<code>provisioning/extensions/taskservs/</code>)</a></h2>
|
||
<pre><code>taskservs/
|
||
├── container-runtime/ (6 taskservs: containerd, crio, crun, podman, runc, youki)
|
||
├── databases/ (2 taskservs: postgres, redis)
|
||
├── development/ (6 taskservs: coder, desktop, gitea, nushell, oras, radicle)
|
||
├── infrastructure/ (6 taskservs: kms, kubectl, os, polkadot, provisioning, webhook)
|
||
├── kubernetes/ (1 taskserv: kubernetes + submodules)
|
||
├── misc/ (1 taskserv: generate)
|
||
├── networking/ (6 taskservs: cilium, coredns, etcd, ip-aliases, proxy, resolv)
|
||
├── storage/ (4 taskservs: external-nfs, mayastor, oci-reg, rook-ceph)
|
||
├── info.md (metadata)
|
||
├── kcl.mod (module definition)
|
||
├── kcl.mod.lock (lock file)
|
||
├── README.md (documentation)
|
||
├── REFERENCE.md (reference)
|
||
└── version.k (version info)
|
||
</code></pre>
|
||
<h2 id="-perfect-match-for-core-categories"><a class="header" href="#-perfect-match-for-core-categories">🎯 <strong>Perfect Match for Core Categories</strong></a></h2>
|
||
<h3 id="-matching-categories-55"><a class="header" href="#-matching-categories-55">✅ <strong>Matching Categories (5/5)</strong></a></h3>
|
||
<ul>
|
||
<li>✅ <code>container-runtime/</code> - MATCHES</li>
|
||
<li>✅ <code>databases/</code> - MATCHES</li>
|
||
<li>✅ <code>kubernetes/</code> - MATCHES</li>
|
||
<li>✅ <code>networking/</code> - MATCHES</li>
|
||
<li>✅ <code>storage/</code> - MATCHES</li>
|
||
</ul>
|
||
<h3 id="-extensions-has-additional-categories-3-extra"><a class="header" href="#-extensions-has-additional-categories-3-extra">📈 <strong>Extensions Has Additional Categories (3 extra)</strong></a></h3>
|
||
<ul>
|
||
<li>➕ <code>development/</code> - Development tools (coder, desktop, gitea, etc.)</li>
|
||
<li>➕ <code>infrastructure/</code> - Infrastructure utilities (kms, kubectl, os, etc.)</li>
|
||
<li>➕ <code>misc/</code> - Miscellaneous (generate)</li>
|
||
</ul>
|
||
<h2 id="-result-perfect-layered-architecture"><a class="header" href="#-result-perfect-layered-architecture">🚀 <strong>Result: Perfect Layered Architecture</strong></a></h2>
|
||
<p>The extensions now have the <strong>same folder structure</strong> as templates, plus additional categories for extended functionality. This creates a perfect layered system where:</p>
|
||
<ol>
|
||
<li><strong>Layer 1 (Core)</strong>: <code>provisioning/extensions/taskservs/{category}/{name}</code></li>
|
||
<li><strong>Layer 2 (Templates)</strong>: <code>provisioning/workspace/templates/taskservs/{category}/{name}</code></li>
|
||
<li><strong>Layer 3 (Infrastructure)</strong>: <code>workspace/infra/{name}/task-servs/{name}.k</code></li>
|
||
</ol>
|
||
<h3 id="benefits-achieved"><a class="header" href="#benefits-achieved"><strong>Benefits Achieved:</strong></a></h3>
|
||
<ul>
|
||
<li>✅ <strong>Consistent Navigation</strong> - Same folder structure</li>
|
||
<li>✅ <strong>Logical Grouping</strong> - Related taskservs together</li>
|
||
<li>✅ <strong>Scalable</strong> - Easy to add new categories</li>
|
||
<li>✅ <strong>Layer Resolution</strong> - Clear precedence order</li>
|
||
<li>✅ <strong>Template System</strong> - Perfect alignment for reuse</li>
|
||
</ul>
|
||
<h2 id="-statistics"><a class="header" href="#-statistics">📊 <strong>Statistics</strong></a></h2>
|
||
<ul>
|
||
<li><strong>Total Taskservs</strong>: 32 (organized into 8 categories)</li>
|
||
<li><strong>Core Categories</strong>: 5 (match templates exactly)</li>
|
||
<li><strong>Extended Categories</strong>: 3 (development, infrastructure, misc)</li>
|
||
<li><strong>Metadata Files</strong>: 6 (kept in root for easy access)</li>
|
||
</ul>
|
||
<p>The reorganization is <strong>complete and successful</strong>! 🎉</p>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="quick-reference/SUDO_PASSWORD_HANDLING.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<i class="fa fa-angle-left"></i>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="TASKSERV_CATEGORIZATION.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<i class="fa fa-angle-right"></i>
|
||
</a>
|
||
|
||
<div style="clear: both"></div>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
|
||
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
<a rel="prev" href="quick-reference/SUDO_PASSWORD_HANDLING.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<i class="fa fa-angle-left"></i>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="TASKSERV_CATEGORIZATION.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<i class="fa fa-angle-right"></i>
|
||
</a>
|
||
</nav>
|
||
|
||
</div>
|
||
|
||
<!-- Livereload script (if served using the cli tool) -->
|
||
<script>
|
||
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
|
||
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
|
||
const socket = new WebSocket(wsAddress);
|
||
socket.onmessage = function (event) {
|
||
if (event.data === "reload") {
|
||
socket.close();
|
||
location.reload();
|
||
}
|
||
};
|
||
|
||
window.onbeforeunload = function() {
|
||
socket.close();
|
||
}
|
||
</script>
|
||
|
||
|
||
|
||
<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>
|