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