Compare commits
No commits in common. "2227e891223f3940f0191ab3773a04b0d9b23bbd" and "cc55b97678e18632a9316ed6571caafa4226fcc3" have entirely different histories.
2227e89122
...
cc55b97678
8
.github/ci_cd_checklist.md
vendored
8
.github/ci_cd_checklist.md
vendored
@ -23,9 +23,9 @@
|
|||||||
- [ ] Test with `git push origin main` to docs/
|
- [ ] Test with `git push origin main` to docs/
|
||||||
|
|
||||||
### Documentation Files Created
|
### Documentation Files Created
|
||||||
- [x] `docs/mdbook-setup.md` — mdBook setup guide
|
- [x] `docs/MDBOOK_SETUP.md` — mdBook setup guide
|
||||||
- [x] `docs/github-actions-setup.md` — Complete workflow documentation
|
- [x] `docs/GITHUB_ACTIONS_SETUP.md` — Complete workflow documentation
|
||||||
- [x] `docs/deployment-guide.md` — Deployment procedures
|
- [x] `docs/DEPLOYMENT_GUIDE.md` — Deployment procedures
|
||||||
- [x] `.github/WORKFLOWS.md` — Quick reference for developers
|
- [x] `.github/WORKFLOWS.md` — Quick reference for developers
|
||||||
|
|
||||||
## 🚀 Initial Deployment Test
|
## 🚀 Initial Deployment Test
|
||||||
@ -114,7 +114,7 @@ git push origin main
|
|||||||
### Team Notification
|
### Team Notification
|
||||||
- [ ] Announce workflows to team
|
- [ ] Announce workflows to team
|
||||||
- [ ] Share `.github/WORKFLOWS.md` quick reference
|
- [ ] Share `.github/WORKFLOWS.md` quick reference
|
||||||
- [ ] Point to `docs/deployment-guide.md` for deployment info
|
- [ ] Point to `docs/DEPLOYMENT_GUIDE.md` for deployment info
|
||||||
- [ ] Schedule documentation training if needed
|
- [ ] Schedule documentation training if needed
|
||||||
|
|
||||||
## 🔄 Operational Procedures
|
## 🔄 Operational Procedures
|
||||||
|
|||||||
2
.github/workflows.md
vendored
2
.github/workflows.md
vendored
@ -236,7 +236,7 @@ All pass → ✅ Build successful
|
|||||||
---
|
---
|
||||||
|
|
||||||
For detailed configuration, see:
|
For detailed configuration, see:
|
||||||
- `docs/github-actions-setup.md`
|
- `docs/GITHUB_ACTIONS_SETUP.md`
|
||||||
- `.github/workflows/mdbook-build-deploy.yml`
|
- `.github/workflows/mdbook-build-deploy.yml`
|
||||||
- `.github/workflows/docs-lint.yml`
|
- `.github/workflows/docs-lint.yml`
|
||||||
- `.github/workflows/mdbook-publish.yml`
|
- `.github/workflows/mdbook-publish.yml`
|
||||||
|
|||||||
@ -51,7 +51,7 @@ aws iam create-access-key --user-name vapora-docs-deployer
|
|||||||
# 2. Create S3 bucket
|
# 2. Create S3 bucket
|
||||||
aws s3 mb s3://vapora-docs --region us-east-1
|
aws s3 mb s3://vapora-docs --region us-east-1
|
||||||
|
|
||||||
# 3. Attach policy (copy from docs/custom-deployment-server.md)
|
# 3. Attach policy (copy from docs/CUSTOM_DEPLOYMENT_SERVER.md)
|
||||||
|
|
||||||
# 4. Add GitHub secrets
|
# 4. Add GitHub secrets
|
||||||
# DOCS_DEPLOY_METHOD = s3
|
# DOCS_DEPLOY_METHOD = s3
|
||||||
@ -271,7 +271,7 @@ sudo tail -f /var/log/nginx/error.log
|
|||||||
|
|
||||||
## Need Help?
|
## Need Help?
|
||||||
|
|
||||||
- Full guide: See `docs/custom-deployment-server.md`
|
- Full guide: See `docs/CUSTOM_DEPLOYMENT_SERVER.md`
|
||||||
- Workflow reference: See `.github/WORKFLOWS.md`
|
- Workflow reference: See `.github/WORKFLOWS.md`
|
||||||
- Deployment script: `.scripts/deploy-docs.sh`
|
- Deployment script: `.scripts/deploy-docs.sh`
|
||||||
- GitHub Secrets: Repository → Settings → Secrets and variables → Actions
|
- GitHub Secrets: Repository → Settings → Secrets and variables → Actions
|
||||||
|
|||||||
@ -261,6 +261,7 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_workflow_instance_response_conversion() {
|
fn test_workflow_instance_response_conversion() {
|
||||||
|
use chrono::Utc;
|
||||||
use vapora_workflow_engine::config::{StageConfig, WorkflowConfig};
|
use vapora_workflow_engine::config::{StageConfig, WorkflowConfig};
|
||||||
|
|
||||||
let config = WorkflowConfig {
|
let config = WorkflowConfig {
|
||||||
|
|||||||
@ -15,8 +15,7 @@ crate-type = ["rlib"]
|
|||||||
vapora-shared = { workspace = true }
|
vapora-shared = { workspace = true }
|
||||||
|
|
||||||
# Embeddings
|
# Embeddings
|
||||||
# Note: Update STRATUM_EMBEDDINGS_PATH environment variable or adjust path relative to your workspace
|
stratum-embeddings = { path = "/Users/Akasha/Development/stratumiops/crates/stratum-embeddings", features = ["vapora"] }
|
||||||
stratum-embeddings = { path = "../../../stratumiops/crates/stratum-embeddings", features = ["vapora"] }
|
|
||||||
|
|
||||||
# Secrets management
|
# Secrets management
|
||||||
secretumvault = { workspace = true }
|
secretumvault = { workspace = true }
|
||||||
|
|||||||
@ -146,7 +146,7 @@ pub struct TrackingEntry {
|
|||||||
|
|
||||||
1. **Start tracking service**:
|
1. **Start tracking service**:
|
||||||
```bash
|
```bash
|
||||||
# From repository root
|
cd /Users/Akasha/Development/vapora
|
||||||
cargo run -p vapora-backend -- --enable-tracking
|
cargo run -p vapora-backend -- --enable-tracking
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@ -18,7 +18,8 @@ All Dockerfiles are located here and reference the root workspace. Build command
|
|||||||
### Build All Images
|
### Build All Images
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# From repository root
|
cd /Users/Akasha/Development/vapora
|
||||||
|
|
||||||
# Backend
|
# Backend
|
||||||
docker build -f docker/vapora-backend.Dockerfile -t vapora-backend:latest .
|
docker build -f docker/vapora-backend.Dockerfile -t vapora-backend:latest .
|
||||||
|
|
||||||
|
|||||||
@ -27,7 +27,7 @@ Templates for:
|
|||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
**Files**:
|
**Files**:
|
||||||
- ✅ `docs/custom-deployment-server.md` — Complete reference (45+ KB)
|
- ✅ `docs/CUSTOM_DEPLOYMENT_SERVER.md` — Complete reference (45+ KB)
|
||||||
- ✅ `.scripts/DEPLOYMENT_QUICK_START.md` — Quick start guide (5 min setup)
|
- ✅ `.scripts/DEPLOYMENT_QUICK_START.md` — Quick start guide (5 min setup)
|
||||||
|
|
||||||
---
|
---
|
||||||
@ -187,11 +187,11 @@ mdBook Publish & Sync Workflow (triggered)
|
|||||||
└── DEPLOYMENT_QUICK_START.md (Quick guide) ✨ New
|
└── DEPLOYMENT_QUICK_START.md (Quick guide) ✨ New
|
||||||
|
|
||||||
docs/
|
docs/
|
||||||
├── mdbook-setup.md (mdBook guide)
|
├── MDBOOK_SETUP.md (mdBook guide)
|
||||||
├── github-actions-setup.md (Workflow details)
|
├── GITHUB_ACTIONS_SETUP.md (Workflow details)
|
||||||
├── deployment-guide.md (Deployment reference)
|
├── DEPLOYMENT_GUIDE.md (Deployment reference)
|
||||||
├── custom-deployment-server.md (Complete setup) ✨ New
|
├── CUSTOM_DEPLOYMENT_SERVER.md (Complete setup) ✨ New
|
||||||
└── custom-deployment-setup.md (This file) ✨ New
|
└── CUSTOM_DEPLOYMENT_SETUP.md (This file) ✨ New
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@ -434,11 +434,11 @@ bash .scripts/deploy-docs.sh production
|
|||||||
| Topic | Location |
|
| Topic | Location |
|
||||||
|-------|----------|
|
|-------|----------|
|
||||||
| Quick Start | `.scripts/DEPLOYMENT_QUICK_START.md` |
|
| Quick Start | `.scripts/DEPLOYMENT_QUICK_START.md` |
|
||||||
| Full Reference | `docs/custom-deployment-server.md` |
|
| Full Reference | `docs/CUSTOM_DEPLOYMENT_SERVER.md` |
|
||||||
| Workflow Details | `.github/WORKFLOWS.md` |
|
| Workflow Details | `.github/WORKFLOWS.md` |
|
||||||
| Setup Checklist | `.github/CI_CD_CHECKLIST.md` |
|
| Setup Checklist | `.github/CI_CD_CHECKLIST.md` |
|
||||||
| Deployment Script | `.scripts/deploy-docs.sh` |
|
| Deployment Script | `.scripts/deploy-docs.sh` |
|
||||||
| mdBook Guide | `docs/mdbook-setup.md` |
|
| mdBook Guide | `docs/MDBOOK_SETUP.md` |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -451,8 +451,8 @@ bash .scripts/deploy-docs.sh production
|
|||||||
- ✨ `.scripts/.deploy-config.production`
|
- ✨ `.scripts/.deploy-config.production`
|
||||||
- ✨ `.scripts/.deploy-config.staging`
|
- ✨ `.scripts/.deploy-config.staging`
|
||||||
- ✨ `.scripts/DEPLOYMENT_QUICK_START.md`
|
- ✨ `.scripts/DEPLOYMENT_QUICK_START.md`
|
||||||
- ✨ `docs/custom-deployment-server.md` (45+ KB)
|
- ✨ `docs/CUSTOM_DEPLOYMENT_SERVER.md` (45+ KB)
|
||||||
- ✨ `docs/custom-deployment-setup.md` (This file)
|
- ✨ `docs/CUSTOM_DEPLOYMENT_SETUP.md` (This file)
|
||||||
|
|
||||||
**Updated Files**:
|
**Updated Files**:
|
||||||
- ✨ `.github/workflows/mdbook-publish.yml` (Enhanced with deployment integration)
|
- ✨ `.github/workflows/mdbook-publish.yml` (Enhanced with deployment integration)
|
||||||
@ -470,12 +470,12 @@ bash .scripts/deploy-docs.sh production
|
|||||||
4. Test: Push docs/ change (automatic)
|
4. Test: Push docs/ change (automatic)
|
||||||
|
|
||||||
**Intermediate** (Want to understand):
|
**Intermediate** (Want to understand):
|
||||||
1. Read: `docs/github-actions-setup.md` (15 min)
|
1. Read: `docs/GITHUB_ACTIONS_SETUP.md` (15 min)
|
||||||
2. Read: `.github/WORKFLOWS.md` (10 min)
|
2. Read: `.github/WORKFLOWS.md` (10 min)
|
||||||
3. Setup: Full SSH deployment (20 min)
|
3. Setup: Full SSH deployment (20 min)
|
||||||
|
|
||||||
**Advanced** (Want all options):
|
**Advanced** (Want all options):
|
||||||
1. Read: `docs/custom-deployment-server.md` (30 min)
|
1. Read: `docs/CUSTOM_DEPLOYMENT_SERVER.md` (30 min)
|
||||||
2. Study: `.scripts/deploy-docs.sh` (15 min)
|
2. Study: `.scripts/deploy-docs.sh` (15 min)
|
||||||
3. Setup: Multiple deployment targets (60 min)
|
3. Setup: Multiple deployment targets (60 min)
|
||||||
|
|
||||||
@ -488,11 +488,11 @@ bash .scripts/deploy-docs.sh production
|
|||||||
- Check: `.github/WORKFLOWS.md`
|
- Check: `.github/WORKFLOWS.md`
|
||||||
|
|
||||||
**Detailed Setup**:
|
**Detailed Setup**:
|
||||||
- Reference: `docs/custom-deployment-server.md`
|
- Reference: `docs/CUSTOM_DEPLOYMENT_SERVER.md`
|
||||||
- Reference: `docs/deployment-guide.md`
|
- Reference: `docs/DEPLOYMENT_GUIDE.md`
|
||||||
|
|
||||||
**Troubleshooting**:
|
**Troubleshooting**:
|
||||||
- Check: `docs/custom-deployment-server.md` → "Troubleshooting"
|
- Check: `docs/CUSTOM_DEPLOYMENT_SERVER.md` → "Troubleshooting"
|
||||||
- Check: `.github/CI_CD_CHECKLIST.md` → "Troubleshooting Reference"
|
- Check: `.github/CI_CD_CHECKLIST.md` → "Troubleshooting Reference"
|
||||||
|
|
||||||
---
|
---
|
||||||
@ -477,8 +477,8 @@ git push origin main --tags
|
|||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
- `.github/WORKFLOWS.md` — Workflow quick reference
|
- `.github/WORKFLOWS.md` — Workflow quick reference
|
||||||
- `docs/mdbook-setup.md` — mdBook setup guide
|
- `docs/MDBOOK_SETUP.md` — mdBook setup guide
|
||||||
- `docs/github-actions-setup.md` — Full workflow documentation
|
- `docs/GITHUB_ACTIONS_SETUP.md` — Full workflow documentation
|
||||||
- `docs/README.md` — Documentation standards
|
- `docs/README.md` — Documentation standards
|
||||||
|
|
||||||
### External Resources
|
### External Resources
|
||||||
@ -39,7 +39,7 @@ VAPORA documentation is now fully integrated with **mdBook**, a command-line too
|
|||||||
```
|
```
|
||||||
docs/
|
docs/
|
||||||
├── book.toml # mdBook configuration
|
├── book.toml # mdBook configuration
|
||||||
├── mdbook-setup.md # This file
|
├── MDBOOK_SETUP.md # This file
|
||||||
├── README.md # Main docs README (updated with mdBook info)
|
├── README.md # Main docs README (updated with mdBook info)
|
||||||
├── .gitignore # Excludes build artifacts
|
├── .gitignore # Excludes build artifacts
|
||||||
│
|
│
|
||||||
@ -83,7 +83,7 @@ cargo install mdbook
|
|||||||
### Build the documentation
|
### Build the documentation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd docs
|
cd /Users/Akasha/Development/vapora/docs
|
||||||
mdbook build
|
mdbook build
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -92,7 +92,7 @@ Output will be in `docs/book/` directory (7.4 MB).
|
|||||||
### Serve locally for development
|
### Serve locally for development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd docs
|
cd /Users/Akasha/Development/vapora/docs
|
||||||
mdbook serve
|
mdbook serve
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -103,7 +103,7 @@ Changes to markdown files will automatically rebuild the documentation.
|
|||||||
### Clean build output
|
### Clean build output
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd docs
|
cd /Users/Akasha/Development/vapora/docs
|
||||||
mdbook clean
|
mdbook clean
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -307,7 +307,7 @@ jobs:
|
|||||||
**Confirm successful setup:**
|
**Confirm successful setup:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd docs
|
cd /Users/Akasha/Development/vapora/docs
|
||||||
|
|
||||||
# Build test
|
# Build test
|
||||||
mdbook build
|
mdbook build
|
||||||
@ -118,7 +118,7 @@ let gemini_key = client.get_secret("llm/gemini-api-key").await?;
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Terminal 1: Start SecretumVault server
|
# Terminal 1: Start SecretumVault server
|
||||||
cd ../secretumvault # Adjust path to your secretumvault installation
|
cd /Users/Akasha/Development/secretumvault
|
||||||
cargo run --bin secretumvault-server --features server,surrealdb-storage
|
cargo run --bin secretumvault-server --features server,surrealdb-storage
|
||||||
|
|
||||||
# Terminal 2: Initialize with default policies
|
# Terminal 2: Initialize with default policies
|
||||||
|
|||||||
@ -6,7 +6,7 @@ Integration documentation for deploying VAPORA v1.0 using Provisioning.
|
|||||||
|
|
||||||
VAPORA can be deployed using **Provisioning**, a Rust-based infrastructure-as-code platform that manages Kubernetes clusters, services, and workflows.
|
VAPORA can be deployed using **Provisioning**, a Rust-based infrastructure-as-code platform that manages Kubernetes clusters, services, and workflows.
|
||||||
|
|
||||||
The Provisioning workspace is located at: `provisioning/vapora-wrksp/` (relative to repository root)
|
The Provisioning workspace is located at: `/Users/Akasha/Development/vapora/provisioning/vapora-wrksp/`
|
||||||
|
|
||||||
## Provisioning Workspace Structure
|
## Provisioning Workspace Structure
|
||||||
|
|
||||||
@ -218,7 +218,8 @@ provisioning health-check --all
|
|||||||
### Using Vanilla K8s (Manual)
|
### Using Vanilla K8s (Manual)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Use vanilla K8s manifests (from repository root)
|
# Use vanilla K8s manifests
|
||||||
|
cd /Users/Akasha/Development/vapora
|
||||||
nu scripts/deploy-k8s.nu
|
nu scripts/deploy-k8s.nu
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@ -23,7 +23,7 @@ User Input → typedialog Forms → Config Generation → Deployment
|
|||||||
Start with the interactive form to generate customized configuration:
|
Start with the interactive form to generate customized configuration:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd provisioning # From repository root
|
cd /Users/Akasha/Development/vapora/provisioning
|
||||||
|
|
||||||
# Run interactive setup wizard
|
# Run interactive setup wizard
|
||||||
typedialog \
|
typedialog \
|
||||||
|
|||||||
@ -5,7 +5,7 @@
|
|||||||
def main [
|
def main [
|
||||||
--port: int = 3000 # Server port
|
--port: int = 3000 # Server port
|
||||||
--database: string = "sqlite://tracking.db" # Database URL
|
--database: string = "sqlite://tracking.db" # Database URL
|
||||||
--watch-dirs: string = "." # Projects to watch (default: current directory)
|
--watch-dirs: string = "/Users/Akasha/Development" # Projects to watch
|
||||||
--verbose = false
|
--verbose = false
|
||||||
]: void {
|
]: void {
|
||||||
if $verbose {
|
if $verbose {
|
||||||
@ -34,9 +34,7 @@ def main [
|
|||||||
|
|
||||||
# Start the service in background
|
# Start the service in background
|
||||||
# Rule 17: Expression interpolation
|
# Rule 17: Expression interpolation
|
||||||
# Assumes script is run from repository root or VAPORA_ROOT env var is set
|
let command = $"cd /Users/Akasha/Development/vapora && cargo run -p vapora-backend --release -- --tracking-port ($port) --tracking-database ($database)"
|
||||||
let vapora-root = ($env.VAPORA_ROOT? | default $env.PWD)
|
|
||||||
let command = $"cd ($vapora-root) && cargo run -p vapora-backend --release -- --tracking-port ($port) --tracking-database ($database)"
|
|
||||||
|
|
||||||
# Start in background with output redirection
|
# Start in background with output redirection
|
||||||
let result = (
|
let result = (
|
||||||
@ -94,11 +92,9 @@ def validate-environment []: void {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
# Check for Cargo.toml to validate we're in a Rust workspace
|
if not ("/Users/Akasha/Development/vapora" | path exists) {
|
||||||
let vapora-root = ($env.VAPORA_ROOT? | default $env.PWD)
|
|
||||||
if not ($"($vapora-root)/Cargo.toml" | path exists) {
|
|
||||||
error make {
|
error make {
|
||||||
msg: $"❌ Vapora workspace not found. Set VAPORA_ROOT env var or run from repository root. Current: ($vapora-root)"
|
msg: "❌ Vapora directory not found at /Users/Akasha/Development/vapora"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user