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.
1495 lines
66 KiB
HTML
1495 lines
66 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="ayu sidebar-visible" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>Glossary - 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/GLOSSARY.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-platform-glossary"><a class="header" href="#provisioning-platform-glossary">Provisioning Platform Glossary</a></h1>
|
||
<p><strong>Last Updated</strong>: 2025-10-10
|
||
<strong>Version</strong>: 1.0.0</p>
|
||
<p>This glossary defines key terminology used throughout the Provisioning Platform documentation. Terms are listed alphabetically with definitions, usage context, and cross-references to related documentation.</p>
|
||
<hr />
|
||
<h2 id="a"><a class="header" href="#a">A</a></h2>
|
||
<h3 id="adr-architecture-decision-record"><a class="header" href="#adr-architecture-decision-record">ADR (Architecture Decision Record)</a></h3>
|
||
<p><strong>Definition</strong>: Documentation of significant architectural decisions, including context, decision, and consequences.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Architecture planning and review</li>
|
||
<li>Technical decision-making process</li>
|
||
<li>System design documentation</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Architecture, Design Patterns, Technical Debt</p>
|
||
<p><strong>Examples</strong>:</p>
|
||
<ul>
|
||
<li><a href="../docs/architecture/adr/ADR-001-project-structure.html">ADR-001: Project Structure</a></li>
|
||
<li><a href="../docs/architecture/adr/ADR-006-provisioning-cli-refactoring.html">ADR-006: CLI Refactoring</a></li>
|
||
<li><a href="../docs/architecture/adr/ADR-009-security-system-complete.html">ADR-009: Complete Security System</a></li>
|
||
</ul>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/README.html">Architecture Documentation</a></p>
|
||
<hr />
|
||
<h3 id="agent"><a class="header" href="#agent">Agent</a></h3>
|
||
<p><strong>Definition</strong>: A specialized, token-efficient component that performs a specific task in the system (e.g., Agent 1-16 in documentation generation).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Documentation generation workflows</li>
|
||
<li>Task orchestration</li>
|
||
<li>Parallel processing patterns</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Orchestrator, Workflow, Task</p>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/batch-workflow-system.html">Batch Workflow System</a></p>
|
||
<hr />
|
||
<h3 id="anchor-link"><a class="header" href="#anchor-link">Anchor Link</a></h3>
|
||
<p><strong>Definition</strong>: An internal document link to a specific section within the same or different markdown file using the <code>#</code> symbol.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Cross-referencing documentation sections</li>
|
||
<li>Table of contents generation</li>
|
||
<li>Navigation within long documents</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Internal Link, Cross-Reference, Documentation</p>
|
||
<p><strong>Examples</strong>:</p>
|
||
<ul>
|
||
<li><code>[See Installation](#installation)</code> - Same document</li>
|
||
<li><code>[Configuration Guide](config.md#setup)</code> - Different document</li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="api-gateway"><a class="header" href="#api-gateway">API Gateway</a></h3>
|
||
<p><strong>Definition</strong>: Platform service that provides unified REST API access to provisioning operations.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>External system integration</li>
|
||
<li>Web Control Center backend</li>
|
||
<li>MCP server communication</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: REST API, Platform Service, Orchestrator</p>
|
||
<p><strong>Location</strong>: <code>provisioning/platform/api-gateway/</code></p>
|
||
<p><strong>See Also</strong>: <a href="../docs/api/rest-api.html">REST API Documentation</a></p>
|
||
<hr />
|
||
<h3 id="auth-authentication"><a class="header" href="#auth-authentication">Auth (Authentication)</a></h3>
|
||
<p><strong>Definition</strong>: The process of verifying user identity using JWT tokens, MFA, and secure session management.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>User login flows</li>
|
||
<li>API access control</li>
|
||
<li>CLI session management</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Authorization, JWT, MFA, Security</p>
|
||
<p><strong>See Also</strong>:</p>
|
||
<ul>
|
||
<li><a href="../docs/user/AUTHENTICATION_LAYER_GUIDE.html">Authentication Layer Guide</a></li>
|
||
<li><a href="../docs/user/AUTH_QUICK_REFERENCE.html">Auth Quick Reference</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="authorization"><a class="header" href="#authorization">Authorization</a></h3>
|
||
<p><strong>Definition</strong>: The process of determining user permissions using Cedar policy language.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Access control decisions</li>
|
||
<li>Resource permission checks</li>
|
||
<li>Multi-tenant security</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Auth, Cedar, Policies, RBAC</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/CEDAR_AUTHORIZATION_IMPLEMENTATION.html">Cedar Authorization Implementation</a></p>
|
||
<hr />
|
||
<h2 id="b"><a class="header" href="#b">B</a></h2>
|
||
<h3 id="batch-operation"><a class="header" href="#batch-operation">Batch Operation</a></h3>
|
||
<p><strong>Definition</strong>: A collection of related infrastructure operations executed as a single workflow unit.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Multi-server deployments</li>
|
||
<li>Cluster creation</li>
|
||
<li>Bulk taskserv installation</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Workflow, Operation, Orchestrator</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning batch submit workflow.k
|
||
provisioning batch list
|
||
provisioning batch status <id>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/batch-workflow-system.html">Batch Workflow System</a></p>
|
||
<hr />
|
||
<h3 id="break-glass"><a class="header" href="#break-glass">Break-Glass</a></h3>
|
||
<p><strong>Definition</strong>: Emergency access mechanism requiring multi-party approval for critical operations.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Emergency system access</li>
|
||
<li>Incident response</li>
|
||
<li>Security override scenarios</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Security, Compliance, Audit</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning break-glass request "reason"
|
||
provisioning break-glass approve <id>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/operations/BREAK_GLASS_TRAINING_GUIDE.html">Break-Glass Training Guide</a></p>
|
||
<hr />
|
||
<h2 id="c"><a class="header" href="#c">C</a></h2>
|
||
<h3 id="cedar"><a class="header" href="#cedar">Cedar</a></h3>
|
||
<p><strong>Definition</strong>: Amazon’s policy language used for fine-grained authorization decisions.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Authorization policies</li>
|
||
<li>Access control rules</li>
|
||
<li>Resource permissions</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Authorization, Policies, Security</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/CEDAR_AUTHORIZATION_IMPLEMENTATION.html">Cedar Authorization Implementation</a></p>
|
||
<hr />
|
||
<h3 id="checkpoint"><a class="header" href="#checkpoint">Checkpoint</a></h3>
|
||
<p><strong>Definition</strong>: A saved state of a workflow allowing resume from point of failure.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Workflow recovery</li>
|
||
<li>Long-running operations</li>
|
||
<li>Batch processing</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Workflow, State Management, Recovery</p>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/batch-workflow-system.html">Batch Workflow System</a></p>
|
||
<hr />
|
||
<h3 id="cli-command-line-interface"><a class="header" href="#cli-command-line-interface">CLI (Command-Line Interface)</a></h3>
|
||
<p><strong>Definition</strong>: The <code>provisioning</code> command-line tool providing access to all platform operations.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Daily operations</li>
|
||
<li>Script automation</li>
|
||
<li>CI/CD pipelines</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Command, Shortcut, Module</p>
|
||
<p><strong>Location</strong>: <code>provisioning/core/cli/provisioning</code></p>
|
||
<p><strong>Examples</strong>:</p>
|
||
<pre><code class="language-bash">provisioning server create
|
||
provisioning taskserv install kubernetes
|
||
provisioning workspace switch prod
|
||
</code></pre>
|
||
<p><strong>See Also</strong>:</p>
|
||
<ul>
|
||
<li><a href="../.claude/features/cli-architecture.html">CLI Architecture</a></li>
|
||
<li><a href="../docs/user/cli-reference.html">CLI Reference</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="cluster"><a class="header" href="#cluster">Cluster</a></h3>
|
||
<p><strong>Definition</strong>: A complete, pre-configured deployment of multiple servers and taskservs working together.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Kubernetes deployments</li>
|
||
<li>Database clusters</li>
|
||
<li>Complete infrastructure stacks</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Infrastructure, Server, Taskserv</p>
|
||
<p><strong>Location</strong>: <code>provisioning/extensions/clusters/{name}/</code></p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning cluster create <name>
|
||
provisioning cluster list
|
||
provisioning cluster delete <name>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/infrastructure-management.html">Infrastructure Management</a></p>
|
||
<hr />
|
||
<h3 id="compliance"><a class="header" href="#compliance">Compliance</a></h3>
|
||
<p><strong>Definition</strong>: System capabilities ensuring adherence to regulatory requirements (GDPR, SOC2, ISO 27001).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Audit logging</li>
|
||
<li>Data retention policies</li>
|
||
<li>Incident response</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Audit, Security, GDPR</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/COMPLIANCE_IMPLEMENTATION_SUMMARY.html">Compliance Implementation Summary</a></p>
|
||
<hr />
|
||
<h3 id="config-configuration"><a class="header" href="#config-configuration">Config (Configuration)</a></h3>
|
||
<p><strong>Definition</strong>: System settings stored in TOML files with hierarchical loading and variable interpolation.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>System initialization</li>
|
||
<li>User preferences</li>
|
||
<li>Environment-specific settings</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Settings, Environment, Workspace</p>
|
||
<p><strong>Files</strong>:</p>
|
||
<ul>
|
||
<li><code>provisioning/config/config.defaults.toml</code> - System defaults</li>
|
||
<li><code>workspace/config/local-overrides.toml</code> - User settings</li>
|
||
</ul>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/configuration-system.html">Configuration System</a></p>
|
||
<hr />
|
||
<h3 id="control-center"><a class="header" href="#control-center">Control Center</a></h3>
|
||
<p><strong>Definition</strong>: Web-based UI for managing provisioning operations built with Ratatui/Crossterm.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Visual infrastructure management</li>
|
||
<li>Real-time monitoring</li>
|
||
<li>Guided workflows</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: UI, Platform Service, Orchestrator</p>
|
||
<p><strong>Location</strong>: <code>provisioning/platform/control-center/</code></p>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/ARCHITECTURE_OVERVIEW.html#platform-services">Platform Services</a></p>
|
||
<hr />
|
||
<h3 id="coredns"><a class="header" href="#coredns">CoreDNS</a></h3>
|
||
<p><strong>Definition</strong>: DNS server taskserv providing service discovery and DNS management.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Kubernetes DNS</li>
|
||
<li>Service discovery</li>
|
||
<li>Internal DNS resolution</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Taskserv, Kubernetes, Networking</p>
|
||
<p><strong>See Also</strong>:</p>
|
||
<ul>
|
||
<li><a href="../docs/user/COREDNS_GUIDE.html">CoreDNS Guide</a></li>
|
||
<li><a href="../docs/user/COREDNS_QUICK_REFERENCE.html">CoreDNS Quick Reference</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="cross-reference"><a class="header" href="#cross-reference">Cross-Reference</a></h3>
|
||
<p><strong>Definition</strong>: Links between related documentation sections or concepts.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Documentation navigation</li>
|
||
<li>Related topic discovery</li>
|
||
<li>Learning path guidance</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Documentation, Navigation, See Also</p>
|
||
<p><strong>Examples</strong>: “See Also” sections at the end of documentation pages</p>
|
||
<hr />
|
||
<h2 id="d"><a class="header" href="#d">D</a></h2>
|
||
<h3 id="dependency"><a class="header" href="#dependency">Dependency</a></h3>
|
||
<p><strong>Definition</strong>: A requirement that must be satisfied before installing or running a component.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Taskserv installation order</li>
|
||
<li>Version compatibility checks</li>
|
||
<li>Cluster deployment sequencing</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Version, Taskserv, Workflow</p>
|
||
<p><strong>Schema</strong>: <code>provisioning/kcl/dependencies.k</code></p>
|
||
<p><strong>See Also</strong>: <a href="../docs/development/kcl/KCL_DEPENDENCY_PATTERNS.html">KCL Dependency Patterns</a></p>
|
||
<hr />
|
||
<h3 id="diagnostics"><a class="header" href="#diagnostics">Diagnostics</a></h3>
|
||
<p><strong>Definition</strong>: System health checking and troubleshooting assistance.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>System status verification</li>
|
||
<li>Problem identification</li>
|
||
<li>Guided troubleshooting</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Health Check, Monitoring, Troubleshooting</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning status
|
||
provisioning diagnostics run
|
||
</code></pre>
|
||
<hr />
|
||
<h3 id="dynamic-secrets"><a class="header" href="#dynamic-secrets">Dynamic Secrets</a></h3>
|
||
<p><strong>Definition</strong>: Temporary credentials generated on-demand with automatic expiration.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>AWS STS tokens</li>
|
||
<li>SSH temporary keys</li>
|
||
<li>Database credentials</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Security, KMS, Secrets Management</p>
|
||
<p><strong>See Also</strong>:</p>
|
||
<ul>
|
||
<li><a href="../docs/DYNAMIC_SECRETS_IMPLEMENTATION.html">Dynamic Secrets Implementation</a></li>
|
||
<li><a href="../docs/user/DYNAMIC_SECRETS_QUICK_REFERENCE.html">Dynamic Secrets Quick Reference</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="e"><a class="header" href="#e">E</a></h2>
|
||
<h3 id="environment"><a class="header" href="#environment">Environment</a></h3>
|
||
<p><strong>Definition</strong>: A deployment context (dev, test, prod) with specific configuration overrides.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Configuration loading</li>
|
||
<li>Resource isolation</li>
|
||
<li>Deployment targeting</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Config, Workspace, Infrastructure</p>
|
||
<p><strong>Config Files</strong>: <code>config.{dev,test,prod}.toml</code></p>
|
||
<p><strong>Usage</strong>:</p>
|
||
<pre><code class="language-bash">PROVISIONING_ENV=prod provisioning server list
|
||
</code></pre>
|
||
<hr />
|
||
<h3 id="extension"><a class="header" href="#extension">Extension</a></h3>
|
||
<p><strong>Definition</strong>: A pluggable component adding functionality (provider, taskserv, cluster, or workflow).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Custom cloud providers</li>
|
||
<li>Third-party taskservs</li>
|
||
<li>Custom deployment patterns</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Provider, Taskserv, Cluster, Workflow</p>
|
||
<p><strong>Location</strong>: <code>provisioning/extensions/{type}/{name}/</code></p>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/extension-development.html">Extension Development</a></p>
|
||
<hr />
|
||
<h2 id="f"><a class="header" href="#f">F</a></h2>
|
||
<h3 id="feature"><a class="header" href="#feature">Feature</a></h3>
|
||
<p><strong>Definition</strong>: A major system capability documented in <code>.claude/features/</code>.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Architecture documentation</li>
|
||
<li>Feature planning</li>
|
||
<li>System capabilities</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: ADR, Architecture, System</p>
|
||
<p><strong>Location</strong>: <code>.claude/features/*.md</code></p>
|
||
<p><strong>Examples</strong>:</p>
|
||
<ul>
|
||
<li>Batch Workflow System</li>
|
||
<li>Orchestrator Architecture</li>
|
||
<li>CLI Architecture</li>
|
||
</ul>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/README.html">Features README</a></p>
|
||
<hr />
|
||
<h2 id="g"><a class="header" href="#g">G</a></h2>
|
||
<h3 id="gdpr-general-data-protection-regulation"><a class="header" href="#gdpr-general-data-protection-regulation">GDPR (General Data Protection Regulation)</a></h3>
|
||
<p><strong>Definition</strong>: EU data protection regulation compliance features in the platform.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Data export requests</li>
|
||
<li>Right to erasure</li>
|
||
<li>Audit compliance</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Compliance, Audit, Security</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning compliance gdpr export <user>
|
||
provisioning compliance gdpr delete <user>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/COMPLIANCE_IMPLEMENTATION_SUMMARY.html">Compliance Implementation</a></p>
|
||
<hr />
|
||
<h3 id="glossary"><a class="header" href="#glossary">Glossary</a></h3>
|
||
<p><strong>Definition</strong>: This document - a comprehensive terminology reference for the platform.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Learning the platform</li>
|
||
<li>Understanding documentation</li>
|
||
<li>Resolving terminology questions</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Documentation, Reference, Cross-Reference</p>
|
||
<hr />
|
||
<h3 id="guide"><a class="header" href="#guide">Guide</a></h3>
|
||
<p><strong>Definition</strong>: Step-by-step walkthrough documentation for common workflows.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Onboarding new users</li>
|
||
<li>Learning workflows</li>
|
||
<li>Reference implementation</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Documentation, Workflow, Tutorial</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning guide from-scratch
|
||
provisioning guide update
|
||
provisioning guide customize
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/guide-system.html">Guide System</a></p>
|
||
<hr />
|
||
<h2 id="h"><a class="header" href="#h">H</a></h2>
|
||
<h3 id="health-check"><a class="header" href="#health-check">Health Check</a></h3>
|
||
<p><strong>Definition</strong>: Automated verification that a component is running correctly.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Taskserv validation</li>
|
||
<li>System monitoring</li>
|
||
<li>Dependency verification</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Diagnostics, Monitoring, Status</p>
|
||
<p><strong>Example</strong>:</p>
|
||
<pre><code class="language-kcl">health_check = {
|
||
endpoint = "http://localhost:6443/healthz"
|
||
timeout = 30
|
||
interval = 10
|
||
}
|
||
</code></pre>
|
||
<hr />
|
||
<h3 id="hybrid-architecture"><a class="header" href="#hybrid-architecture">Hybrid Architecture</a></h3>
|
||
<p><strong>Definition</strong>: System design combining Rust orchestrator with Nushell business logic.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Core platform architecture</li>
|
||
<li>Performance optimization</li>
|
||
<li>Call stack management</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Orchestrator, Architecture, Design</p>
|
||
<p><strong>See Also</strong>:</p>
|
||
<ul>
|
||
<li><a href="../.claude/features/orchestrator-architecture.html">Orchestrator Architecture</a></li>
|
||
<li><a href="../docs/architecture/adr/ADR-004-hybrid-architecture.html">ADR-004: Hybrid Architecture</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="i"><a class="header" href="#i">I</a></h2>
|
||
<h3 id="infrastructure"><a class="header" href="#infrastructure">Infrastructure</a></h3>
|
||
<p><strong>Definition</strong>: A named collection of servers, configurations, and deployments managed as a unit.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Environment isolation</li>
|
||
<li>Resource organization</li>
|
||
<li>Deployment targeting</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Workspace, Server, Environment</p>
|
||
<p><strong>Location</strong>: <code>workspace/infra/{name}/</code></p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning infra list
|
||
provisioning generate infra --new <name>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/infrastructure-management.html">Infrastructure Management</a></p>
|
||
<hr />
|
||
<h3 id="integration"><a class="header" href="#integration">Integration</a></h3>
|
||
<p><strong>Definition</strong>: Connection between platform components or external systems.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>API integration</li>
|
||
<li>CI/CD pipelines</li>
|
||
<li>External tool connectivity</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: API, Extension, Platform</p>
|
||
<p><strong>See Also</strong>:</p>
|
||
<ul>
|
||
<li><a href="../docs/architecture/integration-patterns.html">Integration Patterns</a></li>
|
||
<li><a href="../docs/api/integration-examples.html">Integration Examples</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="internal-link"><a class="header" href="#internal-link">Internal Link</a></h3>
|
||
<p><strong>Definition</strong>: A markdown link to another documentation file or section within the platform docs.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Cross-referencing documentation</li>
|
||
<li>Navigation between topics</li>
|
||
<li>Related content discovery</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Anchor Link, Cross-Reference, Documentation</p>
|
||
<p><strong>Examples</strong>:</p>
|
||
<ul>
|
||
<li><code>[See Configuration](./configuration.md)</code></li>
|
||
<li><code>[Architecture Overview](../architecture/README.md)</code></li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="j"><a class="header" href="#j">J</a></h2>
|
||
<h3 id="jwt-json-web-token"><a class="header" href="#jwt-json-web-token">JWT (JSON Web Token)</a></h3>
|
||
<p><strong>Definition</strong>: Token-based authentication mechanism using RS256 signatures.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>User authentication</li>
|
||
<li>API authorization</li>
|
||
<li>Session management</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Auth, Security, Token</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/JWT_AUTH_IMPLEMENTATION.html">JWT Auth Implementation</a></p>
|
||
<hr />
|
||
<h2 id="k"><a class="header" href="#k">K</a></h2>
|
||
<h3 id="kcl-kcl-configuration-language"><a class="header" href="#kcl-kcl-configuration-language">KCL (KCL Configuration Language)</a></h3>
|
||
<p><strong>Definition</strong>: Declarative configuration language used for infrastructure definitions.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Infrastructure schemas</li>
|
||
<li>Workflow definitions</li>
|
||
<li>Configuration validation</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Schema, Configuration, Validation</p>
|
||
<p><strong>Version</strong>: 0.11.3+</p>
|
||
<p><strong>Location</strong>: <code>provisioning/kcl/*.k</code></p>
|
||
<p><strong>See Also</strong>:</p>
|
||
<ul>
|
||
<li><a href="../.claude/kcl_idiomatic_patterns.html">KCL Idiomatic Patterns</a></li>
|
||
<li><a href="../docs/development/kcl/KCL_QUICK_REFERENCE.html">KCL Quick Reference</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="kms-key-management-service"><a class="header" href="#kms-key-management-service">KMS (Key Management Service)</a></h3>
|
||
<p><strong>Definition</strong>: Encryption key management system supporting multiple backends (RustyVault, Age, AWS, Vault).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Configuration encryption</li>
|
||
<li>Secret management</li>
|
||
<li>Data protection</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Security, Encryption, Secrets</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/RUSTYVAULT_KMS_GUIDE.html">RustyVault KMS Guide</a></p>
|
||
<hr />
|
||
<h3 id="kubernetes"><a class="header" href="#kubernetes">Kubernetes</a></h3>
|
||
<p><strong>Definition</strong>: Container orchestration platform available as a taskserv.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Container deployments</li>
|
||
<li>Cluster management</li>
|
||
<li>Production workloads</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Taskserv, Cluster, Container</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning taskserv create kubernetes
|
||
provisioning test quick kubernetes
|
||
</code></pre>
|
||
<hr />
|
||
<h2 id="l"><a class="header" href="#l">L</a></h2>
|
||
<h3 id="layer"><a class="header" href="#layer">Layer</a></h3>
|
||
<p><strong>Definition</strong>: A level in the configuration hierarchy (Core → Workspace → Infrastructure).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Configuration inheritance</li>
|
||
<li>Customization patterns</li>
|
||
<li>Settings override</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Config, Workspace, Infrastructure</p>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/configuration-system.html">Configuration System</a></p>
|
||
<hr />
|
||
<h2 id="m"><a class="header" href="#m">M</a></h2>
|
||
<h3 id="mcp-model-context-protocol"><a class="header" href="#mcp-model-context-protocol">MCP (Model Context Protocol)</a></h3>
|
||
<p><strong>Definition</strong>: AI-powered server providing intelligent configuration assistance.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Configuration validation</li>
|
||
<li>Troubleshooting guidance</li>
|
||
<li>Documentation search</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Platform Service, AI, Guidance</p>
|
||
<p><strong>Location</strong>: <code>provisioning/platform/mcp-server/</code></p>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/ARCHITECTURE_OVERVIEW.html#platform-services">Platform Services</a></p>
|
||
<hr />
|
||
<h3 id="mfa-multi-factor-authentication"><a class="header" href="#mfa-multi-factor-authentication">MFA (Multi-Factor Authentication)</a></h3>
|
||
<p><strong>Definition</strong>: Additional authentication layer using TOTP or WebAuthn/FIDO2.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Enhanced security</li>
|
||
<li>Compliance requirements</li>
|
||
<li>Production access</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Auth, Security, TOTP, WebAuthn</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning mfa totp enroll
|
||
provisioning mfa webauthn enroll
|
||
provisioning mfa verify <code>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/MFA_IMPLEMENTATION_SUMMARY.html">MFA Implementation Summary</a></p>
|
||
<hr />
|
||
<h3 id="migration"><a class="header" href="#migration">Migration</a></h3>
|
||
<p><strong>Definition</strong>: Process of updating existing infrastructure or moving between system versions.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>System upgrades</li>
|
||
<li>Configuration changes</li>
|
||
<li>Infrastructure evolution</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Update, Upgrade, Version</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/migration/MIGRATION_GUIDE.html">Migration Guide</a></p>
|
||
<hr />
|
||
<h3 id="module"><a class="header" href="#module">Module</a></h3>
|
||
<p><strong>Definition</strong>: A reusable component (provider, taskserv, cluster) loaded into a workspace.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Extension management</li>
|
||
<li>Workspace customization</li>
|
||
<li>Component distribution</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Extension, Workspace, Package</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning module discover provider
|
||
provisioning module load provider <ws> <name>
|
||
provisioning module list taskserv
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/cli-architecture.html#module-system">Module System</a></p>
|
||
<hr />
|
||
<h2 id="n"><a class="header" href="#n">N</a></h2>
|
||
<h3 id="nushell"><a class="header" href="#nushell">Nushell</a></h3>
|
||
<p><strong>Definition</strong>: Primary shell and scripting language (v0.107.1) used throughout the platform.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>CLI implementation</li>
|
||
<li>Automation scripts</li>
|
||
<li>Business logic</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: CLI, Script, Automation</p>
|
||
<p><strong>Version</strong>: 0.107.1</p>
|
||
<p><strong>See Also</strong>: <a href="../.claude/best_nushell_code.html">Best Nushell Code</a></p>
|
||
<hr />
|
||
<h2 id="o"><a class="header" href="#o">O</a></h2>
|
||
<h3 id="oci-open-container-initiative"><a class="header" href="#oci-open-container-initiative">OCI (Open Container Initiative)</a></h3>
|
||
<p><strong>Definition</strong>: Standard format for packaging and distributing extensions.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Extension distribution</li>
|
||
<li>Package registry</li>
|
||
<li>Version management</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Registry, Package, Distribution</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/OCI_REGISTRY_GUIDE.html">OCI Registry Guide</a></p>
|
||
<hr />
|
||
<h3 id="operation"><a class="header" href="#operation">Operation</a></h3>
|
||
<p><strong>Definition</strong>: A single infrastructure action (create server, install taskserv, etc.).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Workflow steps</li>
|
||
<li>Batch processing</li>
|
||
<li>Orchestrator tasks</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Workflow, Task, Action</p>
|
||
<hr />
|
||
<h3 id="orchestrator"><a class="header" href="#orchestrator">Orchestrator</a></h3>
|
||
<p><strong>Definition</strong>: Hybrid Rust/Nushell service coordinating complex infrastructure operations.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Workflow execution</li>
|
||
<li>Task coordination</li>
|
||
<li>State management</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Hybrid Architecture, Workflow, Platform Service</p>
|
||
<p><strong>Location</strong>: <code>provisioning/platform/orchestrator/</code></p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">cd provisioning/platform/orchestrator
|
||
./scripts/start-orchestrator.nu --background
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/orchestrator-architecture.html">Orchestrator Architecture</a></p>
|
||
<hr />
|
||
<h2 id="p"><a class="header" href="#p">P</a></h2>
|
||
<h3 id="pap-project-architecture-principles"><a class="header" href="#pap-project-architecture-principles">PAP (Project Architecture Principles)</a></h3>
|
||
<p><strong>Definition</strong>: Core architectural rules and patterns that must be followed.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Code review</li>
|
||
<li>Architecture decisions</li>
|
||
<li>Design validation</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Architecture, ADR, Best Practices</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/architecture/ARCHITECTURE_OVERVIEW.html">Architecture Overview</a></p>
|
||
<hr />
|
||
<h3 id="platform-service"><a class="header" href="#platform-service">Platform Service</a></h3>
|
||
<p><strong>Definition</strong>: A core service providing platform-level functionality (Orchestrator, Control Center, MCP, API Gateway).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>System infrastructure</li>
|
||
<li>Core capabilities</li>
|
||
<li>Service integration</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Service, Architecture, Infrastructure</p>
|
||
<p><strong>Location</strong>: <code>provisioning/platform/{service}/</code></p>
|
||
<hr />
|
||
<h3 id="plugin"><a class="header" href="#plugin">Plugin</a></h3>
|
||
<p><strong>Definition</strong>: Native Nushell plugin providing performance-optimized operations.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Auth operations (10-50x faster)</li>
|
||
<li>KMS encryption</li>
|
||
<li>Orchestrator queries</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Nushell, Performance, Native</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning plugin list
|
||
provisioning plugin install
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/NUSHELL_PLUGINS_GUIDE.html">Nushell Plugins Guide</a></p>
|
||
<hr />
|
||
<h3 id="provider"><a class="header" href="#provider">Provider</a></h3>
|
||
<p><strong>Definition</strong>: Cloud platform integration (AWS, UpCloud, local) handling infrastructure provisioning.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Server creation</li>
|
||
<li>Resource management</li>
|
||
<li>Cloud operations</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Extension, Infrastructure, Cloud</p>
|
||
<p><strong>Location</strong>: <code>provisioning/extensions/providers/{name}/</code></p>
|
||
<p><strong>Examples</strong>: aws, upcloud, local</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning module discover provider
|
||
provisioning providers list
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/development/QUICK_PROVIDER_GUIDE.html">Quick Provider Guide</a></p>
|
||
<hr />
|
||
<h2 id="q"><a class="header" href="#q">Q</a></h2>
|
||
<h3 id="quick-reference"><a class="header" href="#quick-reference">Quick Reference</a></h3>
|
||
<p><strong>Definition</strong>: Condensed command and configuration reference for rapid lookup.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Daily operations</li>
|
||
<li>Quick reminders</li>
|
||
<li>Command syntax</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Guide, Documentation, Cheatsheet</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning sc # Fastest
|
||
provisioning guide quickstart
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/guides/quickstart-cheatsheet.html">Quickstart Cheatsheet</a></p>
|
||
<hr />
|
||
<h2 id="r"><a class="header" href="#r">R</a></h2>
|
||
<h3 id="rbac-role-based-access-control"><a class="header" href="#rbac-role-based-access-control">RBAC (Role-Based Access Control)</a></h3>
|
||
<p><strong>Definition</strong>: Permission system with 5 roles (admin, operator, developer, viewer, auditor).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>User permissions</li>
|
||
<li>Access control</li>
|
||
<li>Security policies</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Authorization, Cedar, Security</p>
|
||
<p><strong>Roles</strong>: Admin, Operator, Developer, Viewer, Auditor</p>
|
||
<hr />
|
||
<h3 id="registry"><a class="header" href="#registry">Registry</a></h3>
|
||
<p><strong>Definition</strong>: OCI-compliant repository for storing and distributing extensions.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Extension publishing</li>
|
||
<li>Version management</li>
|
||
<li>Package distribution</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: OCI, Package, Distribution</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/OCI_REGISTRY_GUIDE.html">OCI Registry Guide</a></p>
|
||
<hr />
|
||
<h3 id="rest-api"><a class="header" href="#rest-api">REST API</a></h3>
|
||
<p><strong>Definition</strong>: HTTP endpoints exposing platform operations to external systems.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>External integration</li>
|
||
<li>Web UI backend</li>
|
||
<li>Programmatic access</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: API, Integration, HTTP</p>
|
||
<p><strong>Endpoint</strong>: <code>http://localhost:9090</code></p>
|
||
<p><strong>See Also</strong>: <a href="../docs/api/rest-api.html">REST API Documentation</a></p>
|
||
<hr />
|
||
<h3 id="rollback"><a class="header" href="#rollback">Rollback</a></h3>
|
||
<p><strong>Definition</strong>: Reverting a failed workflow or operation to previous stable state.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Failure recovery</li>
|
||
<li>Deployment safety</li>
|
||
<li>State restoration</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Workflow, Checkpoint, Recovery</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning batch rollback <workflow-id>
|
||
</code></pre>
|
||
<hr />
|
||
<h3 id="rustyvault"><a class="header" href="#rustyvault">RustyVault</a></h3>
|
||
<p><strong>Definition</strong>: Rust-based secrets management backend for KMS.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Key storage</li>
|
||
<li>Secret encryption</li>
|
||
<li>Configuration protection</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: KMS, Security, Encryption</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/RUSTYVAULT_KMS_GUIDE.html">RustyVault KMS Guide</a></p>
|
||
<hr />
|
||
<h2 id="s"><a class="header" href="#s">S</a></h2>
|
||
<h3 id="schema"><a class="header" href="#schema">Schema</a></h3>
|
||
<p><strong>Definition</strong>: KCL type definition specifying structure and validation rules.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Configuration validation</li>
|
||
<li>Type safety</li>
|
||
<li>Documentation</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: KCL, Validation, Type</p>
|
||
<p><strong>Example</strong>:</p>
|
||
<pre><code class="language-kcl">schema ServerConfig:
|
||
hostname: str
|
||
cores: int
|
||
memory: int
|
||
|
||
check:
|
||
cores > 0, "Cores must be positive"
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../.claude/kcl_idiomatic_patterns.html">KCL Idiomatic Patterns</a></p>
|
||
<hr />
|
||
<h3 id="secrets-management"><a class="header" href="#secrets-management">Secrets Management</a></h3>
|
||
<p><strong>Definition</strong>: System for secure storage and retrieval of sensitive data.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Password storage</li>
|
||
<li>API keys</li>
|
||
<li>Certificates</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: KMS, Security, Encryption</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/DYNAMIC_SECRETS_IMPLEMENTATION.html">Dynamic Secrets Implementation</a></p>
|
||
<hr />
|
||
<h3 id="security-system"><a class="header" href="#security-system">Security System</a></h3>
|
||
<p><strong>Definition</strong>: Comprehensive enterprise-grade security with 12 components (Auth, Cedar, MFA, KMS, Secrets, Compliance, etc.).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>User authentication</li>
|
||
<li>Access control</li>
|
||
<li>Data protection</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Auth, Authorization, MFA, KMS, Audit</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/SECURITY_SYSTEM_IMPLEMENTATION_COMPLETE.html">Security System Implementation</a></p>
|
||
<hr />
|
||
<h3 id="server"><a class="header" href="#server">Server</a></h3>
|
||
<p><strong>Definition</strong>: Virtual machine or physical host managed by the platform.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Infrastructure provisioning</li>
|
||
<li>Compute resources</li>
|
||
<li>Deployment targets</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Infrastructure, Provider, Taskserv</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning server create
|
||
provisioning server list
|
||
provisioning server ssh <hostname>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/infrastructure-management.html">Infrastructure Management</a></p>
|
||
<hr />
|
||
<h3 id="service"><a class="header" href="#service">Service</a></h3>
|
||
<p><strong>Definition</strong>: A running application or daemon (interchangeable with Taskserv in many contexts).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Service management</li>
|
||
<li>Application deployment</li>
|
||
<li>System administration</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Taskserv, Daemon, Application</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/SERVICE_MANAGEMENT_GUIDE.html">Service Management Guide</a></p>
|
||
<hr />
|
||
<h3 id="shortcut"><a class="header" href="#shortcut">Shortcut</a></h3>
|
||
<p><strong>Definition</strong>: Abbreviated command alias for faster CLI operations.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Daily operations</li>
|
||
<li>Quick commands</li>
|
||
<li>Productivity enhancement</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: CLI, Command, Alias</p>
|
||
<p><strong>Examples</strong>:</p>
|
||
<ul>
|
||
<li><code>provisioning s create</code> → <code>provisioning server create</code></li>
|
||
<li><code>provisioning ws list</code> → <code>provisioning workspace list</code></li>
|
||
<li><code>provisioning sc</code> → Quick reference</li>
|
||
</ul>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/cli-architecture.html#command-shortcuts-reference">CLI Architecture</a></p>
|
||
<hr />
|
||
<h3 id="sops-secrets-operations"><a class="header" href="#sops-secrets-operations">SOPS (Secrets OPerationS)</a></h3>
|
||
<p><strong>Definition</strong>: Encryption tool for managing secrets in version control.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Configuration encryption</li>
|
||
<li>Secret management</li>
|
||
<li>Secure storage</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Encryption, Security, Age</p>
|
||
<p><strong>Version</strong>: 3.10.2</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning sops edit <file>
|
||
</code></pre>
|
||
<hr />
|
||
<h3 id="ssh-secure-shell"><a class="header" href="#ssh-secure-shell">SSH (Secure Shell)</a></h3>
|
||
<p><strong>Definition</strong>: Encrypted remote access protocol with temporal key support.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Server administration</li>
|
||
<li>Remote commands</li>
|
||
<li>Secure file transfer</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Security, Server, Remote Access</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning server ssh <hostname>
|
||
provisioning ssh connect <server>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/SSH_TEMPORAL_KEYS_USER_GUIDE.html">SSH Temporal Keys User Guide</a></p>
|
||
<hr />
|
||
<h3 id="state-management"><a class="header" href="#state-management">State Management</a></h3>
|
||
<p><strong>Definition</strong>: Tracking and persisting workflow execution state.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Workflow recovery</li>
|
||
<li>Progress tracking</li>
|
||
<li>Failure handling</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Workflow, Checkpoint, Orchestrator</p>
|
||
<hr />
|
||
<h2 id="t"><a class="header" href="#t">T</a></h2>
|
||
<h3 id="task"><a class="header" href="#task">Task</a></h3>
|
||
<p><strong>Definition</strong>: A unit of work submitted to the orchestrator for execution.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Workflow execution</li>
|
||
<li>Job processing</li>
|
||
<li>Operation tracking</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Operation, Workflow, Orchestrator</p>
|
||
<hr />
|
||
<h3 id="taskserv"><a class="header" href="#taskserv">Taskserv</a></h3>
|
||
<p><strong>Definition</strong>: An installable infrastructure service (Kubernetes, PostgreSQL, Redis, etc.).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Service installation</li>
|
||
<li>Application deployment</li>
|
||
<li>Infrastructure components</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Service, Extension, Package</p>
|
||
<p><strong>Location</strong>: <code>provisioning/extensions/taskservs/{category}/{name}/</code></p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning taskserv create <name>
|
||
provisioning taskserv list
|
||
provisioning test quick <taskserv>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/development/TASKSERV_DEVELOPER_GUIDE.html">Taskserv Developer Guide</a></p>
|
||
<hr />
|
||
<h3 id="template"><a class="header" href="#template">Template</a></h3>
|
||
<p><strong>Definition</strong>: Parameterized configuration file supporting variable substitution.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Configuration generation</li>
|
||
<li>Infrastructure customization</li>
|
||
<li>Deployment automation</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Config, Generation, Customization</p>
|
||
<p><strong>Location</strong>: <code>provisioning/templates/</code></p>
|
||
<hr />
|
||
<h3 id="test-environment"><a class="header" href="#test-environment">Test Environment</a></h3>
|
||
<p><strong>Definition</strong>: Containerized isolated environment for testing taskservs and clusters.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Development testing</li>
|
||
<li>CI/CD integration</li>
|
||
<li>Pre-deployment validation</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Container, Testing, Validation</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning test quick <taskserv>
|
||
provisioning test env single <taskserv>
|
||
provisioning test env cluster <cluster>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/test-environment-service.html">Test Environment Service</a></p>
|
||
<hr />
|
||
<h3 id="topology"><a class="header" href="#topology">Topology</a></h3>
|
||
<p><strong>Definition</strong>: Multi-node cluster configuration template (Kubernetes HA, etcd cluster, etc.).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Cluster testing</li>
|
||
<li>Multi-node deployments</li>
|
||
<li>Production simulation</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Test Environment, Cluster, Configuration</p>
|
||
<p><strong>Examples</strong>: kubernetes_3node, etcd_cluster, kubernetes_single</p>
|
||
<hr />
|
||
<h3 id="totp-time-based-one-time-password"><a class="header" href="#totp-time-based-one-time-password">TOTP (Time-based One-Time Password)</a></h3>
|
||
<p><strong>Definition</strong>: MFA method generating time-sensitive codes.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Two-factor authentication</li>
|
||
<li>MFA enrollment</li>
|
||
<li>Security enhancement</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: MFA, Security, Auth</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning mfa totp enroll
|
||
provisioning mfa totp verify <code>
|
||
</code></pre>
|
||
<hr />
|
||
<h3 id="troubleshooting"><a class="header" href="#troubleshooting">Troubleshooting</a></h3>
|
||
<p><strong>Definition</strong>: System problem diagnosis and resolution guidance.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Problem solving</li>
|
||
<li>Error resolution</li>
|
||
<li>System debugging</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Diagnostics, Guide, Support</p>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/troubleshooting-guide.html">Troubleshooting Guide</a></p>
|
||
<hr />
|
||
<h2 id="u"><a class="header" href="#u">U</a></h2>
|
||
<h3 id="ui-user-interface"><a class="header" href="#ui-user-interface">UI (User Interface)</a></h3>
|
||
<p><strong>Definition</strong>: Visual interface for platform operations (Control Center, Web UI).</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Visual management</li>
|
||
<li>Guided workflows</li>
|
||
<li>Monitoring dashboards</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Control Center, Platform Service, GUI</p>
|
||
<hr />
|
||
<h3 id="update"><a class="header" href="#update">Update</a></h3>
|
||
<p><strong>Definition</strong>: Process of upgrading infrastructure components to newer versions.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Version management</li>
|
||
<li>Security patches</li>
|
||
<li>Feature updates</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Version, Migration, Upgrade</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning version check
|
||
provisioning version apply
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/migration/guides/update-infrastructure.html">Update Infrastructure Guide</a></p>
|
||
<hr />
|
||
<h2 id="v"><a class="header" href="#v">V</a></h2>
|
||
<h3 id="validation"><a class="header" href="#validation">Validation</a></h3>
|
||
<p><strong>Definition</strong>: Verification that configuration or infrastructure meets requirements.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Configuration checks</li>
|
||
<li>Schema validation</li>
|
||
<li>Pre-deployment verification</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Schema, KCL, Check</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning validate config
|
||
provisioning validate infrastructure
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../provisioning/docs/CONFIG_VALIDATION.html">Config Validation</a></p>
|
||
<hr />
|
||
<h3 id="version"><a class="header" href="#version">Version</a></h3>
|
||
<p><strong>Definition</strong>: Semantic version identifier for components and compatibility.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Component versioning</li>
|
||
<li>Compatibility checking</li>
|
||
<li>Update management</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Update, Dependency, Compatibility</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning version
|
||
provisioning version check
|
||
provisioning taskserv check-updates
|
||
</code></pre>
|
||
<hr />
|
||
<h2 id="w"><a class="header" href="#w">W</a></h2>
|
||
<h3 id="webauthn"><a class="header" href="#webauthn">WebAuthn</a></h3>
|
||
<p><strong>Definition</strong>: FIDO2-based passwordless authentication standard.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Hardware key authentication</li>
|
||
<li>Passwordless login</li>
|
||
<li>Enhanced MFA</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: MFA, Security, FIDO2</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning mfa webauthn enroll
|
||
provisioning mfa webauthn verify
|
||
</code></pre>
|
||
<hr />
|
||
<h3 id="workflow"><a class="header" href="#workflow">Workflow</a></h3>
|
||
<p><strong>Definition</strong>: A sequence of related operations with dependency management and state tracking.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Complex deployments</li>
|
||
<li>Multi-step operations</li>
|
||
<li>Automated processes</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Batch Operation, Orchestrator, Task</p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning workflow list
|
||
provisioning workflow status <id>
|
||
provisioning workflow monitor <id>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../.claude/features/batch-workflow-system.html">Batch Workflow System</a></p>
|
||
<hr />
|
||
<h3 id="workspace"><a class="header" href="#workspace">Workspace</a></h3>
|
||
<p><strong>Definition</strong>: An isolated environment containing infrastructure definitions and configuration.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Project isolation</li>
|
||
<li>Environment separation</li>
|
||
<li>Team workspaces</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Infrastructure, Config, Environment</p>
|
||
<p><strong>Location</strong>: <code>workspace/{name}/</code></p>
|
||
<p><strong>Commands</strong>:</p>
|
||
<pre><code class="language-bash">provisioning workspace list
|
||
provisioning workspace switch <name>
|
||
provisioning workspace create <name>
|
||
</code></pre>
|
||
<p><strong>See Also</strong>: <a href="../docs/user/WORKSPACE_SWITCHING_GUIDE.html">Workspace Switching Guide</a></p>
|
||
<hr />
|
||
<h2 id="x-z"><a class="header" href="#x-z">X-Z</a></h2>
|
||
<h3 id="yaml"><a class="header" href="#yaml">YAML</a></h3>
|
||
<p><strong>Definition</strong>: Data serialization format used for Kubernetes manifests and configuration.</p>
|
||
<p><strong>Where Used</strong>:</p>
|
||
<ul>
|
||
<li>Kubernetes deployments</li>
|
||
<li>Configuration files</li>
|
||
<li>Data interchange</li>
|
||
</ul>
|
||
<p><strong>Related Concepts</strong>: Config, Kubernetes, Data Format</p>
|
||
<hr />
|
||
<h2 id="symbol-and-acronym-index"><a class="header" href="#symbol-and-acronym-index">Symbol and Acronym Index</a></h2>
|
||
<div class="table-wrapper"><table><thead><tr><th>Symbol/Acronym</th><th>Full Term</th><th>Category</th></tr></thead><tbody>
|
||
<tr><td>ADR</td><td>Architecture Decision Record</td><td>Architecture</td></tr>
|
||
<tr><td>API</td><td>Application Programming Interface</td><td>Integration</td></tr>
|
||
<tr><td>CLI</td><td>Command-Line Interface</td><td>User Interface</td></tr>
|
||
<tr><td>GDPR</td><td>General Data Protection Regulation</td><td>Compliance</td></tr>
|
||
<tr><td>JWT</td><td>JSON Web Token</td><td>Security</td></tr>
|
||
<tr><td>KCL</td><td>KCL Configuration Language</td><td>Configuration</td></tr>
|
||
<tr><td>KMS</td><td>Key Management Service</td><td>Security</td></tr>
|
||
<tr><td>MCP</td><td>Model Context Protocol</td><td>Platform</td></tr>
|
||
<tr><td>MFA</td><td>Multi-Factor Authentication</td><td>Security</td></tr>
|
||
<tr><td>OCI</td><td>Open Container Initiative</td><td>Packaging</td></tr>
|
||
<tr><td>PAP</td><td>Project Architecture Principles</td><td>Architecture</td></tr>
|
||
<tr><td>RBAC</td><td>Role-Based Access Control</td><td>Security</td></tr>
|
||
<tr><td>REST</td><td>Representational State Transfer</td><td>API</td></tr>
|
||
<tr><td>SOC2</td><td>Service Organization Control 2</td><td>Compliance</td></tr>
|
||
<tr><td>SOPS</td><td>Secrets OPerationS</td><td>Security</td></tr>
|
||
<tr><td>SSH</td><td>Secure Shell</td><td>Remote Access</td></tr>
|
||
<tr><td>TOTP</td><td>Time-based One-Time Password</td><td>Security</td></tr>
|
||
<tr><td>UI</td><td>User Interface</td><td>User Interface</td></tr>
|
||
</tbody></table>
|
||
</div>
|
||
<hr />
|
||
<h2 id="cross-reference-map"><a class="header" href="#cross-reference-map">Cross-Reference Map</a></h2>
|
||
<h3 id="by-topic-area"><a class="header" href="#by-topic-area">By Topic Area</a></h3>
|
||
<p><strong>Infrastructure</strong>:</p>
|
||
<ul>
|
||
<li>Infrastructure, Server, Cluster, Provider, Taskserv, Module</li>
|
||
</ul>
|
||
<p><strong>Security</strong>:</p>
|
||
<ul>
|
||
<li>Auth, Authorization, JWT, MFA, TOTP, WebAuthn, Cedar, KMS, Secrets Management, RBAC, Break-Glass</li>
|
||
</ul>
|
||
<p><strong>Configuration</strong>:</p>
|
||
<ul>
|
||
<li>Config, KCL, Schema, Validation, Environment, Layer, Workspace</li>
|
||
</ul>
|
||
<p><strong>Workflow & Operations</strong>:</p>
|
||
<ul>
|
||
<li>Workflow, Batch Operation, Operation, Task, Orchestrator, Checkpoint, Rollback</li>
|
||
</ul>
|
||
<p><strong>Platform Services</strong>:</p>
|
||
<ul>
|
||
<li>Orchestrator, Control Center, MCP, API Gateway, Platform Service</li>
|
||
</ul>
|
||
<p><strong>Documentation</strong>:</p>
|
||
<ul>
|
||
<li>Glossary, Guide, ADR, Cross-Reference, Internal Link, Anchor Link</li>
|
||
</ul>
|
||
<p><strong>Development</strong>:</p>
|
||
<ul>
|
||
<li>Extension, Plugin, Template, Module, Integration</li>
|
||
</ul>
|
||
<p><strong>Testing</strong>:</p>
|
||
<ul>
|
||
<li>Test Environment, Topology, Validation, Health Check</li>
|
||
</ul>
|
||
<p><strong>Compliance</strong>:</p>
|
||
<ul>
|
||
<li>Compliance, GDPR, Audit, Security System</li>
|
||
</ul>
|
||
<h3 id="by-user-journey"><a class="header" href="#by-user-journey">By User Journey</a></h3>
|
||
<p><strong>New User</strong>:</p>
|
||
<ol>
|
||
<li>Glossary (this document)</li>
|
||
<li>Guide</li>
|
||
<li>Quick Reference</li>
|
||
<li>Workspace</li>
|
||
<li>Infrastructure</li>
|
||
<li>Server</li>
|
||
<li>Taskserv</li>
|
||
</ol>
|
||
<p><strong>Developer</strong>:</p>
|
||
<ol>
|
||
<li>Extension</li>
|
||
<li>Provider</li>
|
||
<li>Taskserv</li>
|
||
<li>KCL</li>
|
||
<li>Schema</li>
|
||
<li>Template</li>
|
||
<li>Plugin</li>
|
||
</ol>
|
||
<p><strong>Operations</strong>:</p>
|
||
<ol>
|
||
<li>Workflow</li>
|
||
<li>Orchestrator</li>
|
||
<li>Monitoring</li>
|
||
<li>Troubleshooting</li>
|
||
<li>Security</li>
|
||
<li>Compliance</li>
|
||
</ol>
|
||
<hr />
|
||
<h2 id="terminology-guidelines"><a class="header" href="#terminology-guidelines">Terminology Guidelines</a></h2>
|
||
<h3 id="writing-style"><a class="header" href="#writing-style">Writing Style</a></h3>
|
||
<p><strong>Consistency</strong>: Use the same term throughout documentation (e.g., “Taskserv” not “task service” or “task-serv”)</p>
|
||
<p><strong>Capitalization</strong>:</p>
|
||
<ul>
|
||
<li>Proper nouns and acronyms: CAPITALIZE (KCL, JWT, MFA)</li>
|
||
<li>Generic terms: lowercase (server, cluster, workflow)</li>
|
||
<li>Platform-specific terms: Title Case (Taskserv, Workspace, Orchestrator)</li>
|
||
</ul>
|
||
<p><strong>Pluralization</strong>:</p>
|
||
<ul>
|
||
<li>Taskservs (not taskservices)</li>
|
||
<li>Workspaces (standard plural)</li>
|
||
<li>Topologies (not topologys)</li>
|
||
</ul>
|
||
<h3 id="avoiding-confusion"><a class="header" href="#avoiding-confusion">Avoiding Confusion</a></h3>
|
||
<div class="table-wrapper"><table><thead><tr><th>Don’t Say</th><th>Say Instead</th><th>Reason</th></tr></thead><tbody>
|
||
<tr><td>“Task service”</td><td>“Taskserv”</td><td>Standard platform term</td></tr>
|
||
<tr><td>“Configuration file”</td><td>“Config” or “Settings”</td><td>Context-dependent</td></tr>
|
||
<tr><td>“Worker”</td><td>“Agent” or “Task”</td><td>Clarify context</td></tr>
|
||
<tr><td>“Kubernetes service”</td><td>“K8s taskserv” or “K8s Service resource”</td><td>Disambiguate</td></tr>
|
||
</tbody></table>
|
||
</div>
|
||
<hr />
|
||
<h2 id="contributing-to-the-glossary"><a class="header" href="#contributing-to-the-glossary">Contributing to the Glossary</a></h2>
|
||
<h3 id="adding-new-terms"><a class="header" href="#adding-new-terms">Adding New Terms</a></h3>
|
||
<ol>
|
||
<li>
|
||
<p>Alphabetical placement in appropriate section</p>
|
||
</li>
|
||
<li>
|
||
<p>Include all standard sections:</p>
|
||
<ul>
|
||
<li>Definition</li>
|
||
<li>Where Used</li>
|
||
<li>Related Concepts</li>
|
||
<li>Examples (if applicable)</li>
|
||
<li>Commands (if applicable)</li>
|
||
<li>See Also (links to docs)</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Cross-reference in related terms</p>
|
||
</li>
|
||
<li>
|
||
<p>Update Symbol and Acronym Index if applicable</p>
|
||
</li>
|
||
<li>
|
||
<p>Update Cross-Reference Map</p>
|
||
</li>
|
||
</ol>
|
||
<h3 id="updating-existing-terms"><a class="header" href="#updating-existing-terms">Updating Existing Terms</a></h3>
|
||
<ol>
|
||
<li>Verify changes don’t break cross-references</li>
|
||
<li>Update “Last Updated” date at top</li>
|
||
<li>Increment version if major changes</li>
|
||
<li>Review related terms for consistency</li>
|
||
</ol>
|
||
<hr />
|
||
<h2 id="version-history"><a class="header" href="#version-history">Version History</a></h2>
|
||
<div class="table-wrapper"><table><thead><tr><th>Version</th><th>Date</th><th>Changes</th></tr></thead><tbody>
|
||
<tr><td>1.0.0</td><td>2025-10-10</td><td>Initial comprehensive glossary</td></tr>
|
||
</tbody></table>
|
||
</div>
|
||
<hr />
|
||
<p><strong>Maintained By</strong>: Documentation Team
|
||
<strong>Review Cycle</strong>: Quarterly or when major features are added
|
||
<strong>Feedback</strong>: Please report missing or unclear terms via issues</p>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="index.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="quickstart/01-prerequisites.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="index.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="quickstart/01-prerequisites.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>
|