390 lines
17 KiB
HTML
390 lines
17 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Deployment Quickstart - VAPORA Platform Documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
|
||
|
|
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in 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 = "light";
|
||
|
|
const default_dark_theme = "dark";
|
||
|
|
</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('light')
|
||
|
|
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">VAPORA 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/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../setup/deployment-quickstart.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="vapora-v10---quick-start-deployment"><a class="header" href="#vapora-v10---quick-start-deployment">VAPORA v1.0 - Quick Start Deployment</a></h1>
|
||
|
|
<p><strong>5-Minute Production Deployment Guide</strong></p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="prerequisites-check"><a class="header" href="#prerequisites-check">Prerequisites Check</a></h2>
|
||
|
|
<pre><code class="language-bash"># Verify you have these tools
|
||
|
|
kubectl version --client # Kubernetes CLI
|
||
|
|
docker --version # Docker for building images
|
||
|
|
nu --version # Nushell for scripts
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="step-1-build-docker-images-5-minutes"><a class="header" href="#step-1-build-docker-images-5-minutes">Step 1: Build Docker Images (5 minutes)</a></h2>
|
||
|
|
<pre><code class="language-bash"># From project root
|
||
|
|
|
||
|
|
# Build all images and push to Docker Hub
|
||
|
|
nu scripts/build-docker.nu --registry docker.io --tag v0.1.0 --push
|
||
|
|
|
||
|
|
# Or build locally (no push)
|
||
|
|
nu scripts/build-docker.nu
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Output</strong>: 4 Docker images built (~175MB total)</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="step-2-configure-secrets-2-minutes"><a class="header" href="#step-2-configure-secrets-2-minutes">Step 2: Configure Secrets (2 minutes)</a></h2>
|
||
|
|
<pre><code class="language-bash"># Edit secrets file
|
||
|
|
nano kubernetes/03-secrets.yaml
|
||
|
|
|
||
|
|
# Replace these values:
|
||
|
|
# - jwt-secret: $(openssl rand -base64 32)
|
||
|
|
# - anthropic-api-key: sk-ant-xxxxx
|
||
|
|
# - openai-api-key: sk-xxxxx
|
||
|
|
# - surrealdb-pass: $(openssl rand -base64 32)
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>NEVER commit this file with real secrets!</strong></p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="step-3-configure-ingress-1-minute"><a class="header" href="#step-3-configure-ingress-1-minute">Step 3: Configure Ingress (1 minute)</a></h2>
|
||
|
|
<pre><code class="language-bash"># Edit ingress file
|
||
|
|
nano kubernetes/08-ingress.yaml
|
||
|
|
|
||
|
|
# Update this line:
|
||
|
|
# - host: vapora.yourdomain.com # Change to your domain
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="step-4-deploy-to-kubernetes-3-minutes"><a class="header" href="#step-4-deploy-to-kubernetes-3-minutes">Step 4: Deploy to Kubernetes (3 minutes)</a></h2>
|
||
|
|
<pre><code class="language-bash"># Dry run to validate
|
||
|
|
nu scripts/deploy-k8s.nu --dry-run
|
||
|
|
|
||
|
|
# Deploy for real
|
||
|
|
nu scripts/deploy-k8s.nu
|
||
|
|
|
||
|
|
# Wait for all pods to be ready
|
||
|
|
kubectl wait --for=condition=ready pod -l app -n vapora --timeout=300s
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Output</strong>: 11 pods running (2 backend, 2 frontend, 3 agents, 1 mcp, 1 db, 1 nats)</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="step-5-verify-deployment-2-minutes"><a class="header" href="#step-5-verify-deployment-2-minutes">Step 5: Verify Deployment (2 minutes)</a></h2>
|
||
|
|
<pre><code class="language-bash"># Check all pods are running
|
||
|
|
kubectl get pods -n vapora
|
||
|
|
|
||
|
|
# Check services
|
||
|
|
kubectl get svc -n vapora
|
||
|
|
|
||
|
|
# Get ingress IP/hostname
|
||
|
|
kubectl get ingress -n vapora
|
||
|
|
|
||
|
|
# Test health endpoints
|
||
|
|
kubectl exec -n vapora deploy/vapora-backend -- curl -s http://localhost:8080/health
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="step-6-access-vapora"><a class="header" href="#step-6-access-vapora">Step 6: Access VAPORA</a></h2>
|
||
|
|
<ol>
|
||
|
|
<li><strong>Configure DNS</strong>: Point your domain to ingress IP</li>
|
||
|
|
<li><strong>Access UI</strong>: <code>https://vapora.yourdomain.com</code></li>
|
||
|
|
<li><strong>Check health</strong>: <code>https://vapora.yourdomain.com/api/v1/health</code></li>
|
||
|
|
</ol>
|
||
|
|
<hr />
|
||
|
|
<h2 id="troubleshooting"><a class="header" href="#troubleshooting">Troubleshooting</a></h2>
|
||
|
|
<h3 id="pods-not-starting"><a class="header" href="#pods-not-starting">Pods not starting?</a></h3>
|
||
|
|
<pre><code class="language-bash">kubectl describe pod -n vapora <pod-name>
|
||
|
|
kubectl logs -n vapora <pod-name>
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="cant-connect-to-database"><a class="header" href="#cant-connect-to-database">Can't connect to database?</a></h3>
|
||
|
|
<pre><code class="language-bash">kubectl logs -n vapora surrealdb-0
|
||
|
|
kubectl exec -n vapora deploy/vapora-backend -- curl http://surrealdb:8000/health
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="image-pull-errors"><a class="header" href="#image-pull-errors">Image pull errors?</a></h3>
|
||
|
|
<pre><code class="language-bash"># Check if images exist
|
||
|
|
docker images | grep vapora
|
||
|
|
|
||
|
|
# Create registry secret
|
||
|
|
kubectl create secret docker-registry regcred \
|
||
|
|
-n vapora \
|
||
|
|
--docker-server=docker.io \
|
||
|
|
--docker-username=<user> \
|
||
|
|
--docker-password=<pass>
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="alternative-provisioning-deployment"><a class="header" href="#alternative-provisioning-deployment">Alternative: Provisioning Deployment</a></h2>
|
||
|
|
<p>For advanced deployment with service mesh and auto-scaling:</p>
|
||
|
|
<pre><code class="language-bash">cd provisioning/vapora-wrksp
|
||
|
|
|
||
|
|
# Validate configuration
|
||
|
|
nu scripts/validate-provisioning.nu
|
||
|
|
|
||
|
|
# Deploy full stack
|
||
|
|
provisioning workflow run workflows/deploy-full-stack.yaml
|
||
|
|
</code></pre>
|
||
|
|
<p>See: <a href="provisioning-integration/README.html"><code>provisioning-integration/README.md</code></a></p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="next-steps"><a class="header" href="#next-steps">Next Steps</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Set up monitoring (Prometheus + Grafana)</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Configure TLS certificates (cert-manager)</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Set up backups for SurrealDB</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Configure HPA (Horizontal Pod Autoscaler)</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Enable log aggregation</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Test agent workflows</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="full-documentation"><a class="header" href="#full-documentation">Full Documentation</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Comprehensive Guide</strong>: <a href="DEPLOYMENT.html"><code>DEPLOYMENT.md</code></a></li>
|
||
|
|
<li><strong>K8s README</strong>: <a href="kubernetes/README.html"><code>kubernetes/README.md</code></a></li>
|
||
|
|
<li><strong>Provisioning Guide</strong>: <a href="provisioning-integration/README.html"><code>provisioning-integration/README.md</code></a></li>
|
||
|
|
<li><strong>Project Overview</strong>: <a href="PROJECT_COMPLETION_REPORT.html"><code>PROJECT_COMPLETION_REPORT.md</code></a></li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="quick-commands-reference"><a class="header" href="#quick-commands-reference">Quick Commands Reference</a></h2>
|
||
|
|
<pre><code class="language-bash"># Build images
|
||
|
|
nu scripts/build-docker.nu --push
|
||
|
|
|
||
|
|
# Deploy
|
||
|
|
nu scripts/deploy-k8s.nu
|
||
|
|
|
||
|
|
# Validate
|
||
|
|
nu scripts/validate-deployment.nu
|
||
|
|
|
||
|
|
# Validate Provisioning
|
||
|
|
nu scripts/validate-provisioning.nu
|
||
|
|
|
||
|
|
# Check status
|
||
|
|
kubectl get all -n vapora
|
||
|
|
|
||
|
|
# View logs
|
||
|
|
kubectl logs -n vapora -l app=vapora-backend -f
|
||
|
|
|
||
|
|
# Scale agents
|
||
|
|
kubectl scale deployment vapora-agents -n vapora --replicas=5
|
||
|
|
|
||
|
|
# Rollback
|
||
|
|
kubectl rollout undo deployment/vapora-backend -n vapora
|
||
|
|
|
||
|
|
# Uninstall
|
||
|
|
kubectl delete namespace vapora
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<p><strong>VAPORA v1.0</strong> - Production Ready ✅
|
||
|
|
<strong>Total Deployment Time</strong>: ~15 minutes
|
||
|
|
<strong>Status</strong>: All 5 phases completed</p>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../../setup/deployment.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="../../setup/tracking-setup.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="../../setup/deployment.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="../../setup/tracking-setup.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>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<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>
|