2026-01-08 09:55:37 +00:00
|
|
|
# Provisioning Platform Documentation
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
[Home](README.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
|
|
- [Installation Guide](getting-started/installation-guide.md)
|
|
|
|
|
- [Installation Validation Guide](getting-started/installation-validation-guide.md)
|
|
|
|
|
- [Getting Started](getting-started/getting-started.md)
|
|
|
|
|
- [Quick Start Cheatsheet](getting-started/quickstart-cheatsheet.md)
|
|
|
|
|
- [Setup Quick Start](getting-started/setup-quickstart.md)
|
|
|
|
|
- [Setup System Guide](getting-started/setup-system-guide.md)
|
|
|
|
|
- [Quick Start (Full)](getting-started/quickstart.md)
|
|
|
|
|
- [Prerequisites](getting-started/01-prerequisites.md)
|
|
|
|
|
- [Installation Steps](getting-started/02-installation.md)
|
|
|
|
|
- [First Deployment](getting-started/03-first-deployment.md)
|
|
|
|
|
- [Verification](getting-started/04-verification.md)
|
|
|
|
|
- [Platform Service Configuration](getting-started/05-platform-configuration.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Architecture & Design
|
|
|
|
|
|
|
|
|
|
- [System Overview](architecture/system-overview.md)
|
|
|
|
|
- [Architecture Overview](architecture/architecture-overview.md)
|
|
|
|
|
- [Design Principles](architecture/design-principles.md)
|
|
|
|
|
- [Integration Patterns](architecture/integration-patterns.md)
|
|
|
|
|
- [Orchestrator Integration Model](architecture/orchestrator-integration-model.md)
|
|
|
|
|
- [Multi-Repo Architecture](architecture/multi-repo-architecture.md)
|
|
|
|
|
- [Multi-Repo Strategy](architecture/multi-repo-strategy.md)
|
|
|
|
|
- [Database and Config Architecture](architecture/database-and-config-architecture.md)
|
|
|
|
|
- [Ecosystem Integration](architecture/ecosystem-integration.md)
|
|
|
|
|
- [Package and Loader System](architecture/package-and-loader-system.md)
|
|
|
|
|
- [Nickel Executable Examples](architecture/nickel-executable-examples.md)
|
|
|
|
|
- [Orchestrator Info](architecture/orchestrator_info.md)
|
|
|
|
|
- [Orchestrator Auth Integration](architecture/orchestrator-auth-integration.md)
|
|
|
|
|
- [Repo Dist Analysis](architecture/repo-dist-analysis.md)
|
|
|
|
|
- [TypeDialog Nickel Integration](architecture/typedialog-nickel-integration.md)
|
|
|
|
|
|
|
|
|
|
### Architecture Decision Records
|
|
|
|
|
|
|
|
|
|
- [ADR-001: Project Structure](architecture/adr/ADR-001-project-structure.md)
|
|
|
|
|
- [ADR-002: Distribution Strategy](architecture/adr/ADR-002-distribution-strategy.md)
|
|
|
|
|
- [ADR-003: Workspace Isolation](architecture/adr/ADR-003-workspace-isolation.md)
|
|
|
|
|
- [ADR-004: Hybrid Architecture](architecture/adr/ADR-004-hybrid-architecture.md)
|
|
|
|
|
- [ADR-005: Extension Framework](architecture/adr/ADR-005-extension-framework.md)
|
|
|
|
|
- [ADR-006: Provisioning CLI Refactoring](architecture/adr/ADR-006-provisioning-cli-refactoring.md)
|
|
|
|
|
- [ADR-007: KMS Simplification](architecture/adr/ADR-007-kms-simplification.md)
|
|
|
|
|
- [ADR-008: Cedar Authorization](architecture/adr/ADR-008-cedar-authorization.md)
|
|
|
|
|
- [ADR-009: Security System Complete](architecture/adr/ADR-009-security-system-complete.md)
|
|
|
|
|
- [ADR-010: Configuration Format Strategy](architecture/adr/ADR-010-configuration-format-strategy.md)
|
|
|
|
|
- [ADR-011: Nickel Migration](architecture/adr/ADR-011-nickel-migration.md)
|
|
|
|
|
- [ADR-012: Nushell Nickel Plugin CLI Wrapper](architecture/adr/adr-012-nushell-nickel-plugin-cli-wrapper.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## API Reference
|
|
|
|
|
|
|
|
|
|
- [REST API](api-reference/rest-api.md)
|
|
|
|
|
- [WebSocket](api-reference/websocket.md)
|
|
|
|
|
- [Extensions](api-reference/extensions.md)
|
|
|
|
|
- [SDKs](api-reference/sdks.md)
|
|
|
|
|
- [Integration Examples](api-reference/integration-examples.md)
|
|
|
|
|
- [Provider API](api-reference/provider-api.md)
|
|
|
|
|
- [NuShell API](api-reference/nushell-api.md)
|
|
|
|
|
- [Path Resolution](api-reference/path-resolution.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## Development
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Extension Development](development/extension-development.md)
|
|
|
|
|
- [Infrastructure-Specific Extensions](development/infrastructure-specific-extensions.md)
|
|
|
|
|
- [Quick Provider Guide](development/quick-provider-guide.md)
|
|
|
|
|
- [Command Handler Guide](development/command-handler-guide.md)
|
|
|
|
|
- [Configuration](development/configuration.md)
|
|
|
|
|
- [Workflow](development/workflow.md)
|
|
|
|
|
- [Integration](development/integration.md)
|
|
|
|
|
- [Build System](development/build-system.md)
|
|
|
|
|
- [Extensions](development/extensions.md)
|
|
|
|
|
- [Distribution Process](development/distribution-process.md)
|
|
|
|
|
- [Implementation Guide](development/implementation-guide.md)
|
|
|
|
|
- [TaskServ Developer Guide](development/taskserv-developer-guide.md)
|
|
|
|
|
- [TaskServ Quick Guide](development/taskserv-quick-guide.md)
|
|
|
|
|
- [Project Structure](development/project-structure.md)
|
|
|
|
|
- [Provider Agnostic Architecture](development/provider-agnostic-architecture.md)
|
|
|
|
|
- [Ctrl-C Implementation Notes](development/ctrl-c-implementation-notes.md)
|
|
|
|
|
- [Auth Metadata Guide](development/auth-metadata-guide.md)
|
|
|
|
|
- [Migration Guide](development/migration-guide.md)
|
|
|
|
|
- [KMS Simplification](development/kms-simplification.md)
|
|
|
|
|
- [Migration Example](development/migration-example.md)
|
|
|
|
|
- [Glossary](development/glossary.md)
|
|
|
|
|
- [Provider Distribution Guide](development/provider-distribution-guide.md)
|
|
|
|
|
- [TaskServ Categorization](development/taskserv-categorization.md)
|
|
|
|
|
- [Extension Registry](development/extension-registry.md)
|
|
|
|
|
- [MCP Server](development/mcp-server.md)
|
|
|
|
|
- [TypeDialog Platform Config Guide](development/typedialog-platform-config-guide.md)
|
|
|
|
|
- [Provider Comparison Matrix](development/provider-comparison.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Operations
|
|
|
|
|
|
|
|
|
|
- [Platform Deployment Guide](operations/deployment-guide.md)
|
|
|
|
|
- [Service Management Guide](operations/service-management-guide.md)
|
|
|
|
|
- [Monitoring & Alerting Setup](operations/monitoring-alerting-setup.md)
|
|
|
|
|
- [Service Management Quick Reference](operations/service-management-quickref.md)
|
|
|
|
|
- [CoreDNS Guide](operations/coredns-guide.md)
|
|
|
|
|
- [Backup Recovery](operations/backup-recovery.md)
|
|
|
|
|
- [Deployment](operations/deployment.md)
|
|
|
|
|
- [Monitoring](operations/monitoring.md)
|
|
|
|
|
- [Production Readiness Checklist](operations/production-readiness-checklist.md)
|
|
|
|
|
- [Break Glass Training Guide](operations/break-glass-training-guide.md)
|
|
|
|
|
- [Cedar Policies Production Guide](operations/cedar-policies-production-guide.md)
|
|
|
|
|
- [MFA Admin Setup Guide](operations/mfa-admin-setup-guide.md)
|
|
|
|
|
- [Orchestrator](operations/orchestrator.md)
|
|
|
|
|
- [Orchestrator System](operations/orchestrator-system.md)
|
|
|
|
|
- [Control Center](operations/control-center.md)
|
|
|
|
|
- [Installer](operations/installer.md)
|
|
|
|
|
- [Installer System](operations/installer-system.md)
|
|
|
|
|
- [Provisioning Server](operations/provisioning-server.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## Infrastructure
|
|
|
|
|
|
|
|
|
|
- [Infrastructure Management](infrastructure/infrastructure-management.md)
|
|
|
|
|
- [Infrastructure from Code Guide](infrastructure/infrastructure-from-code-guide.md)
|
|
|
|
|
- [Batch Workflow System](infrastructure/batch-workflow-system.md)
|
|
|
|
|
- [Batch Workflow Multi-Provider Examples](infrastructure/batch-workflow-multi-provider.md)
|
|
|
|
|
- [CLI Architecture](infrastructure/cli-architecture.md)
|
|
|
|
|
- [Configuration System](infrastructure/configuration-system.md)
|
|
|
|
|
- [Workspace Setup](infrastructure/workspace-setup.md)
|
|
|
|
|
- [Workspace Switching Guide](infrastructure/workspace-switching-guide.md)
|
|
|
|
|
- [Workspace Switching System](infrastructure/workspace-switching-system.md)
|
|
|
|
|
- [CLI Reference](infrastructure/cli-reference.md)
|
|
|
|
|
- [Workspace Config Architecture](infrastructure/workspace-config-architecture.md)
|
|
|
|
|
- [Dynamic Secrets Guide](infrastructure/dynamic-secrets-guide.md)
|
|
|
|
|
- [Mode System Guide](infrastructure/mode-system-guide.md)
|
|
|
|
|
- [Workspace Guide](infrastructure/workspace-guide.md)
|
|
|
|
|
- [Workspace Enforcement Guide](infrastructure/workspace-enforcement-guide.md)
|
|
|
|
|
- [Workspace Infra Reference](infrastructure/workspace-infra-reference.md)
|
|
|
|
|
- [Workspace Config Commands](infrastructure/workspace-config-commands.md)
|
|
|
|
|
- [Config Rendering Guide](infrastructure/config-rendering-guide.md)
|
|
|
|
|
- [Configuration](infrastructure/configuration.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Security
|
|
|
|
|
|
|
|
|
|
- [Authentication Layer Guide](security/authentication-layer-guide.md)
|
|
|
|
|
- [Config Encryption Guide](security/config-encryption-guide.md)
|
|
|
|
|
- [Security System](security/security-system.md)
|
|
|
|
|
- [RustyVault KMS Guide](security/rustyvault-kms-guide.md)
|
|
|
|
|
- [SecretumVault KMS Guide](security/secretumvault-kms-guide.md)
|
|
|
|
|
- [SSH Temporal Keys User Guide](security/ssh-temporal-keys-user-guide.md)
|
|
|
|
|
- [Plugin Integration Guide](security/plugin-integration-guide.md)
|
|
|
|
|
- [NuShell Plugins Guide](security/nushell-plugins-guide.md)
|
|
|
|
|
- [NuShell Plugins System](security/nushell-plugins-system.md)
|
|
|
|
|
- [Plugin Usage Guide](security/plugin-usage-guide.md)
|
|
|
|
|
- [Secrets Management Guide](security/secrets-management-guide.md)
|
|
|
|
|
- [Auth Quick Reference](security/auth-quick-reference.md)
|
|
|
|
|
- [Config Encryption Quick Reference](security/config-encryption-quickref.md)
|
|
|
|
|
- [KMS Service](security/kms-service.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## Integration
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Gitea Integration Guide](integration/gitea-integration-guide.md)
|
|
|
|
|
- [Service Mesh Ingress Guide](integration/service-mesh-ingress-guide.md)
|
|
|
|
|
- [OCI Registry Guide](integration/oci-registry-guide.md)
|
|
|
|
|
- [Integrations Quick Start](integration/integrations-quickstart.md)
|
|
|
|
|
- [Secrets Service Layer Complete](integration/secrets-service-layer-complete.md)
|
|
|
|
|
- [OCI Registry Platform](integration/oci-registry-platform.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## Testing
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Test Environment Guide](testing/test-environment-guide.md)
|
|
|
|
|
- [Test Environment Usage](testing/test-environment-usage.md)
|
|
|
|
|
- [Test Environment System](testing/test-environment-system.md)
|
|
|
|
|
- [TaskServ Validation Guide](testing/taskserv-validation-guide.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
---
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## Troubleshooting
|
|
|
|
|
|
|
|
|
|
- [Troubleshooting Guide](troubleshooting/troubleshooting-guide.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## Deployment Guides
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [From Scratch](guides/from-scratch.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
- [Update Infrastructure](guides/update-infrastructure.md)
|
|
|
|
|
- [Customize Infrastructure](guides/customize-infrastructure.md)
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Infrastructure Setup](guides/infrastructure-setup.md)
|
|
|
|
|
- [Extension Development Quickstart](guides/extension-development-quickstart.md)
|
|
|
|
|
- [Guide System](guides/guide-system.md)
|
|
|
|
|
- [Workspace Generation Quick Reference](guides/workspace-generation-quick-reference.md)
|
|
|
|
|
- [Workspace Documentation Migration](guides/workspace-documentation-migration.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
### Multi-Provider Deployment Guides
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Multi-Provider Deployment Guide](guides/multi-provider-deployment.md)
|
|
|
|
|
- [Multi-Provider Networking with VPN](guides/multi-provider-networking.md)
|
|
|
|
|
- [DigitalOcean Provider Guide](guides/provider-digitalocean.md)
|
|
|
|
|
- [Hetzner Provider Guide](guides/provider-hetzner.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
### Multi-Provider Workspace Examples
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Multi-Provider Web App Workspace](../examples/workspaces/multi-provider-web-app/README.md)
|
|
|
|
|
- DigitalOcean (compute) + AWS (database) + Hetzner (storage)
|
|
|
|
|
- Cost: ~$165/month
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Multi-Region High Availability Workspace](../examples/workspaces/multi-region-ha/README.md)
|
|
|
|
|
- Global deployment across 3 providers (US, EU, APAC)
|
|
|
|
|
- 99.99% uptime with automatic failover
|
|
|
|
|
- Cost: ~$311/month
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Cost-Optimized Multi-Provider Workspace](../examples/workspaces/cost-optimized/README.md)
|
|
|
|
|
- Hetzner (compute) + AWS (managed services) + DigitalOcean (CDN)
|
|
|
|
|
- 53% cost savings vs all-AWS
|
|
|
|
|
- Cost: ~$280/month
|
2025-12-11 21:50:42 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## Quick Reference
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Master Index](quick-reference/master.md)
|
|
|
|
|
- [Platform Operations Cheatsheet](quick-reference/platform-operations-cheatsheet.md)
|
|
|
|
|
- [General Commands](quick-reference/general.md)
|
|
|
|
|
- [JustFile Recipes](quick-reference/justfile-recipes.md)
|
|
|
|
|
- [OCI Registry](quick-reference/oci.md)
|
|
|
|
|
- [Sudo Password Handling](quick-reference/sudo-password-handling.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
## Configuration
|
2025-12-11 21:50:42 +00:00
|
|
|
|
2026-01-08 09:55:37 +00:00
|
|
|
- [Config Validation](configuration/config-validation.md)
|
2025-12-11 21:50:42 +00:00
|
|
|
- [Workspace Config Architecture](configuration/workspace-config-architecture.md)
|
