provisioning/docs/book/platform/provisioning-server.html

425 lines
20 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
<html lang="en" class="ayu sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Provisioning API Server - 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/provisioning-server.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-api-server"><a class="header" href="#provisioning-api-server">Provisioning API Server</a></h1>
<p>A comprehensive REST API server for remote provisioning operations, enabling thin clients and CI/CD pipeline integration.</p>
<blockquote>
<p><strong>Source</strong>: <code>provisioning/platform/provisioning-server/</code></p>
</blockquote>
<h2 id="features"><a class="header" href="#features">Features</a></h2>
<ul>
<li><strong>Comprehensive REST API</strong>: Complete provisioning operations via HTTP</li>
<li><strong>JWT Authentication</strong>: Secure token-based authentication</li>
<li><strong>RBAC System</strong>: Role-based access control (Admin, Operator, Developer, Viewer)</li>
<li><strong>Async Operations</strong>: Long-running tasks with status tracking</li>
<li><strong>Nushell Integration</strong>: Direct execution of provisioning CLI commands</li>
<li><strong>Audit Logging</strong>: Complete operation tracking for compliance</li>
<li><strong>Metrics</strong>: Prometheus-compatible metrics endpoint</li>
<li><strong>CORS Support</strong>: Configurable cross-origin resource sharing</li>
<li><strong>Health Checks</strong>: Built-in health and readiness endpoints</li>
</ul>
<h2 id="architecture"><a class="header" href="#architecture">Architecture</a></h2>
<pre><code>┌─────────────────┐
│ REST Client │
│ (curl, CI/CD) │
└────────┬────────┘
│ HTTPS/JWT
┌─────────────────┐
│ API Gateway │
│ - Routes │
│ - Auth │
│ - RBAC │
└────────┬────────┘
┌─────────────────┐
│ Async Task Mgr │
│ - Queue │
│ - Status │
└────────┬────────┘
┌─────────────────┐
│ Nushell Exec │
│ - CLI wrapper │
│ - Timeout │
└─────────────────┘
</code></pre>
<h2 id="installation"><a class="header" href="#installation">Installation</a></h2>
<pre><code class="language-bash">cd provisioning/platform/provisioning-server
cargo build --release
</code></pre>
<h2 id="configuration"><a class="header" href="#configuration">Configuration</a></h2>
<p>Create <code>config.toml</code>:</p>
<pre><code class="language-toml">[server]
host = "0.0.0.0"
port = 8083
cors_enabled = true
[auth]
jwt_secret = "your-secret-key-here"
token_expiry_hours = 24
refresh_token_expiry_hours = 168
[provisioning]
cli_path = "/usr/local/bin/provisioning"
timeout_seconds = 300
max_concurrent_operations = 10
[logging]
level = "info"
json_format = false
</code></pre>
<h2 id="usage"><a class="header" href="#usage">Usage</a></h2>
<h3 id="starting-the-server"><a class="header" href="#starting-the-server">Starting the Server</a></h3>
<pre><code class="language-bash"># Using config file
provisioning-server --config config.toml
# Custom settings
provisioning-server \
--host 0.0.0.0 \
--port 8083 \
--jwt-secret "my-secret" \
--cli-path "/usr/local/bin/provisioning" \
--log-level debug
</code></pre>
<h3 id="authentication"><a class="header" href="#authentication">Authentication</a></h3>
<h4 id="login"><a class="header" href="#login">Login</a></h4>
<pre><code class="language-bash">curl -X POST http://localhost:8083/v1/auth/login \
-H "Content-Type: application/json" \
-d '{
"username": "admin",
"password": "admin123"
}'
</code></pre>
<p>Response:</p>
<pre><code class="language-json">{
"token": "eyJhbGc...",
"refresh_token": "eyJhbGc...",
"expires_in": 86400
}
</code></pre>
<h4 id="using-token"><a class="header" href="#using-token">Using Token</a></h4>
<pre><code class="language-bash">export TOKEN="eyJhbGc..."
curl -X GET http://localhost:8083/v1/servers \
-H "Authorization: Bearer $TOKEN"
</code></pre>
<h2 id="api-endpoints"><a class="header" href="#api-endpoints">API Endpoints</a></h2>
<h3 id="authentication-1"><a class="header" href="#authentication-1">Authentication</a></h3>
<ul>
<li><code>POST /v1/auth/login</code> - User login</li>
<li><code>POST /v1/auth/refresh</code> - Refresh access token</li>
</ul>
<h3 id="servers"><a class="header" href="#servers">Servers</a></h3>
<ul>
<li><code>GET /v1/servers</code> - List all servers</li>
<li><code>POST /v1/servers/create</code> - Create new server</li>
<li><code>DELETE /v1/servers/{id}</code> - Delete server</li>
<li><code>GET /v1/servers/{id}/status</code> - Get server status</li>
</ul>
<h3 id="taskservs"><a class="header" href="#taskservs">Taskservs</a></h3>
<ul>
<li><code>GET /v1/taskservs</code> - List all taskservs</li>
<li><code>POST /v1/taskservs/create</code> - Create taskserv</li>
<li><code>DELETE /v1/taskservs/{id}</code> - Delete taskserv</li>
<li><code>GET /v1/taskservs/{id}/status</code> - Get taskserv status</li>
</ul>
<h3 id="workflows"><a class="header" href="#workflows">Workflows</a></h3>
<ul>
<li><code>POST /v1/workflows/submit</code> - Submit workflow</li>
<li><code>GET /v1/workflows/{id}</code> - Get workflow details</li>
<li><code>GET /v1/workflows/{id}/status</code> - Get workflow status</li>
<li><code>POST /v1/workflows/{id}/cancel</code> - Cancel workflow</li>
</ul>
<h3 id="operations"><a class="header" href="#operations">Operations</a></h3>
<ul>
<li><code>GET /v1/operations</code> - List all operations</li>
<li><code>GET /v1/operations/{id}</code> - Get operation status</li>
<li><code>POST /v1/operations/{id}/cancel</code> - Cancel operation</li>
</ul>
<h3 id="system"><a class="header" href="#system">System</a></h3>
<ul>
<li><code>GET /health</code> - Health check (no auth required)</li>
<li><code>GET /v1/version</code> - Version information</li>
<li><code>GET /v1/metrics</code> - Prometheus metrics</li>
</ul>
<h2 id="rbac-roles"><a class="header" href="#rbac-roles">RBAC Roles</a></h2>
<h3 id="admin-role"><a class="header" href="#admin-role">Admin Role</a></h3>
<p>Full system access including all operations, workspace management, and system administration.</p>
<h3 id="operator-role"><a class="header" href="#operator-role">Operator Role</a></h3>
<p>Infrastructure operations including create/delete servers, taskservs, clusters, and workflow management.</p>
<h3 id="developer-role"><a class="header" href="#developer-role">Developer Role</a></h3>
<p>Read access plus SSH to servers, view workflows and operations.</p>
<h3 id="viewer-role"><a class="header" href="#viewer-role">Viewer Role</a></h3>
<p>Read-only access to all resources and status information.</p>
<h2 id="security-best-practices"><a class="header" href="#security-best-practices">Security Best Practices</a></h2>
<ol>
<li><strong>Change Default Credentials</strong>: Update all default usernames/passwords</li>
<li><strong>Use Strong JWT Secret</strong>: Generate secure random string (32+ characters)</li>
<li><strong>Enable TLS</strong>: Use HTTPS in production</li>
<li><strong>Restrict CORS</strong>: Configure specific allowed origins</li>
<li><strong>Enable mTLS</strong>: For client certificate authentication</li>
<li><strong>Regular Token Rotation</strong>: Implement token refresh strategy</li>
<li><strong>Audit Logging</strong>: Enable audit logs for compliance</li>
</ol>
<h2 id="cicd-integration"><a class="header" href="#cicd-integration">CI/CD Integration</a></h2>
<h3 id="github-actions"><a class="header" href="#github-actions">GitHub Actions</a></h3>
<pre><code class="language-yaml">- name: Deploy Infrastructure
run: |
TOKEN=$(curl -X POST https://api.example.com/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"username":"${{ secrets.API_USER }}","password":"${{ secrets.API_PASS }}"}' \
| jq -r '.token')
curl -X POST https://api.example.com/v1/servers/create \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"workspace": "production", "provider": "upcloud", "plan": "2xCPU-4GB"}'
</code></pre>
<h2 id="related-documentation"><a class="header" href="#related-documentation">Related Documentation</a></h2>
<ul>
<li><strong>API Reference</strong>: <a href="../api/rest-api.html">REST API Documentation</a></li>
<li><strong>Architecture</strong>: <a href="../architecture/integration-patterns.html">API Gateway Integration</a></li>
</ul>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../platform/installer.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/index.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/installer.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/index.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>