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.
384 lines
17 KiB
HTML
384 lines
17 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="ayu sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Provider 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/provider-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="provider-api-reference"><a class="header" href="#provider-api-reference">Provider API Reference</a></h1>
|
|
<p>API documentation for creating and using infrastructure providers.</p>
|
|
<h2 id="overview"><a class="header" href="#overview">Overview</a></h2>
|
|
<p>Providers handle cloud-specific operations and resource provisioning. The provisioning platform supports multiple cloud providers through a unified API.</p>
|
|
<h2 id="supported-providers"><a class="header" href="#supported-providers">Supported Providers</a></h2>
|
|
<ul>
|
|
<li><strong>UpCloud</strong> - European cloud provider</li>
|
|
<li><strong>AWS</strong> - Amazon Web Services</li>
|
|
<li><strong>Local</strong> - Local development environment</li>
|
|
</ul>
|
|
<h2 id="provider-interface"><a class="header" href="#provider-interface">Provider Interface</a></h2>
|
|
<p>All providers must implement the following interface:</p>
|
|
<h3 id="required-functions"><a class="header" href="#required-functions">Required Functions</a></h3>
|
|
<pre><code class="language-nushell"># Provider initialization
|
|
export def init [] -> record { ... }
|
|
|
|
# Server operations
|
|
export def create-servers [plan: record] -> list { ... }
|
|
export def delete-servers [ids: list] -> bool { ... }
|
|
export def list-servers [] -> table { ... }
|
|
|
|
# Resource information
|
|
export def get-server-plans [] -> table { ... }
|
|
export def get-regions [] -> list { ... }
|
|
export def get-pricing [plan: string] -> record { ... }
|
|
</code></pre>
|
|
<h3 id="provider-configuration"><a class="header" href="#provider-configuration">Provider Configuration</a></h3>
|
|
<p>Each provider requires configuration in KCL format:</p>
|
|
<pre><code class="language-kcl"># Example: UpCloud provider configuration
|
|
provider: Provider = {
|
|
name = "upcloud"
|
|
type = "cloud"
|
|
enabled = True
|
|
|
|
config = {
|
|
username = "{{ env.UPCLOUD_USERNAME }}"
|
|
password = "{{ env.UPCLOUD_PASSWORD }}"
|
|
default_zone = "de-fra1"
|
|
}
|
|
}
|
|
</code></pre>
|
|
<h2 id="creating-a-custom-provider"><a class="header" href="#creating-a-custom-provider">Creating a Custom Provider</a></h2>
|
|
<h3 id="1-directory-structure"><a class="header" href="#1-directory-structure">1. Directory Structure</a></h3>
|
|
<pre><code>provisioning/extensions/providers/my-provider/
|
|
├── nu/
|
|
│ └── my_provider.nu # Provider implementation
|
|
├── kcl/
|
|
│ ├── my_provider.k # KCL schema
|
|
│ └── defaults_my_provider.k # Default configuration
|
|
└── README.md # Provider documentation
|
|
</code></pre>
|
|
<h3 id="2-implementation-template"><a class="header" href="#2-implementation-template">2. Implementation Template</a></h3>
|
|
<pre><code class="language-nushell"># my_provider.nu
|
|
export def init [] {
|
|
{
|
|
name: "my-provider"
|
|
type: "cloud"
|
|
ready: true
|
|
}
|
|
}
|
|
|
|
export def create-servers [plan: record] {
|
|
# Implementation here
|
|
[]
|
|
}
|
|
|
|
export def list-servers [] {
|
|
# Implementation here
|
|
[]
|
|
}
|
|
|
|
# ... other required functions
|
|
</code></pre>
|
|
<h3 id="3-kcl-schema"><a class="header" href="#3-kcl-schema">3. KCL Schema</a></h3>
|
|
<pre><code class="language-kcl"># my_provider.k
|
|
import provisioning.lib as lib
|
|
|
|
schema MyProvider(lib.Provider):
|
|
"""My custom provider schema"""
|
|
|
|
name: str = "my-provider"
|
|
type: "cloud" | "local" = "cloud"
|
|
|
|
config: MyProviderConfig
|
|
|
|
schema MyProviderConfig:
|
|
api_key: str
|
|
region: str = "us-east-1"
|
|
</code></pre>
|
|
<h2 id="provider-discovery"><a class="header" href="#provider-discovery">Provider Discovery</a></h2>
|
|
<p>Providers are automatically discovered from:</p>
|
|
<ul>
|
|
<li><code>provisioning/extensions/providers/*/nu/*.nu</code></li>
|
|
<li>User workspace: <code>workspace/extensions/providers/*/nu/*.nu</code></li>
|
|
</ul>
|
|
<pre><code class="language-bash"># Discover available providers
|
|
provisioning module discover providers
|
|
|
|
# Load provider
|
|
provisioning module load providers workspace my-provider
|
|
</code></pre>
|
|
<h2 id="provider-api-examples"><a class="header" href="#provider-api-examples">Provider API Examples</a></h2>
|
|
<h3 id="create-servers"><a class="header" href="#create-servers">Create Servers</a></h3>
|
|
<pre><code class="language-nushell">use my_provider.nu *
|
|
|
|
let plan = {
|
|
count: 3
|
|
size: "medium"
|
|
zone: "us-east-1"
|
|
}
|
|
|
|
create-servers $plan
|
|
</code></pre>
|
|
<h3 id="list-servers"><a class="header" href="#list-servers">List Servers</a></h3>
|
|
<pre><code class="language-nushell">list-servers | where status == "running" | select hostname ip_address
|
|
</code></pre>
|
|
<h3 id="get-pricing"><a class="header" href="#get-pricing">Get Pricing</a></h3>
|
|
<pre><code class="language-nushell">get-pricing "small" | to yaml
|
|
</code></pre>
|
|
<h2 id="testing-providers"><a class="header" href="#testing-providers">Testing Providers</a></h2>
|
|
<p>Use the test environment system to test providers:</p>
|
|
<pre><code class="language-bash"># Test provider without real resources
|
|
provisioning test env single my-provider --check
|
|
</code></pre>
|
|
<h2 id="provider-development-guide"><a class="header" href="#provider-development-guide">Provider Development Guide</a></h2>
|
|
<p>For complete provider development guide, see:</p>
|
|
<ul>
|
|
<li><strong><a href="../development/QUICK_PROVIDER_GUIDE.html">Provider Development</a></strong> - Quick start guide</li>
|
|
<li><strong><a href="../development/extensions.html">Extension Development</a></strong> - Complete extension guide</li>
|
|
<li><strong><a href="integration-examples.html">Integration Examples</a></strong> - Example implementations</li>
|
|
</ul>
|
|
<h2 id="api-stability"><a class="header" href="#api-stability">API Stability</a></h2>
|
|
<p>Provider API follows semantic versioning:</p>
|
|
<ul>
|
|
<li><strong>Major</strong>: Breaking changes</li>
|
|
<li><strong>Minor</strong>: New features, backward compatible</li>
|
|
<li><strong>Patch</strong>: Bug fixes</li>
|
|
</ul>
|
|
<p>Current API version: <code>2.0.0</code></p>
|
|
<hr />
|
|
<p>For more 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/nushell-api.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/extensions.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/nushell-api.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/extensions.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>
|