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.
367 lines
18 KiB
HTML
367 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>OCI 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/oci-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="oci-registry-service"><a class="header" href="#oci-registry-service">OCI Registry Service</a></h1>
|
|
<p>Comprehensive OCI (Open Container Initiative) registry deployment and management for the provisioning system.</p>
|
|
<blockquote>
|
|
<p><strong>Source</strong>: <code>provisioning/platform/oci-registry/</code></p>
|
|
</blockquote>
|
|
<h2 id="supported-registries"><a class="header" href="#supported-registries">Supported Registries</a></h2>
|
|
<ul>
|
|
<li><strong>Zot</strong> (Recommended for Development): Lightweight, fast, OCI-native with UI</li>
|
|
<li><strong>Harbor</strong> (Recommended for Production): Full-featured enterprise registry</li>
|
|
<li><strong>Distribution</strong> (OCI Reference): Official OCI reference implementation</li>
|
|
</ul>
|
|
<h2 id="features"><a class="header" href="#features">Features</a></h2>
|
|
<ul>
|
|
<li><strong>Multi-Registry Support</strong>: Zot, Harbor, Distribution</li>
|
|
<li><strong>Namespace Organization</strong>: Logical separation of artifacts</li>
|
|
<li><strong>Access Control</strong>: RBAC, policies, authentication</li>
|
|
<li><strong>Monitoring</strong>: Prometheus metrics, health checks</li>
|
|
<li><strong>Garbage Collection</strong>: Automatic cleanup of unused artifacts</li>
|
|
<li><strong>High Availability</strong>: Optional HA configurations</li>
|
|
<li><strong>TLS/SSL</strong>: Secure communication</li>
|
|
<li><strong>UI Interface</strong>: Web-based management (Zot, Harbor)</li>
|
|
</ul>
|
|
<h2 id="quick-start"><a class="header" href="#quick-start">Quick Start</a></h2>
|
|
<h3 id="start-zot-registry-default"><a class="header" href="#start-zot-registry-default">Start Zot Registry (Default)</a></h3>
|
|
<pre><code class="language-bash">cd provisioning/platform/oci-registry/zot
|
|
docker-compose up -d
|
|
|
|
# Initialize with namespaces and policies
|
|
nu ../scripts/init-registry.nu --registry-type zot
|
|
|
|
# Access UI
|
|
open http://localhost:5000
|
|
</code></pre>
|
|
<h3 id="start-harbor-registry"><a class="header" href="#start-harbor-registry">Start Harbor Registry</a></h3>
|
|
<pre><code class="language-bash">cd provisioning/platform/oci-registry/harbor
|
|
docker-compose up -d
|
|
sleep 120 # Wait for services
|
|
|
|
# Initialize
|
|
nu ../scripts/init-registry.nu --registry-type harbor --admin-password Harbor12345
|
|
|
|
# Access UI
|
|
open http://localhost
|
|
# Login: admin / Harbor12345
|
|
</code></pre>
|
|
<h2 id="default-namespaces"><a class="header" href="#default-namespaces">Default Namespaces</a></h2>
|
|
<div class="table-wrapper"><table><thead><tr><th>Namespace</th><th>Description</th><th>Public</th><th>Retention</th></tr></thead><tbody>
|
|
<tr><td><code>provisioning-extensions</code></td><td>Extension packages</td><td>No</td><td>10 tags, 90 days</td></tr>
|
|
<tr><td><code>provisioning-kcl</code></td><td>KCL schemas</td><td>No</td><td>20 tags, 180 days</td></tr>
|
|
<tr><td><code>provisioning-platform</code></td><td>Platform images</td><td>No</td><td>5 tags, 30 days</td></tr>
|
|
<tr><td><code>provisioning-test</code></td><td>Test artifacts</td><td>Yes</td><td>3 tags, 7 days</td></tr>
|
|
</tbody></table>
|
|
</div>
|
|
<h2 id="management"><a class="header" href="#management">Management</a></h2>
|
|
<h3 id="nushell-commands"><a class="header" href="#nushell-commands">Nushell Commands</a></h3>
|
|
<pre><code class="language-bash"># Start registry
|
|
nu -c "use provisioning/core/nulib/lib_provisioning/oci_registry; oci-registry start --type zot"
|
|
|
|
# Check status
|
|
nu -c "use provisioning/core/nulib/lib_provisioning/oci_registry; oci-registry status --type zot"
|
|
|
|
# View logs
|
|
nu -c "use provisioning/core/nulib/lib_provisioning/oci_registry; oci-registry logs --type zot --follow"
|
|
|
|
# Health check
|
|
nu -c "use provisioning/core/nulib/lib_provisioning/oci_registry; oci-registry health --type zot"
|
|
|
|
# List namespaces
|
|
nu -c "use provisioning/core/nulib/lib_provisioning/oci_registry; oci-registry namespaces"
|
|
</code></pre>
|
|
<h3 id="docker-compose"><a class="header" href="#docker-compose">Docker Compose</a></h3>
|
|
<pre><code class="language-bash"># Start
|
|
docker-compose up -d
|
|
|
|
# Stop
|
|
docker-compose down
|
|
|
|
# View logs
|
|
docker-compose logs -f
|
|
|
|
# Remove (including volumes)
|
|
docker-compose down -v
|
|
</code></pre>
|
|
<h2 id="registry-comparison"><a class="header" href="#registry-comparison">Registry Comparison</a></h2>
|
|
<div class="table-wrapper"><table><thead><tr><th>Feature</th><th>Zot</th><th>Harbor</th><th>Distribution</th></tr></thead><tbody>
|
|
<tr><td><strong>Setup</strong></td><td>Simple</td><td>Complex</td><td>Simple</td></tr>
|
|
<tr><td><strong>UI</strong></td><td>Built-in</td><td>Full-featured</td><td>None</td></tr>
|
|
<tr><td><strong>Search</strong></td><td>Yes</td><td>Yes</td><td>No</td></tr>
|
|
<tr><td><strong>Scanning</strong></td><td>No</td><td>Trivy</td><td>No</td></tr>
|
|
<tr><td><strong>Replication</strong></td><td>No</td><td>Yes</td><td>No</td></tr>
|
|
<tr><td><strong>RBAC</strong></td><td>Basic</td><td>Advanced</td><td>Basic</td></tr>
|
|
<tr><td><strong>Best For</strong></td><td>Dev/CI</td><td>Production</td><td>Compliance</td></tr>
|
|
</tbody></table>
|
|
</div>
|
|
<h2 id="security"><a class="header" href="#security">Security</a></h2>
|
|
<h3 id="authentication"><a class="header" href="#authentication">Authentication</a></h3>
|
|
<p><strong>Zot/Distribution (htpasswd)</strong>:</p>
|
|
<pre><code class="language-bash">htpasswd -Bc htpasswd provisioning
|
|
docker login localhost:5000
|
|
</code></pre>
|
|
<p><strong>Harbor (Database)</strong>:</p>
|
|
<pre><code class="language-bash">docker login localhost
|
|
# Username: admin / Password: Harbor12345
|
|
</code></pre>
|
|
<h2 id="monitoring"><a class="header" href="#monitoring">Monitoring</a></h2>
|
|
<h3 id="health-checks"><a class="header" href="#health-checks">Health Checks</a></h3>
|
|
<pre><code class="language-bash"># API check
|
|
curl http://localhost:5000/v2/
|
|
|
|
# Catalog check
|
|
curl http://localhost:5000/v2/_catalog
|
|
</code></pre>
|
|
<h3 id="metrics"><a class="header" href="#metrics">Metrics</a></h3>
|
|
<p><strong>Zot</strong>:</p>
|
|
<pre><code class="language-bash">curl http://localhost:5000/metrics
|
|
</code></pre>
|
|
<p><strong>Harbor</strong>:</p>
|
|
<pre><code class="language-bash">curl http://localhost:9090/metrics
|
|
</code></pre>
|
|
<h2 id="related-documentation"><a class="header" href="#related-documentation">Related Documentation</a></h2>
|
|
<ul>
|
|
<li><strong>Architecture</strong>: <a href="../architecture/multi-repo-strategy.html">OCI Integration</a></li>
|
|
<li><strong>User Guide</strong>: <a href="../user/oci-registry-guide.html">OCI Registry Guide</a></li>
|
|
</ul>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../platform/extension-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/installer.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/extension-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/installer.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>
|