369 lines
19 KiB
HTML
369 lines
19 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="ayu sidebar-visible" dir="ltr">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Orchestrator - 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/platform/orchestrator.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="provisioning-orchestrator"><a class="header" href="#provisioning-orchestrator">Provisioning Orchestrator</a></h1>
|
||
|
|
<p>A Rust-based orchestrator service that coordinates infrastructure provisioning workflows with pluggable storage backends and comprehensive migration tools.</p>
|
||
|
|
<blockquote>
|
||
|
|
<p><strong>Source</strong>: <code>provisioning/platform/orchestrator/</code></p>
|
||
|
|
</blockquote>
|
||
|
|
<h2 id="architecture"><a class="header" href="#architecture">Architecture</a></h2>
|
||
|
|
<p>The orchestrator implements a hybrid multi-storage approach:</p>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Rust Orchestrator</strong>: Handles coordination, queuing, and parallel execution</li>
|
||
|
|
<li><strong>Nushell Scripts</strong>: Execute the actual provisioning logic</li>
|
||
|
|
<li><strong>Pluggable Storage</strong>: Multiple storage backends with seamless migration</li>
|
||
|
|
<li><strong>REST API</strong>: HTTP interface for workflow submission and monitoring</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="key-features"><a class="header" href="#key-features">Key Features</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Multi-Storage Backends</strong>: Filesystem, SurrealDB Embedded, and SurrealDB Server options</li>
|
||
|
|
<li><strong>Task Queue</strong>: Priority-based task scheduling with retry logic</li>
|
||
|
|
<li><strong>Seamless Migration</strong>: Move data between storage backends with zero downtime</li>
|
||
|
|
<li><strong>Feature Flags</strong>: Compile-time backend selection for minimal dependencies</li>
|
||
|
|
<li><strong>Parallel Execution</strong>: Multiple tasks can run concurrently</li>
|
||
|
|
<li><strong>Status Tracking</strong>: Real-time task status and progress monitoring</li>
|
||
|
|
<li><strong>Advanced Features</strong>: Authentication, audit logging, and metrics (SurrealDB)</li>
|
||
|
|
<li><strong>Nushell Integration</strong>: Seamless execution of existing provisioning scripts</li>
|
||
|
|
<li><strong>RESTful API</strong>: HTTP endpoints for workflow management</li>
|
||
|
|
<li><strong>Test Environment Service</strong>: Automated containerized testing for taskservs, servers, and clusters</li>
|
||
|
|
<li><strong>Multi-Node Support</strong>: Test complex topologies including Kubernetes and etcd clusters</li>
|
||
|
|
<li><strong>Docker Integration</strong>: Automated container lifecycle management via Docker API</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="quick-start"><a class="header" href="#quick-start">Quick Start</a></h2>
|
||
|
|
<h3 id="build-and-run"><a class="header" href="#build-and-run">Build and Run</a></h3>
|
||
|
|
<p><strong>Default Build (Filesystem Only)</strong>:</p>
|
||
|
|
<pre><code class="language-bash">cd provisioning/platform/orchestrator
|
||
|
|
cargo build --release
|
||
|
|
cargo run -- --port 8080 --data-dir ./data
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>With SurrealDB Support</strong>:</p>
|
||
|
|
<pre><code class="language-bash">cargo build --release --features surrealdb
|
||
|
|
|
||
|
|
# Run with SurrealDB embedded
|
||
|
|
cargo run --features surrealdb -- --storage-type surrealdb-embedded --data-dir ./data
|
||
|
|
|
||
|
|
# Run with SurrealDB server
|
||
|
|
cargo run --features surrealdb -- --storage-type surrealdb-server \
|
||
|
|
--surrealdb-url ws://localhost:8000 \
|
||
|
|
--surrealdb-username admin --surrealdb-password secret
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="submit-workflow"><a class="header" href="#submit-workflow">Submit Workflow</a></h3>
|
||
|
|
<pre><code class="language-bash">curl -X POST http://localhost:8080/workflows/servers/create \
|
||
|
|
-H "Content-Type: application/json" \
|
||
|
|
-d '{
|
||
|
|
"infra": "production",
|
||
|
|
"settings": "./settings.yaml",
|
||
|
|
"servers": ["web-01", "web-02"],
|
||
|
|
"check_mode": false,
|
||
|
|
"wait": true
|
||
|
|
}'
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="api-endpoints"><a class="header" href="#api-endpoints">API Endpoints</a></h2>
|
||
|
|
<h3 id="core-endpoints"><a class="header" href="#core-endpoints">Core Endpoints</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><code>GET /health</code> - Service health status</li>
|
||
|
|
<li><code>GET /tasks</code> - List all tasks</li>
|
||
|
|
<li><code>GET /tasks/{id}</code> - Get specific task status</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="workflow-endpoints"><a class="header" href="#workflow-endpoints">Workflow Endpoints</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><code>POST /workflows/servers/create</code> - Submit server creation workflow</li>
|
||
|
|
<li><code>POST /workflows/taskserv/create</code> - Submit taskserv creation workflow</li>
|
||
|
|
<li><code>POST /workflows/cluster/create</code> - Submit cluster creation workflow</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="test-environment-endpoints"><a class="header" href="#test-environment-endpoints">Test Environment Endpoints</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><code>POST /test/environments/create</code> - Create test environment</li>
|
||
|
|
<li><code>GET /test/environments</code> - List all test environments</li>
|
||
|
|
<li><code>GET /test/environments/{id}</code> - Get environment details</li>
|
||
|
|
<li><code>POST /test/environments/{id}/run</code> - Run tests in environment</li>
|
||
|
|
<li><code>DELETE /test/environments/{id}</code> - Cleanup test environment</li>
|
||
|
|
<li><code>GET /test/environments/{id}/logs</code> - Get environment logs</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="test-environment-service"><a class="header" href="#test-environment-service">Test Environment Service</a></h2>
|
||
|
|
<p>The orchestrator includes a comprehensive test environment service for automated containerized testing.</p>
|
||
|
|
<h3 id="test-environment-types"><a class="header" href="#test-environment-types">Test Environment Types</a></h3>
|
||
|
|
<h4 id="1-single-taskserv"><a class="header" href="#1-single-taskserv">1. Single Taskserv</a></h4>
|
||
|
|
<p>Test individual taskserv in isolated container.</p>
|
||
|
|
<h4 id="2-server-simulation"><a class="header" href="#2-server-simulation">2. Server Simulation</a></h4>
|
||
|
|
<p>Test complete server configurations with multiple taskservs.</p>
|
||
|
|
<h4 id="3-cluster-topology"><a class="header" href="#3-cluster-topology">3. Cluster Topology</a></h4>
|
||
|
|
<p>Test multi-node cluster configurations (Kubernetes, etcd, etc.).</p>
|
||
|
|
<h3 id="nushell-cli-integration"><a class="header" href="#nushell-cli-integration">Nushell CLI Integration</a></h3>
|
||
|
|
<pre><code class="language-bash"># Quick test
|
||
|
|
provisioning test quick kubernetes
|
||
|
|
|
||
|
|
# Single taskserv test
|
||
|
|
provisioning test env single postgres --auto-start --auto-cleanup
|
||
|
|
|
||
|
|
# Server simulation
|
||
|
|
provisioning test env server web-01 [containerd kubernetes cilium] --auto-start
|
||
|
|
|
||
|
|
# Cluster from template
|
||
|
|
provisioning test topology load kubernetes_3node | test env cluster kubernetes
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="topology-templates"><a class="header" href="#topology-templates">Topology Templates</a></h3>
|
||
|
|
<p>Predefined multi-node cluster topologies:</p>
|
||
|
|
<ul>
|
||
|
|
<li><strong>kubernetes_3node</strong>: 3-node HA Kubernetes cluster</li>
|
||
|
|
<li><strong>kubernetes_single</strong>: All-in-one Kubernetes node</li>
|
||
|
|
<li><strong>etcd_cluster</strong>: 3-member etcd cluster</li>
|
||
|
|
<li><strong>containerd_test</strong>: Standalone containerd testing</li>
|
||
|
|
<li><strong>postgres_redis</strong>: Database stack testing</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="storage-backends"><a class="header" href="#storage-backends">Storage Backends</a></h2>
|
||
|
|
<div class="table-wrapper"><table><thead><tr><th>Feature</th><th>Filesystem</th><th>SurrealDB Embedded</th><th>SurrealDB Server</th></tr></thead><tbody>
|
||
|
|
<tr><td><strong>Dependencies</strong></td><td>None</td><td>Local database</td><td>Remote server</td></tr>
|
||
|
|
<tr><td><strong>Auth/RBAC</strong></td><td>Basic</td><td>Advanced</td><td>Advanced</td></tr>
|
||
|
|
<tr><td><strong>Real-time</strong></td><td>No</td><td>Yes</td><td>Yes</td></tr>
|
||
|
|
<tr><td><strong>Scalability</strong></td><td>Limited</td><td>Medium</td><td>High</td></tr>
|
||
|
|
<tr><td><strong>Complexity</strong></td><td>Low</td><td>Medium</td><td>High</td></tr>
|
||
|
|
<tr><td><strong>Best For</strong></td><td>Development</td><td>Production</td><td>Distributed</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
</div>
|
||
|
|
<h2 id="related-documentation"><a class="header" href="#related-documentation">Related Documentation</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><strong>User Guide</strong>: <a href="../user/test-environment-guide.html">Test Environment Guide</a></li>
|
||
|
|
<li><strong>Architecture</strong>: <a href="../architecture/orchestrator-integration-model.html">Orchestrator Architecture</a></li>
|
||
|
|
<li><strong>Feature Summary</strong>: <a href="../../.claude/features/orchestrator-architecture.html">Orchestrator Features</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../platform/index.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="../platform/control-center.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="../platform/index.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="../platform/control-center.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>
|