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.
320 lines
16 KiB
HTML
320 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>KCL Quick Reference - 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/development/kcl/KCL_QUICK_REFERENCE.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="kcl-import-quick-reference"><a class="header" href="#kcl-import-quick-reference">KCL Import Quick Reference</a></h1>
|
||
<blockquote>
|
||
<p><strong>TL;DR</strong>: Use <code>import provisioning.{submodule}</code> - never re-export schemas!</p>
|
||
</blockquote>
|
||
<hr />
|
||
<h2 id="-quick-start"><a class="header" href="#-quick-start">🎯 Quick Start</a></h2>
|
||
<pre><code class="language-kcl"># ✅ DO THIS
|
||
import provisioning.lib as lib
|
||
import provisioning.settings
|
||
|
||
_storage = lib.Storage { device = "/dev/sda" }
|
||
|
||
# ❌ NOT THIS
|
||
Settings = settings.Settings # Causes ImmutableError!
|
||
</code></pre>
|
||
<hr />
|
||
<h2 id="-submodules-map"><a class="header" href="#-submodules-map">📦 Submodules Map</a></h2>
|
||
<div class="table-wrapper"><table><thead><tr><th>Need</th><th>Import</th></tr></thead><tbody>
|
||
<tr><td><strong>Settings, SecretProvider</strong></td><td><code>import provisioning.settings</code></td></tr>
|
||
<tr><td><strong>Storage, TaskServDef, ClusterDef</strong></td><td><code>import provisioning.lib as lib</code></td></tr>
|
||
<tr><td><strong>ServerDefaults</strong></td><td><code>import provisioning.defaults</code></td></tr>
|
||
<tr><td><strong>Server</strong></td><td><code>import provisioning.server</code></td></tr>
|
||
<tr><td><strong>Cluster</strong></td><td><code>import provisioning.cluster</code></td></tr>
|
||
<tr><td><strong>TaskservDependencies</strong></td><td><code>import provisioning.dependencies as deps</code></td></tr>
|
||
<tr><td><strong>BatchWorkflow, BatchOperation</strong></td><td><code>import provisioning.workflows as wf</code></td></tr>
|
||
<tr><td><strong>BatchScheduler, BatchExecutor</strong></td><td><code>import provisioning.batch</code></td></tr>
|
||
<tr><td><strong>Version, TaskservVersion</strong></td><td><code>import provisioning.version as v</code></td></tr>
|
||
<tr><td><strong>K8s</strong>*</td><td><code>import provisioning.k8s_deploy as k8s</code></td></tr>
|
||
</tbody></table>
|
||
</div>
|
||
<hr />
|
||
<h2 id="-common-patterns"><a class="header" href="#-common-patterns">🔧 Common Patterns</a></h2>
|
||
<h3 id="provider-extension"><a class="header" href="#provider-extension">Provider Extension</a></h3>
|
||
<pre><code class="language-kcl">import provisioning.lib as lib
|
||
import provisioning.defaults
|
||
|
||
schema Storage_aws(lib.Storage):
|
||
voltype: "gp2" | "gp3" = "gp2"
|
||
</code></pre>
|
||
<h3 id="taskserv-extension"><a class="header" href="#taskserv-extension">Taskserv Extension</a></h3>
|
||
<pre><code class="language-kcl">import provisioning.dependencies as schema
|
||
|
||
_deps = schema.TaskservDependencies {
|
||
name = "kubernetes"
|
||
requires = ["containerd"]
|
||
}
|
||
</code></pre>
|
||
<h3 id="cluster-extension"><a class="header" href="#cluster-extension">Cluster Extension</a></h3>
|
||
<pre><code class="language-kcl">import provisioning.cluster as cluster
|
||
import provisioning.lib as lib
|
||
|
||
schema MyCluster(cluster.Cluster):
|
||
taskservs: [lib.TaskServDef]
|
||
</code></pre>
|
||
<hr />
|
||
<h2 id="-anti-patterns"><a class="header" href="#-anti-patterns">⚠️ Anti-Patterns</a></h2>
|
||
<div class="table-wrapper"><table><thead><tr><th>❌ Don’t</th><th>✅ Do Instead</th></tr></thead><tbody>
|
||
<tr><td><code>Settings = settings.Settings</code></td><td><code>import provisioning.settings</code></td></tr>
|
||
<tr><td><code>import provisioning</code> then <code>provisioning.Settings</code></td><td><code>import provisioning.settings</code> then <code>settings.Settings</code></td></tr>
|
||
<tr><td>Import everything</td><td>Import only what you need</td></tr>
|
||
</tbody></table>
|
||
</div>
|
||
<hr />
|
||
<h2 id="-troubleshooting"><a class="header" href="#-troubleshooting">🐛 Troubleshooting</a></h2>
|
||
<p><strong>ImmutableError E1001</strong>
|
||
→ Remove re-exports, use direct imports</p>
|
||
<p><strong>Schema not found</strong>
|
||
→ Check submodule map above</p>
|
||
<p><strong>Circular import</strong>
|
||
→ Extract shared schemas to new module</p>
|
||
<hr />
|
||
<h2 id="-full-documentation"><a class="header" href="#-full-documentation">📚 Full Documentation</a></h2>
|
||
<ul>
|
||
<li><strong>Complete Guide</strong>: <code>docs/architecture/kcl-import-patterns.md</code></li>
|
||
<li><strong>Summary</strong>: <code>KCL_MODULE_ORGANIZATION_SUMMARY.md</code></li>
|
||
<li><strong>Core Module</strong>: <code>provisioning/kcl/main.k</code></li>
|
||
</ul>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="../../development/KCL_MODULE_GUIDE.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="../../development/kcl/KCL_DEPENDENCY_PATTERNS.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="../../development/KCL_MODULE_GUIDE.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="../../development/kcl/KCL_DEPENDENCY_PATTERNS.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>
|