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.
333 lines
16 KiB
HTML
333 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>Nushell API - 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/api/nushell-api.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="nushell-api-reference"><a class="header" href="#nushell-api-reference">Nushell API Reference</a></h1>
|
|
<p>API documentation for Nushell library functions in the provisioning platform.</p>
|
|
<h2 id="overview"><a class="header" href="#overview">Overview</a></h2>
|
|
<p>The provisioning platform provides a comprehensive Nushell library with reusable functions for infrastructure automation.</p>
|
|
<h2 id="core-modules"><a class="header" href="#core-modules">Core Modules</a></h2>
|
|
<h3 id="configuration-module"><a class="header" href="#configuration-module">Configuration Module</a></h3>
|
|
<p><strong>Location</strong>: <code>provisioning/core/nulib/lib_provisioning/config/</code></p>
|
|
<ul>
|
|
<li><code>get-config <key></code> - Retrieve configuration values</li>
|
|
<li><code>validate-config</code> - Validate configuration files</li>
|
|
<li><code>load-config <path></code> - Load configuration from file</li>
|
|
</ul>
|
|
<h3 id="server-module"><a class="header" href="#server-module">Server Module</a></h3>
|
|
<p><strong>Location</strong>: <code>provisioning/core/nulib/lib_provisioning/servers/</code></p>
|
|
<ul>
|
|
<li><code>create-servers <plan></code> - Create server infrastructure</li>
|
|
<li><code>list-servers</code> - List all provisioned servers</li>
|
|
<li><code>delete-servers <ids></code> - Remove servers</li>
|
|
</ul>
|
|
<h3 id="task-service-module"><a class="header" href="#task-service-module">Task Service Module</a></h3>
|
|
<p><strong>Location</strong>: <code>provisioning/core/nulib/lib_provisioning/taskservs/</code></p>
|
|
<ul>
|
|
<li><code>install-taskserv <name></code> - Install infrastructure service</li>
|
|
<li><code>list-taskservs</code> - List installed services</li>
|
|
<li><code>generate-taskserv-config <name></code> - Generate service configuration</li>
|
|
</ul>
|
|
<h3 id="workspace-module"><a class="header" href="#workspace-module">Workspace Module</a></h3>
|
|
<p><strong>Location</strong>: <code>provisioning/core/nulib/lib_provisioning/workspace/</code></p>
|
|
<ul>
|
|
<li><code>init-workspace <name></code> - Initialize new workspace</li>
|
|
<li><code>get-active-workspace</code> - Get current workspace</li>
|
|
<li><code>switch-workspace <name></code> - Switch to different workspace</li>
|
|
</ul>
|
|
<h3 id="provider-module"><a class="header" href="#provider-module">Provider Module</a></h3>
|
|
<p><strong>Location</strong>: <code>provisioning/core/nulib/lib_provisioning/providers/</code></p>
|
|
<ul>
|
|
<li><code>discover-providers</code> - Find available providers</li>
|
|
<li><code>load-provider <name></code> - Load provider module</li>
|
|
<li><code>list-providers</code> - List loaded providers</li>
|
|
</ul>
|
|
<h2 id="diagnostics--utilities"><a class="header" href="#diagnostics--utilities">Diagnostics & Utilities</a></h2>
|
|
<h3 id="diagnostics-module"><a class="header" href="#diagnostics-module">Diagnostics Module</a></h3>
|
|
<p><strong>Location</strong>: <code>provisioning/core/nulib/lib_provisioning/diagnostics/</code></p>
|
|
<ul>
|
|
<li><code>system-status</code> - Check system health (13+ checks)</li>
|
|
<li><code>health-check</code> - Deep validation (7 areas)</li>
|
|
<li><code>next-steps</code> - Get progressive guidance</li>
|
|
<li><code>deployment-phase</code> - Check deployment progress</li>
|
|
</ul>
|
|
<h3 id="hints-module"><a class="header" href="#hints-module">Hints Module</a></h3>
|
|
<p><strong>Location</strong>: <code>provisioning/core/nulib/lib_provisioning/utils/hints.nu</code></p>
|
|
<ul>
|
|
<li><code>show-next-step <context></code> - Display next step suggestion</li>
|
|
<li><code>show-doc-link <topic></code> - Show documentation link</li>
|
|
<li><code>show-example <command></code> - Display command example</li>
|
|
</ul>
|
|
<h2 id="usage-example"><a class="header" href="#usage-example">Usage Example</a></h2>
|
|
<pre><code class="language-nushell"># Load provisioning library
|
|
use provisioning/core/nulib/lib_provisioning *
|
|
|
|
# Check system status
|
|
system-status | table
|
|
|
|
# Create servers
|
|
create-servers --plan "3-node-cluster" --check
|
|
|
|
# Install kubernetes
|
|
install-taskserv kubernetes --check
|
|
|
|
# Get next steps
|
|
next-steps
|
|
</code></pre>
|
|
<h2 id="api-conventions"><a class="header" href="#api-conventions">API Conventions</a></h2>
|
|
<p>All API functions follow these conventions:</p>
|
|
<ul>
|
|
<li><strong>Explicit types</strong>: All parameters have type annotations</li>
|
|
<li><strong>Early returns</strong>: Validate first, fail fast</li>
|
|
<li><strong>Pure functions</strong>: No side effects (mutations marked with <code>!</code>)</li>
|
|
<li><strong>Pipeline-friendly</strong>: Output designed for Nu pipelines</li>
|
|
</ul>
|
|
<h2 id="best-practices"><a class="header" href="#best-practices">Best Practices</a></h2>
|
|
<p>See <a href="../development/NUSHELL_BEST_PRACTICES.html">Nushell Best Practices</a> for coding guidelines.</p>
|
|
<h2 id="source-code"><a class="header" href="#source-code">Source Code</a></h2>
|
|
<p>Browse the complete source code:</p>
|
|
<ul>
|
|
<li><strong>Core library</strong>: <code>provisioning/core/nulib/lib_provisioning/</code></li>
|
|
<li><strong>Module index</strong>: <code>provisioning/core/nulib/lib_provisioning/mod.nu</code></li>
|
|
</ul>
|
|
<hr />
|
|
<p>For integration examples, see <a href="integration-examples.html">Integration Examples</a>.</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../api/websocket.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="../api/provider-api.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="../api/websocket.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="../api/provider-api.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>
|