380 lines
18 KiB
HTML
380 lines
18 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="ayu sidebar-visible" dir="ltr">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Platform Installer - 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/installer.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-platform-installer"><a class="header" href="#provisioning-platform-installer">Provisioning Platform Installer</a></h1>
|
||
|
|
<p>Interactive Ratatui-based installer for the Provisioning Platform with Nushell fallback for automation.</p>
|
||
|
|
<blockquote>
|
||
|
|
<p><strong>Source</strong>: <code>provisioning/platform/installer/</code>
|
||
|
|
<strong>Status</strong>: COMPLETE - All 7 UI screens implemented (1,480 lines)</p>
|
||
|
|
</blockquote>
|
||
|
|
<h2 id="features"><a class="header" href="#features">Features</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Rich Interactive TUI</strong>: Beautiful Ratatui interface with real-time feedback</li>
|
||
|
|
<li><strong>Headless Mode</strong>: Automation-friendly with Nushell scripts</li>
|
||
|
|
<li><strong>One-Click Deploy</strong>: Single command to deploy entire platform</li>
|
||
|
|
<li><strong>Platform Agnostic</strong>: Supports Docker, Podman, Kubernetes, OrbStack</li>
|
||
|
|
<li><strong>Live Progress</strong>: Real-time deployment progress and logs</li>
|
||
|
|
<li><strong>Health Checks</strong>: Automatic service health verification</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="installation"><a class="header" href="#installation">Installation</a></h2>
|
||
|
|
<pre><code class="language-bash">cd provisioning/platform/installer
|
||
|
|
cargo build --release
|
||
|
|
cargo install --path .
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="usage"><a class="header" href="#usage">Usage</a></h2>
|
||
|
|
<h3 id="interactive-tui-default"><a class="header" href="#interactive-tui-default">Interactive TUI (Default)</a></h3>
|
||
|
|
<pre><code class="language-bash">provisioning-installer
|
||
|
|
</code></pre>
|
||
|
|
<p>The TUI guides you through:</p>
|
||
|
|
<ol>
|
||
|
|
<li>Platform detection (Docker, Podman, K8s, OrbStack)</li>
|
||
|
|
<li>Deployment mode selection (Solo, Multi-User, CI/CD, Enterprise)</li>
|
||
|
|
<li>Service selection (check/uncheck services)</li>
|
||
|
|
<li>Configuration (domain, ports, secrets)</li>
|
||
|
|
<li>Live deployment with progress tracking</li>
|
||
|
|
<li>Success screen with access URLs</li>
|
||
|
|
</ol>
|
||
|
|
<h3 id="headless-mode-automation"><a class="header" href="#headless-mode-automation">Headless Mode (Automation)</a></h3>
|
||
|
|
<pre><code class="language-bash"># Quick deploy with auto-detection
|
||
|
|
provisioning-installer --headless --mode solo --yes
|
||
|
|
|
||
|
|
# Fully specified
|
||
|
|
provisioning-installer \
|
||
|
|
--headless \
|
||
|
|
--platform orbstack \
|
||
|
|
--mode solo \
|
||
|
|
--services orchestrator,control-center,coredns \
|
||
|
|
--domain localhost \
|
||
|
|
--yes
|
||
|
|
|
||
|
|
# Use existing config file
|
||
|
|
provisioning-installer --headless --config my-deployment.toml --yes
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="configuration-generation"><a class="header" href="#configuration-generation">Configuration Generation</a></h3>
|
||
|
|
<pre><code class="language-bash"># Generate config without deploying
|
||
|
|
provisioning-installer --config-only
|
||
|
|
|
||
|
|
# Deploy later with generated config
|
||
|
|
provisioning-installer --headless --config ~/.provisioning/installer-config.toml --yes
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="deployment-platforms"><a class="header" href="#deployment-platforms">Deployment Platforms</a></h2>
|
||
|
|
<h3 id="docker-compose"><a class="header" href="#docker-compose">Docker Compose</a></h3>
|
||
|
|
<pre><code class="language-bash">provisioning-installer --platform docker --mode solo
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Requirements</strong>: Docker 20.10+, docker-compose 2.0+</p>
|
||
|
|
<h3 id="orbstack-macos"><a class="header" href="#orbstack-macos">OrbStack (macOS)</a></h3>
|
||
|
|
<pre><code class="language-bash">provisioning-installer --platform orbstack --mode solo
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Requirements</strong>: OrbStack installed, 4GB RAM, 2 CPU cores</p>
|
||
|
|
<h3 id="podman-rootless"><a class="header" href="#podman-rootless">Podman (Rootless)</a></h3>
|
||
|
|
<pre><code class="language-bash">provisioning-installer --platform podman --mode solo
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Requirements</strong>: Podman 4.0+, systemd</p>
|
||
|
|
<h3 id="kubernetes"><a class="header" href="#kubernetes">Kubernetes</a></h3>
|
||
|
|
<pre><code class="language-bash">provisioning-installer --platform kubernetes --mode enterprise
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Requirements</strong>: kubectl configured, Helm 3.0+</p>
|
||
|
|
<h2 id="deployment-modes"><a class="header" href="#deployment-modes">Deployment Modes</a></h2>
|
||
|
|
<h3 id="solo-mode-development"><a class="header" href="#solo-mode-development">Solo Mode (Development)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Services</strong>: 5 core services</li>
|
||
|
|
<li><strong>Resources</strong>: 2 CPU cores, 4GB RAM, 20GB disk</li>
|
||
|
|
<li><strong>Use case</strong>: Single developer, local testing</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="multi-user-mode-team"><a class="header" href="#multi-user-mode-team">Multi-User Mode (Team)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Services</strong>: 7 services</li>
|
||
|
|
<li><strong>Resources</strong>: 4 CPU cores, 8GB RAM, 50GB disk</li>
|
||
|
|
<li><strong>Use case</strong>: Team collaboration, shared infrastructure</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="cicd-mode-automation"><a class="header" href="#cicd-mode-automation">CI/CD Mode (Automation)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Services</strong>: 8-10 services</li>
|
||
|
|
<li><strong>Resources</strong>: 8 CPU cores, 16GB RAM, 100GB disk</li>
|
||
|
|
<li><strong>Use case</strong>: Automated pipelines, webhooks</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="enterprise-mode-production"><a class="header" href="#enterprise-mode-production">Enterprise Mode (Production)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Services</strong>: 15+ services</li>
|
||
|
|
<li><strong>Resources</strong>: 16 CPU cores, 32GB RAM, 500GB disk</li>
|
||
|
|
<li><strong>Use case</strong>: Production deployments, full observability</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="cli-options"><a class="header" href="#cli-options">CLI Options</a></h2>
|
||
|
|
<pre><code>provisioning-installer [OPTIONS]
|
||
|
|
|
||
|
|
OPTIONS:
|
||
|
|
--headless Run in headless mode (no TUI)
|
||
|
|
--mode <MODE> Deployment mode [solo|multi-user|cicd|enterprise]
|
||
|
|
--platform <PLATFORM> Target platform [docker|podman|kubernetes|orbstack]
|
||
|
|
--services <SERVICES> Comma-separated list of services
|
||
|
|
--domain <DOMAIN> Domain/hostname (default: localhost)
|
||
|
|
--yes, -y Skip confirmation prompts
|
||
|
|
--config-only Generate config without deploying
|
||
|
|
--config <FILE> Use existing config file
|
||
|
|
-h, --help Print help
|
||
|
|
-V, --version Print version
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="cicd-integration"><a class="header" href="#cicd-integration">CI/CD Integration</a></h2>
|
||
|
|
<h3 id="gitlab-ci"><a class="header" href="#gitlab-ci">GitLab CI</a></h3>
|
||
|
|
<pre><code class="language-yaml">deploy_platform:
|
||
|
|
stage: deploy
|
||
|
|
script:
|
||
|
|
- provisioning-installer --headless --mode cicd --platform kubernetes --yes
|
||
|
|
only:
|
||
|
|
- main
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="github-actions"><a class="header" href="#github-actions">GitHub Actions</a></h3>
|
||
|
|
<pre><code class="language-yaml">- name: Deploy Provisioning Platform
|
||
|
|
run: |
|
||
|
|
provisioning-installer --headless --mode cicd --platform docker --yes
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="nushell-scripts-fallback"><a class="header" href="#nushell-scripts-fallback">Nushell Scripts (Fallback)</a></h2>
|
||
|
|
<p>If the Rust binary is unavailable:</p>
|
||
|
|
<pre><code class="language-bash">cd provisioning/platform/installer/scripts
|
||
|
|
nu deploy.nu --mode solo --platform orbstack --yes
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="related-documentation"><a class="header" href="#related-documentation">Related Documentation</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Deployment Guide</strong>: <a href="../guides/from-scratch.html">Platform Deployment</a></li>
|
||
|
|
<li><strong>Architecture</strong>: <a href="../architecture/ARCHITECTURE_OVERVIEW.html">Platform Overview</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../platform/oci-registry.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/provisioning-server.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/oci-registry.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/provisioning-server.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>
|