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.
361 lines
18 KiB
HTML
361 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>Extension Registry - 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/extension-registry.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="extension-registry-service"><a class="header" href="#extension-registry-service">Extension Registry Service</a></h1>
|
|
<p>A high-performance Rust microservice that provides a unified REST API for extension discovery, versioning, and download from multiple sources.</p>
|
|
<blockquote>
|
|
<p><strong>Source</strong>: <code>provisioning/platform/extension-registry/</code></p>
|
|
</blockquote>
|
|
<h2 id="features"><a class="header" href="#features">Features</a></h2>
|
|
<ul>
|
|
<li><strong>Multi-Backend Support</strong>: Fetch extensions from Gitea releases and OCI registries</li>
|
|
<li><strong>Unified REST API</strong>: Single API for all extension operations</li>
|
|
<li><strong>Smart Caching</strong>: LRU cache with TTL to reduce backend API calls</li>
|
|
<li><strong>Prometheus Metrics</strong>: Built-in metrics for monitoring</li>
|
|
<li><strong>Health Monitoring</strong>: Health checks for all backends</li>
|
|
<li><strong>Type-Safe</strong>: Strong typing for extension metadata</li>
|
|
<li><strong>Async/Await</strong>: High-performance async operations with Tokio</li>
|
|
<li><strong>Docker Support</strong>: Production-ready containerization</li>
|
|
</ul>
|
|
<h2 id="architecture"><a class="header" href="#architecture">Architecture</a></h2>
|
|
<pre><code>┌─────────────────────────────────────────────────────────────┐
|
|
│ Extension Registry API │
|
|
│ (axum) │
|
|
├─────────────────────────────────────────────────────────────┤
|
|
│ ┌────────────────┐ ┌────────────────┐ ┌──────────────┐ │
|
|
│ │ Gitea Client │ │ OCI Client │ │ LRU Cache │ │
|
|
│ │ (reqwest) │ │ (reqwest) │ │ (parking) │ │
|
|
│ └────────────────┘ └────────────────┘ └──────────────┘ │
|
|
└─────────────────────────────────────────────────────────────┘
|
|
</code></pre>
|
|
<h2 id="installation"><a class="header" href="#installation">Installation</a></h2>
|
|
<pre><code class="language-bash">cd provisioning/platform/extension-registry
|
|
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 = 8082
|
|
|
|
# Gitea backend (optional)
|
|
[gitea]
|
|
url = "https://gitea.example.com"
|
|
organization = "provisioning-extensions"
|
|
token_path = "/path/to/gitea-token.txt"
|
|
|
|
# OCI registry backend (optional)
|
|
[oci]
|
|
registry = "registry.example.com"
|
|
namespace = "provisioning"
|
|
auth_token_path = "/path/to/oci-token.txt"
|
|
|
|
# Cache configuration
|
|
[cache]
|
|
capacity = 1000
|
|
ttl_seconds = 300
|
|
</code></pre>
|
|
<h2 id="api-endpoints"><a class="header" href="#api-endpoints">API Endpoints</a></h2>
|
|
<h3 id="extension-operations"><a class="header" href="#extension-operations">Extension Operations</a></h3>
|
|
<h4 id="list-extensions"><a class="header" href="#list-extensions">List Extensions</a></h4>
|
|
<pre><code class="language-bash">GET /api/v1/extensions?type=provider&limit=10
|
|
</code></pre>
|
|
<h4 id="get-extension"><a class="header" href="#get-extension">Get Extension</a></h4>
|
|
<pre><code class="language-bash">GET /api/v1/extensions/{type}/{name}
|
|
</code></pre>
|
|
<h4 id="list-versions"><a class="header" href="#list-versions">List Versions</a></h4>
|
|
<pre><code class="language-bash">GET /api/v1/extensions/{type}/{name}/versions
|
|
</code></pre>
|
|
<h4 id="download-extension"><a class="header" href="#download-extension">Download Extension</a></h4>
|
|
<pre><code class="language-bash">GET /api/v1/extensions/{type}/{name}/{version}
|
|
</code></pre>
|
|
<h4 id="search-extensions"><a class="header" href="#search-extensions">Search Extensions</a></h4>
|
|
<pre><code class="language-bash">GET /api/v1/extensions/search?q=kubernetes&type=taskserv
|
|
</code></pre>
|
|
<h3 id="system-endpoints"><a class="header" href="#system-endpoints">System Endpoints</a></h3>
|
|
<h4 id="health-check"><a class="header" href="#health-check">Health Check</a></h4>
|
|
<pre><code class="language-bash">GET /api/v1/health
|
|
</code></pre>
|
|
<h4 id="metrics"><a class="header" href="#metrics">Metrics</a></h4>
|
|
<pre><code class="language-bash">GET /api/v1/metrics
|
|
</code></pre>
|
|
<h4 id="cache-statistics"><a class="header" href="#cache-statistics">Cache Statistics</a></h4>
|
|
<pre><code class="language-bash">GET /api/v1/cache/stats
|
|
</code></pre>
|
|
<h2 id="extension-naming-conventions"><a class="header" href="#extension-naming-conventions">Extension Naming Conventions</a></h2>
|
|
<h3 id="gitea-repositories"><a class="header" href="#gitea-repositories">Gitea Repositories</a></h3>
|
|
<ul>
|
|
<li><strong>Providers</strong>: <code>{name}_prov</code> (e.g., <code>aws_prov</code>)</li>
|
|
<li><strong>Task Services</strong>: <code>{name}_taskserv</code> (e.g., <code>kubernetes_taskserv</code>)</li>
|
|
<li><strong>Clusters</strong>: <code>{name}_cluster</code> (e.g., <code>buildkit_cluster</code>)</li>
|
|
</ul>
|
|
<h3 id="oci-artifacts"><a class="header" href="#oci-artifacts">OCI Artifacts</a></h3>
|
|
<ul>
|
|
<li><strong>Providers</strong>: <code>{namespace}/{name}-provider</code></li>
|
|
<li><strong>Task Services</strong>: <code>{namespace}/{name}-taskserv</code></li>
|
|
<li><strong>Clusters</strong>: <code>{namespace}/{name}-cluster</code></li>
|
|
</ul>
|
|
<h2 id="deployment"><a class="header" href="#deployment">Deployment</a></h2>
|
|
<h3 id="docker"><a class="header" href="#docker">Docker</a></h3>
|
|
<pre><code class="language-bash">docker build -t extension-registry:latest .
|
|
docker run -d -p 8082:8082 -v $(pwd)/config.toml:/app/config.toml:ro extension-registry:latest
|
|
</code></pre>
|
|
<h3 id="kubernetes"><a class="header" href="#kubernetes">Kubernetes</a></h3>
|
|
<pre><code class="language-yaml">apiVersion: apps/v1
|
|
kind: Deployment
|
|
metadata:
|
|
name: extension-registry
|
|
spec:
|
|
replicas: 3
|
|
template:
|
|
spec:
|
|
containers:
|
|
- name: extension-registry
|
|
image: extension-registry:latest
|
|
ports:
|
|
- containerPort: 8082
|
|
</code></pre>
|
|
<h2 id="related-documentation"><a class="header" href="#related-documentation">Related Documentation</a></h2>
|
|
<ul>
|
|
<li><strong>User Guide</strong>: <a href="../development/extensions.html">Module System</a></li>
|
|
</ul>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../platform/kms-service.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/oci-registry.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/kms-service.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/oci-registry.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>
|