2025-12-11 21:50:42 +00:00
<!DOCTYPE HTML>
2026-01-17 03:58:28 +00:00
< html lang = "en" class = "rust sidebar-visible" dir = "ltr" >
2025-12-11 21:50:42 +00:00
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
2026-01-17 03:58:28 +00:00
< title > Introduction - Provisioning Platform Documentation< / title >
2025-12-11 21:50:42 +00:00
<!-- Custom HTML head -->
2026-01-17 03:58:28 +00:00
< meta name = "description" content = "Enterprise-grade Infrastructure as Code platform - Complete documentation" >
2025-12-11 21:50:42 +00:00
< 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 = "";
2026-01-17 03:58:28 +00:00
const default_light_theme = "rust";
2025-12-11 21:50:42 +00:00
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;
2026-01-17 03:58:28 +00:00
html.classList.remove('rust')
2025-12-11 21:50:42 +00:00
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 >
2026-01-17 03:58:28 +00:00
< a href = "https://github.com/your-org/provisioning" title = "Git repository" aria-label = "Git repository" >
2025-12-11 21:50:42 +00:00
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
2026-01-17 03:58:28 +00:00
< a href = "https://github.com/your-org/provisioning/edit/main/provisioning/docs/src/README.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
2025-12-11 21:50:42 +00:00
< 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 >
< p align = "center" >
2026-01-17 03:58:28 +00:00
< img src = "resources/provisioning_logo.svg" alt = "Provisioning Logo" width = "300" / >
2025-12-11 21:50:42 +00:00
< / p >
< p align = "center" >
2026-01-17 03:58:28 +00:00
< img src = "resources/logo-text.svg" alt = "Provisioning" width = "500" / >
2025-12-11 21:50:42 +00:00
< / p >
< h1 id = "provisioning-platform-documentation" > < a class = "header" href = "#provisioning-platform-documentation" > Provisioning Platform Documentation< / a > < / h1 >
2026-01-17 03:58:28 +00:00
< p > Welcome to the Provisioning Platform documentation. This is an enterprise-grade Infrastructure
as Code (IaC) platform built with Rust, Nushell, and Nickel.< / p >
< h2 id = "what-is-provisioning" > < a class = "header" href = "#what-is-provisioning" > What is Provisioning< / a > < / h2 >
< p > Provisioning is a comprehensive infrastructure automation platform that manages complete
infrastructure lifecycles across multiple cloud providers. The platform emphasizes type-safety,
configuration-driven design, and workspace-first organization.< / p >
< h2 id = "key-features" > < a class = "header" href = "#key-features" > Key Features< / a > < / h2 >
2026-01-12 04:42:18 +00:00
< ul >
2026-01-17 03:58:28 +00:00
< li > < strong > Workspace Management< / strong > : Default mode for organizing infrastructure, settings, schemas, and extensions< / li >
< li > < strong > Type-Safe Configuration< / strong > : Nickel-based configuration system with validation and contracts< / li >
< li > < strong > Multi-Cloud Support< / strong > : Unified interface for AWS, UpCloud, and local providers< / li >
< li > < strong > Modular CLI Architecture< / strong > : 111+ commands with 84% code reduction through modularity< / li >
< li > < strong > Batch Workflow Engine< / strong > : Orchestrate complex multi-cloud operations< / li >
< li > < strong > Complete Security System< / strong > : Authentication, authorization, encryption, and compliance< / li >
< li > < strong > Extensible Architecture< / strong > : Custom providers, task services, and plugins< / li >
2026-01-12 04:42:18 +00:00
< / ul >
2026-01-17 03:58:28 +00:00
< h2 id = "getting-started" > < a class = "header" href = "#getting-started" > Getting Started< / a > < / h2 >
< p > New users should start with:< / p >
2026-01-12 04:42:18 +00:00
< ol >
2026-01-17 03:58:28 +00:00
< li > < a href = "getting-started/prerequisites.html" > Prerequisites< / a > - System requirements and dependencies< / li >
< li > < a href = "getting-started/installation.html" > Installation< / a > - Install the platform< / li >
< li > < a href = "getting-started/quick-start.html" > Quick Start< / a > - 5-minute deployment tutorial< / li >
< li > < a href = "getting-started/first-deployment.html" > First Deployment< / a > - Comprehensive walkthrough< / li >
2026-01-12 04:42:18 +00:00
< / ol >
2026-01-17 03:58:28 +00:00
< h2 id = "documentation-structure" > < a class = "header" href = "#documentation-structure" > Documentation Structure< / a > < / h2 >
2026-01-12 04:42:18 +00:00
< ul >
2026-01-17 03:58:28 +00:00
< li > < strong > Getting Started< / strong > : Installation and initial setup< / li >
< li > < strong > User Guides< / strong > : Workflow tutorials and best practices< / li >
< li > < strong > Infrastructure as Code< / strong > : Nickel configuration and schema reference< / li >
< li > < strong > Platform Features< / strong > : Core capabilities and systems< / li >
< li > < strong > Operations< / strong > : Deployment, monitoring, and maintenance< / li >
< li > < strong > Security< / strong > : Complete security system documentation< / li >
< li > < strong > Development< / strong > : Extension and plugin development< / li >
< li > < strong > API Reference< / strong > : REST API and CLI command reference< / li >
< li > < strong > Architecture< / strong > : System design and ADRs< / li >
< li > < strong > Examples< / strong > : Practical use cases and patterns< / li >
< li > < strong > Troubleshooting< / strong > : Problem-solving guides< / li >
2026-01-12 04:42:18 +00:00
< / ul >
2026-01-17 03:58:28 +00:00
< h2 id = "core-technologies" > < a class = "header" href = "#core-technologies" > Core Technologies< / a > < / h2 >
2026-01-12 04:42:18 +00:00
< ul >
2026-01-17 03:58:28 +00:00
< li > < strong > Rust< / strong > : Platform services and performance-critical components< / li >
< li > < strong > Nushell< / strong > : Scripting, CLI, and automation< / li >
< li > < strong > Nickel< / strong > : Type-safe infrastructure configuration< / li >
< li > < strong > SecretumVault< / strong > : Secrets management integration< / li >
2026-01-12 04:42:18 +00:00
< / ul >
2026-01-17 03:58:28 +00:00
< h2 id = "workspace-first-approach" > < a class = "header" href = "#workspace-first-approach" > Workspace-First Approach< / a > < / h2 >
< p > Provisioning uses workspaces as the default organizational unit. A workspace contains:< / p >
2026-01-12 04:42:18 +00:00
< ul >
2026-01-17 03:58:28 +00:00
< li > Infrastructure definitions (Nickel schemas)< / li >
< li > Environment-specific settings< / li >
< li > Custom extensions and providers< / li >
< li > Deployment state and metadata< / li >
2026-01-12 04:42:18 +00:00
< / ul >
2026-01-17 03:58:28 +00:00
< p > All operations work within workspace context, providing isolation and consistency.< / p >
< h2 id = "support-and-community" > < a class = "header" href = "#support-and-community" > Support and Community< / a > < / h2 >
2026-01-12 04:42:18 +00:00
< ul >
2026-01-17 03:58:28 +00:00
< li > < strong > Issues< / strong > : Report bugs and request features on GitHub< / li >
< li > < strong > Documentation< / strong > : This documentation site< / li >
< li > < strong > Examples< / strong > : See the < a href = "examples/README.html" > Examples< / a > section< / li >
2026-01-12 04:42:18 +00:00
< / ul >
< h2 id = "license" > < a class = "header" href = "#license" > License< / a > < / h2 >
2026-01-17 03:58:28 +00:00
< p > See project LICENSE file for details.< / p >
2025-12-11 21:50:42 +00:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2026-01-17 03:58:28 +00:00
< a rel = "next prefetch" href = "getting-started/index.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2025-12-11 21:50:42 +00:00
< 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" >
2026-01-17 03:58:28 +00:00
< a rel = "next prefetch" href = "getting-started/index.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2025-12-11 21:50:42 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
2026-01-17 03:58:28 +00:00
<!-- 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 >
2025-12-11 21:50:42 +00:00
2026-01-17 03:58:28 +00:00
< script >
window.playground_line_numbers = true;
< / script >
2025-12-11 21:50:42 +00:00
< script >
window.playground_copyable = true;
< / script >
2026-01-17 03:58:28 +00:00
< script src = "ace.js" > < / script >
< script src = "mode-rust.js" > < / script >
< script src = "editor.js" > < / script >
< script src = "theme-dawn.js" > < / script >
< script src = "theme-tomorrow_night.js" > < / script >
2025-12-11 21:50:42 +00:00
< 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 >
