diff --git a/.gitignore b/.gitignore index a7def72..4c510ad 100644 --- a/.gitignore +++ b/.gitignore @@ -1,63 +1,69 @@ -CLAUDE.md -.claude -utils/save*sh -COMMIT_MESSAGE.md -wrks -nushell -nushell-* -*.tar.gz -#*-nushell-plugins.tar.gz -github-com -.coder -target -distribution -.qodo -# enviroment to load on bin/build +# Claude Code session files (NOT configuration) +.coder/ + +# Working directory (experiments, archives) +.wrks/ + +# Build artifacts +target/ +distribution/ + +# Cargo lock (keep for binaries, ignore for libraries) +# Cargo.lock is currently tracked - keep as is + +# SBOM files (generated, not committed) +*.sbom.json +*.sbom.xml +*.cyclonedx.json +*.spdx.json +*.bom.json + +# Environment files .env -# OSX trash +.envrc + +# OS-specific .DS_Store +*.pyc -# Vscode files -.vscode - -# Emacs save files +# Editor files - Emacs *~ \#*\# .\#* -# Vim-related files +# Editor files - Vim [._]*.s[a-w][a-z] [._]s[a-w][a-z] *.un~ Session.vim .netrwhist -# cscope-related files +# Editor files - VSCode +.vscode/ + +# Editor files - Tags cscope.* - -# User cluster configs -.kubeconfig - .tags* -# direnv .envrc files -.envrc +# Development tools +.qodo/ +.kubeconfig -# make-related metadata +# CI/CD metadata /.make/ -# Just in time generated data in the source, should never be committed +# Test data /test/e2e/generated/bindata.go -# This file used by some vendor repos (e.g. github.com/go-openapi/...) to store secret variables and should not be ignored +# Vendor workspace +/Godeps/_workspace +/bazel-* + +# Generated patches +vendordiff.patch + +# Drone secret file (exception - DO NOT ignore) !\.drone\.sec -# Godeps workspace -/Godeps/_workspace - -/bazel-* -*.pyc - -# generated by verify-vendor.sh -vendordiff.patch +# Claude local settings only .claude/settings.local.json diff --git a/README.md b/README.md index 90613cb..7603f88 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # SecretumVault
- SecretumVault Logo + SecretumVault Logo
**Post-quantum cryptographic secrets vault for modern infrastructure** @@ -62,25 +62,25 @@ git clone https://github.com/secretumvault/secretumvault.git cd secretumvault # Build and start -docker build -t secretumvault:latest . -docker-compose up -d +docker build -t secretumvault:latest -f deploy/docker/Dockerfile . +docker-compose -f deploy/docker/docker-compose.yml up -d # Verify curl http://localhost:8200/v1/sys/health # View logs -docker-compose logs -f vault +docker-compose -f deploy/docker/docker-compose.yml logs -f vault ``` ### Kubernetes Deployment ```bash # Deploy to cluster -kubectl apply -f k8s/01-namespace.yaml -kubectl apply -f k8s/02-configmap.yaml -kubectl apply -f k8s/03-deployment.yaml -kubectl apply -f k8s/04-service.yaml -kubectl apply -f k8s/05-etcd.yaml +kubectl apply -f deploy/k8s/01-namespace.yaml +kubectl apply -f deploy/k8s/02-configmap.yaml +kubectl apply -f deploy/k8s/03-deployment.yaml +kubectl apply -f deploy/k8s/04-service.yaml +kubectl apply -f deploy/k8s/05-etcd.yaml # Port-forward and access kubectl -n secretumvault port-forward svc/vault 8200:8200 @@ -91,12 +91,12 @@ curl http://localhost:8200/v1/sys/health ```bash # Install with default configuration -helm install vault helm/ \ +helm install vault deploy/helm/ \ --namespace secretumvault \ --create-namespace # Customize backends and engines -helm install vault helm/ \ +helm install vault deploy/helm/ \ --namespace secretumvault \ --create-namespace \ --set vault.config.storageBackend=postgresql \ @@ -371,7 +371,7 @@ Full API reference: `docs/API.md` ### Docker ```bash -docker build -t secretumvault:latest . +docker build -t secretumvault:latest -f deploy/docker/Dockerfile . docker run -p 8200:8200 \ -v /etc/secretumvault:/etc/secretumvault:ro \ secretumvault:latest @@ -380,7 +380,7 @@ docker run -p 8200:8200 \ ### Docker Compose ```bash -docker-compose up -d +docker-compose -f deploy/docker/docker-compose.yml up -d ``` Includes: vault, etcd, surrealdb, postgres, prometheus, grafana @@ -461,10 +461,13 @@ secretumvault/ │ │ └── router.rs # Request routing to engines │ ├── telemetry.rs # Metrics, logging, audit │ └── lib.rs # Library exports -├── Dockerfile # Multi-stage container build -├── docker-compose.yml # Complete dev environment -├── docker/config/ # Docker configuration files -├── k8s/ # Kubernetes manifests +├── deploy/ # Deployment configurations +│ ├── docker/ # Docker deployment +│ │ ├── Dockerfile # Multi-stage container build +│ │ ├── docker-compose.yml # Complete dev environment +│ │ └── config/ # Docker-specific config +│ ├── helm/ # Helm charts for Kubernetes +│ └── k8s/ # Raw Kubernetes manifests │ ├── 01-namespace.yaml │ ├── 02-configmap.yaml │ ├── 03-deployment.yaml diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 0000000..3db53b1 --- /dev/null +++ b/assets/README.md @@ -0,0 +1,13 @@ +# SecretumVault Assets + +Brand assets, logos, icons, and visual identity. + +## Structure + +- **logos/** - SecretumVault logos in various formats and sizes +- **icons/** - Application icons and favicon +- **branding/** - Brand guidelines, showcase, and identity resources + +## Usage + +All assets are SVG format (vector) for scalability. See `branding/brand-guidelines.md` for usage guidelines. diff --git a/imgs/README.md b/assets/branding/README.md similarity index 100% rename from imgs/README.md rename to assets/branding/README.md diff --git a/imgs/BRAND-GUIDELINES.md b/assets/branding/brand-guidelines.md similarity index 95% rename from imgs/BRAND-GUIDELINES.md rename to assets/branding/brand-guidelines.md index fe6fa40..43fe87c 100644 --- a/imgs/BRAND-GUIDELINES.md +++ b/assets/branding/brand-guidelines.md @@ -254,7 +254,7 @@ font-family: 'Space Grotesk', sans-serif; ```html
- SecretumVault
@@ -263,14 +263,14 @@ font-family: 'Space Grotesk', sans-serif; ### Favicon ```html - + ``` ### Documentation Header ```html
- SecretumVault
@@ -280,7 +280,7 @@ font-family: 'Space Grotesk', sans-serif; ```html @@ -290,7 +290,7 @@ font-family: 'Space Grotesk', sans-serif; ```html
- SecretumVault Logo
@@ -300,7 +300,7 @@ font-family: 'Space Grotesk', sans-serif; ```html
- SecretumVault
@@ -411,7 +411,10 @@ All branding assets are located in the project: ``` secretumvault/ -├── imgs/ +├── assets/ +│ ├── logos/ +│ ├── icons/ +│ └── branding/ │ ├── secretumvault-logo.svg (animated vertical) │ ├── secretumvault-logo-s.svg (static vertical) │ ├── secretumvault-logo-h.svg (animated horizontal) @@ -430,10 +433,10 @@ secretumvault/ ## Interactive Asset Gallery -An interactive gallery with dark/light mode toggle, copy-to-clipboard functionality, and detailed specifications is available in `imgs/index.html`. This gallery displays all logo variants, color palettes, typography samples, and scalability tests. +An interactive gallery with dark/light mode toggle, copy-to-clipboard functionality, and detailed specifications is available in `assets/branding/index.html`. This gallery displays all logo variants, color palettes, typography samples, and scalability tests. To view the gallery: -1. Open `imgs/index.html` in a web browser +1. Open `assets/branding/index.html` in a web browser 2. Toggle between dark and light modes 3. Click color codes to copy to clipboard 4. View logos at different sizes and devices @@ -451,7 +454,7 @@ To view the gallery: ## Questions & Support For branding questions or asset requests, refer to: -- Interactive Asset Gallery: `imgs/index.html` +- Interactive Asset Gallery: `assets/branding/index.html` - Project Architecture: `docs/secretumvault-complete-architecture.md` - Asset Gallery: Open in browser for dark/light mode toggles and copy-to-clipboard functionality diff --git a/imgs/index.html b/assets/branding/index.html similarity index 100% rename from imgs/index.html rename to assets/branding/index.html diff --git a/imgs/secretumvault_ascii.txt b/assets/branding/secretumvault-ascii.txt similarity index 100% rename from imgs/secretumvault_ascii.txt rename to assets/branding/secretumvault-ascii.txt diff --git a/imgs/secretumvault-assets-showcase.html b/assets/branding/secretumvault-assets-showcase.html similarity index 100% rename from imgs/secretumvault-assets-showcase.html rename to assets/branding/secretumvault-assets-showcase.html diff --git a/imgs/secretumvault-assets-showcase.html.backup b/assets/branding/secretumvault-assets-showcase.html.backup similarity index 100% rename from imgs/secretumvault-assets-showcase.html.backup rename to assets/branding/secretumvault-assets-showcase.html.backup diff --git a/imgs/favicon.svg b/assets/icons/favicon.svg similarity index 100% rename from imgs/favicon.svg rename to assets/icons/favicon.svg diff --git a/imgs/secretumvault-icon-bn.svg b/assets/icons/secretumvault-icon-bn.svg similarity index 100% rename from imgs/secretumvault-icon-bn.svg rename to assets/icons/secretumvault-icon-bn.svg diff --git a/imgs/secretumvault-icon-s.svg b/assets/icons/secretumvault-icon-s.svg similarity index 100% rename from imgs/secretumvault-icon-s.svg rename to assets/icons/secretumvault-icon-s.svg diff --git a/imgs/secretumvault-icon.svg b/assets/icons/secretumvault-icon.svg similarity index 100% rename from imgs/secretumvault-icon.svg rename to assets/icons/secretumvault-icon.svg diff --git a/imgs/logo.svg b/assets/logos/logo.svg similarity index 100% rename from imgs/logo.svg rename to assets/logos/logo.svg diff --git a/imgs/secretumvault-logo-bn.svg b/assets/logos/secretumvault-logo-bn.svg similarity index 100% rename from imgs/secretumvault-logo-bn.svg rename to assets/logos/secretumvault-logo-bn.svg diff --git a/imgs/secretumvault-logo-h-s.svg b/assets/logos/secretumvault-logo-h-s.svg similarity index 100% rename from imgs/secretumvault-logo-h-s.svg rename to assets/logos/secretumvault-logo-h-s.svg diff --git a/imgs/secretumvault-logo-h.svg b/assets/logos/secretumvault-logo-h.svg similarity index 100% rename from imgs/secretumvault-logo-h.svg rename to assets/logos/secretumvault-logo-h.svg diff --git a/imgs/secretumvault-logo-s.svg b/assets/logos/secretumvault-logo-s.svg similarity index 100% rename from imgs/secretumvault-logo-s.svg rename to assets/logos/secretumvault-logo-s.svg diff --git a/imgs/secretumvault-logo.svg b/assets/logos/secretumvault-logo.svg similarity index 100% rename from imgs/secretumvault-logo.svg rename to assets/logos/secretumvault-logo.svg diff --git a/imgs/secretumvault-quantum-vault.svg b/assets/logos/secretumvault-quantum-vault.svg similarity index 100% rename from imgs/secretumvault-quantum-vault.svg rename to assets/logos/secretumvault-quantum-vault.svg diff --git a/svault.toml.example b/config/svault.toml.example similarity index 100% rename from svault.toml.example rename to config/svault.toml.example diff --git a/Dockerfile b/deploy/docker/Dockerfile similarity index 100% rename from Dockerfile rename to deploy/docker/Dockerfile diff --git a/docker/config/prometheus.yml b/deploy/docker/config/prometheus.yml similarity index 100% rename from docker/config/prometheus.yml rename to deploy/docker/config/prometheus.yml diff --git a/docker/config/svault.toml b/deploy/docker/config/svault.toml similarity index 100% rename from docker/config/svault.toml rename to deploy/docker/config/svault.toml diff --git a/docker-compose.yml b/deploy/docker/docker-compose.yml similarity index 100% rename from docker-compose.yml rename to deploy/docker/docker-compose.yml diff --git a/helm/Chart.yaml b/deploy/helm/Chart.yaml similarity index 100% rename from helm/Chart.yaml rename to deploy/helm/Chart.yaml diff --git a/helm/templates/_helpers.tpl b/deploy/helm/templates/_helpers.tpl similarity index 100% rename from helm/templates/_helpers.tpl rename to deploy/helm/templates/_helpers.tpl diff --git a/helm/templates/configmap.yaml b/deploy/helm/templates/configmap.yaml similarity index 100% rename from helm/templates/configmap.yaml rename to deploy/helm/templates/configmap.yaml diff --git a/helm/templates/deployment.yaml b/deploy/helm/templates/deployment.yaml similarity index 100% rename from helm/templates/deployment.yaml rename to deploy/helm/templates/deployment.yaml diff --git a/helm/templates/rbac.yaml b/deploy/helm/templates/rbac.yaml similarity index 100% rename from helm/templates/rbac.yaml rename to deploy/helm/templates/rbac.yaml diff --git a/helm/templates/service.yaml b/deploy/helm/templates/service.yaml similarity index 100% rename from helm/templates/service.yaml rename to deploy/helm/templates/service.yaml diff --git a/helm/values.yaml b/deploy/helm/values.yaml similarity index 100% rename from helm/values.yaml rename to deploy/helm/values.yaml diff --git a/k8s/01-namespace.yaml b/deploy/k8s/01-namespace.yaml similarity index 100% rename from k8s/01-namespace.yaml rename to deploy/k8s/01-namespace.yaml diff --git a/k8s/02-configmap.yaml b/deploy/k8s/02-configmap.yaml similarity index 100% rename from k8s/02-configmap.yaml rename to deploy/k8s/02-configmap.yaml diff --git a/k8s/03-deployment.yaml b/deploy/k8s/03-deployment.yaml similarity index 100% rename from k8s/03-deployment.yaml rename to deploy/k8s/03-deployment.yaml diff --git a/k8s/04-service.yaml b/deploy/k8s/04-service.yaml similarity index 100% rename from k8s/04-service.yaml rename to deploy/k8s/04-service.yaml diff --git a/k8s/05-etcd.yaml b/deploy/k8s/05-etcd.yaml similarity index 100% rename from k8s/05-etcd.yaml rename to deploy/k8s/05-etcd.yaml diff --git a/k8s/06-surrealdb.yaml b/deploy/k8s/06-surrealdb.yaml similarity index 100% rename from k8s/06-surrealdb.yaml rename to deploy/k8s/06-surrealdb.yaml diff --git a/k8s/07-postgresql.yaml b/deploy/k8s/07-postgresql.yaml similarity index 100% rename from k8s/07-postgresql.yaml rename to deploy/k8s/07-postgresql.yaml diff --git a/docs/BRAND-GUIDELINES.md b/docs/BRAND-GUIDELINES.md deleted file mode 100644 index 583b022..0000000 --- a/docs/BRAND-GUIDELINES.md +++ /dev/null @@ -1,462 +0,0 @@ -
- SecretumVault Logo -
- -# SecretumVault Branding Guidelines - -## Overview - -SecretumVault is a post-quantum cryptographic secrets management system designed for modern cloud infrastructure. The brand identity reflects security, innovation, and technical sophistication through a cohesive visual system combining vault imagery with quantum-inspired elements. This guide covers logo systems, color palettes, typography, usage guidelines, and practical integration examples. - ---- - -## Logo System - -### Available Logo Variants - -SecretumVault provides multiple logo variants to accommodate different use cases and layouts: - -| Variant | File | ViewBox | Best For | Features | -|---------|------|---------|----------|----------| -| **Vertical Animated** | `secretumvault-logo.svg` | 200×280 px | Hero sections, interactive displays | Rotating orbits, pulsing core | -| **Vertical Static** | `secretumvault-logo-s.svg` | 200×280 px | Print, documentation, static layouts | No animations, full color | -| **Horizontal Animated** | `secretumvault-logo-h.svg` | 400×120 px | Navigation bars, headers | Rotating orbits, space-efficient | -| **Horizontal Static** | `secretumvault-logo-h-s.svg` | 400×120 px | Print headers, static layouts | No animations, horizontal format | -| **Animated Icon** | `secretumvault-icon.svg` | 200×200 px | App icons, favicons, UI elements | Full animations, square format | -| **Static Icon** | `secretumvault-icon-s.svg` | 200×200 px | Favicon, print, badges | No animations, square format | -| **B&W Logo** | `secretumvault-logo-bn.svg` | 200×200 px | Print (grayscale), restricted color | Single color, monochrome | -| **B&W Icon** | `secretumvault-icon-bn.svg` | 200×200 px | Print, B&W documents | Single color, monochrome | - -### Logo Composition - -The vault icon consists of: - -- **Outer Ring (Dashed):** Cyan glow with rotating animation (20s cycle) -- **Inner Circle:** Gradient fill (deep vault → primary → secondary) -- **Central Node:** Quantum cyan core with pulsing effect (5.2px → 6.5px → 5.2px, 2s cycle) -- **Orbital Electrons:** Four cyan dots rotating around the core (8s clockwise) -- **Secondary Orbit:** Four purple dots at diagonal positions (12s counterclockwise) -- **Vault Handle:** Gold-accented bar and circular ring overlay -- **Text:** "SecretumVault" in Space Grotesk Bold, Quantum Cyan (#00D9FF) - -### Sizing & Clear Space - -**Minimum Sizes:** -- **Logo (full):** 120px wide minimum -- **Icon only:** 32px minimum -- **Favicon:** 16px or 32px - -**Clear Space:** -Maintain clear space around the logo equal to half the logo height on all sides. For a 120px logo, maintain 60px clear space on all sides. - ---- - -## Icon System - -### Icon Scalability - -Icons maintain clarity and recognizability across all sizes: - -| Size | Use Case | -|------|----------| -| 16px | Favicon, small UI elements | -| 24px | Toolbar icons, small badges | -| 32px | Standard app icons, navigation | -| 48px | Medium app icons, avatar sizes | -| 64px | Large app icons, decorative elements | -| 128px | Application splash screens | -| 256px | High-resolution favicons | -| 512px | Marketing, high-DPI displays | - -### When to Use Each Variant - -**Full Logo (`secretumvault-logo.svg`, `secretumvault-logo-s.svg`)** -- Hero sections and landing pages -- Marketing materials and presentations -- Documentation headers -- Standalone brand applications - -**Horizontal Logo (`secretumvault-logo-h.svg`)** -- Header/navbar branding -- Horizontal banner designs -- Social media headers -- Documentation breadcrumbs -- Minimum width: 240px - -**Icon Only (`secretumvault-icon.svg`, `secretumvault-icon-s.svg`)** -- UI navigation and buttons -- Favicons and application icons -- Small badges and labels -- Quick reference elements -- Available at all standard icon sizes - ---- - -## Color Palette - -### Primary Colors - -| Name | Hex | RGB | Use | -|------|-----|-----|-----| -| Deep Vault | #0a1929 | rgb(10, 25, 41) | Background, dark areas | -| Primary | #1a2744 | rgb(26, 39, 68) | Main logo fill, primary UI | -| Secondary | #2a3f6a | rgb(42, 63, 106) | Secondary fills, gradients | -| Quantum Cyan | #00d9ff | rgb(0, 217, 255) | Accents, highlights, text | - -### Accent Colors - -| Name | Hex | RGB | Use | -|------|-----|-----|-----| -| Gold Accent | #ffd700 | rgb(255, 215, 0) | Vault handle, emphasis | -| Purple Accent | #8b5cf6 | rgb(139, 92, 246) | Secondary orbit, decorative | - -### Color Usage Guidelines - -- **Quantum Cyan (#00D9FF):** Primary interactive elements, links, highlights -- **Gold (#ffd700):** Call-to-action buttons, important features -- **Purple (#8b5cf6):** Secondary information, decorative elements -- **Primary Blue (#1a2744):** Logo fill, main backgrounds -- **Secondary Blue (#2a3f6a):** Gradients, borders, secondary backgrounds - -### Background Compatibility - -**Dark Backgrounds** ✅ -- Quantum Deep: #0A1929 -- Quantum Blue: #1A2744 -- Black: #000000 - -Use: `secretumvault-logo.svg`, `secretumvault-logo-bn.svg`, or `secretumvault-icon.svg` - -**Light Backgrounds** ✅ -- White: #FFFFFF -- Off-white: #F5F5F5 -- Light gray: #E8E8E8 - -Use: `secretumvault-logo-s.svg` or `secretumvault-logo-bn.svg` - -**Avoid** ❌ -- Patterned backgrounds -- Complex images -- Colors with insufficient contrast - -### Accessibility - -- Maintain sufficient contrast for text (WCAG AA minimum 4.5:1 for regular text) -- Avoid color-only differentiation; use patterns or text labels -- Test color combinations with color-blind friendly tools - ---- - -## Typography - -### Primary Typeface: Space Grotesk - -- **Font Family:** Space Grotesk -- **Category:** Sans Serif -- **Weights:** 400 (Regular), 600 (Semi-Bold), 700 (Bold) -- **Source:** Google Fonts -- **License:** Open Source (Open Font License) - -#### Google Fonts Import - -```html - -``` - -#### CSS Usage - -```css -font-family: 'Space Grotesk', sans-serif; -``` - -### Typography Hierarchy - -| Element | Font | Weight | Size | Use | -|---------|------|--------|------|-----| -| Logo Text | Space Grotesk | 700 | 32-48px | Logo wordmark | -| Heading 1 | Space Grotesk | 700 | 3rem | Page titles | -| Heading 2 | Space Grotesk | 700 | 1.8rem | Section headers | -| Heading 3 | Space Grotesk | 600 | 1.2rem | Subsection headers | -| Body Text | System Sans | 400 | 1rem | Documentation, content | -| Code | Monospace | 400 | 0.85-0.9rem | Code blocks | - -### Logo Text Color - -- **Light Mode:** #1A2744 (Deep Primary) -- **Dark Mode:** #00D9FF (Quantum Cyan) - ---- - -## Animation Guidelines - -### When to Use Animated Logos - -- Hero sections with user attention -- Loading indicators -- Interactive UI elements -- Marketing videos -- Promotional materials - -### When to Use Static Logos - -- Navigation bars -- Footers -- Print materials -- Emails -- Documents -- Favicons -- Small UI elements - -### Animated Logo Specifications - -| Animation | Duration | Direction | Range/Loop | -|-----------|----------|-----------|-----------| -| Outer Ring Rotation | 20s | Clockwise | 0° → 360°, infinite | -| Central Core Pulsing | 2s | - | 5.2px → 6.5px → 5.2px, infinite | -| Orbital Electrons | 8s | Clockwise | 360° rotation, infinite | -| Secondary Orbit | 12s | Counterclockwise | 360° rotation, infinite | - ---- - -## Usage Guidelines - -### DO ✓ - -- Use complete logos with proper text and icon -- Maintain clear space around logos (20px minimum) -- Use appropriate variant for the medium (animated for web, static for print) -- Scale logos proportionally -- Use provided SVG files for vector graphics -- Apply logos on contrasting backgrounds for visibility -- Use recommended color combinations -- Test logos across different screen sizes and devices -- Use descriptive alt text: `alt="SecretumVault logo"` or `alt="Vault security icon"` - -### DON'T ✗ - -- Distort or skew the logo (non-proportional scaling) -- Change logo colors without explicit approval -- Add effects (shadows, glows) beyond original design -- Rotate logos at unusual angles -- Use logo on cluttered backgrounds -- Mix animated and static versions together -- Rasterize SVGs without maintaining resolution -- Remove or modify individual logo elements -- Use logo without adequate clear space -- Apply logos too small (below minimum size) -- Use vague alt text: `alt="logo.svg"` or `alt="image"` - ---- - -## Integration Examples - -### Web Header - -```html -
- SecretumVault -
-``` - -### Favicon - -```html - -``` - -### Documentation Header - -```html -
- SecretumVault -
-``` - -### UI Navigation - -```html - -``` - -### Hero Section (Animated) - -```html -
- SecretumVault Logo -
-``` - -### Static Background with Logo - -```html -
- SecretumVault -
-``` - ---- - -## File Formats - -### Primary Format: SVG - -All official logos are provided as Scalable Vector Graphics (SVG): - -**Advantages:** -- Resolution-independent scaling -- Animated elements support -- Reduced file size -- Full browser support - -**Usage:** Web, digital displays, high-quality print output - -### Export Guidelines for Other Formats - -If exporting to raster formats (PNG, JPG): - -- **PNG:** Recommended for web (supports transparency) - - Minimum 2x resolution for Retina displays - - Optimize with tools like TinyPNG or ImageOptim -- **PDF:** For print distribution (maintains vector quality) -- **JPG:** Not recommended (no transparency, quality loss) - -### Export Settings - -When exporting from SVG: - -- **Minimum DPI:** 300 for print -- **Color Space:** sRGB for web, CMYK for commercial print -- **Transparency:** Preserve alpha channel for PNG -- **Optimization:** Remove metadata, optimize paths - ---- - -## Social Media Specifications - -| Platform | Format | Recommended Size | Logo Variant | -|----------|--------|------------------|--------------| -| Twitter | Square | 400×400px | Icon or Vertical | -| LinkedIn | Square | 400×400px | Icon or Vertical | -| GitHub | Square | 200×200px | Icon | -| Facebook | Square | 1200×1200px | Icon or Vertical | -| Email Signature | Horizontal | 400×120px | Horizontal Static | - ---- - -## Print Implementation - -- Use `secretumvault-logo-s.svg` (static version) -- Export to PDF for best print quality -- Ensure minimum size of 1 inch (25.4mm) -- Verify color accuracy with print vendor -- Use CMYK color profile for commercial printing -- Maintain clear space in print layouts - -### Export for Print - -If exporting SVG to raster for print: -- Minimum 300 DPI -- Maintain aspect ratio -- Use PNG with transparency or PDF -- Recommended tools: Inkscape, Adobe Illustrator, or online converters - ---- - -## Design System Integration - -### Quantum Vault Visual Language - -The SecretumVault logo employs a quantum theme that reflects the post-quantum cryptography foundation: - -- **Vault Imagery:** Security and protection -- **Circular Orbital Pattern:** Quantum mechanics and atomic structure -- **Rotating Elements:** Continuous motion and dynamism -- **Cyan Accent:** Innovation and cutting-edge technology -- **Gold Accents:** Value and trust - -### Design Token Usage - -```css -/* Color Tokens */ ---sv-primary: #1a2744; ---sv-secondary: #2a3f6a; ---sv-cyan: #00d9ff; ---sv-gold: #ffd700; ---sv-purple: #8b5cf6; - -/* Typography Tokens */ ---font-primary: 'Space Grotesk', sans-serif; ---font-weight-regular: 400; ---font-weight-semi-bold: 600; ---font-weight-bold: 700; -``` - ---- - -## Asset Locations - -All branding assets are located in the project: - -``` -secretumvault/ -├── imgs/ -│ ├── secretumvault-logo.svg (animated vertical) -│ ├── secretumvault-logo-s.svg (static vertical) -│ ├── secretumvault-logo-h.svg (animated horizontal) -│ ├── secretumvault-logo-h-s.svg (static horizontal) -│ ├── secretumvault-icon.svg (animated icon) -│ ├── secretumvault-icon-s.svg (static icon) -│ ├── secretumvault-logo-bn.svg (B&W logo) -│ ├── secretumvault-icon-bn.svg (B&W icon) -│ ├── index.html (interactive asset gallery) -│ └── BRAND-GUIDELINES.md (this file) -└── docs/ - └── BRAND-GUIDELINES.md (comprehensive documentation) -``` - ---- - -## Interactive Asset Gallery - -An interactive gallery with dark/light mode toggle, copy-to-clipboard functionality, and detailed specifications is available in `imgs/index.html`. This gallery displays all logo variants, color palettes, typography samples, and scalability tests. - -To view the gallery: -1. Open `imgs/index.html` in a web browser -2. Toggle between dark and light modes -3. Click color codes to copy to clipboard -4. View logos at different sizes and devices - ---- - -## Version History - -| Version | Date | Changes | -|---------|------|---------| -| 1.0 | 2025-12-22 | Initial brand guidelines consolidating logo systems, color palettes, typography, usage guidelines, integration examples, and practical implementation guidance | - ---- - -## Questions & Support - -For branding questions or asset requests, refer to: -- Interactive Asset Gallery: `imgs/index.html` -- Project Architecture: `docs/secretumvault-complete-architecture.md` -- Asset Gallery: Open in browser for dark/light mode toggles and copy-to-clipboard functionality - ---- - -**SecretumVault** — Post-quantum cryptographic secrets management for modern infrastructure - -Made with ❤️ • Built in Rust diff --git a/docs/README.md b/docs/README.md index dc6c309..ee200cf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,7 @@ # SecretumVault Documentation
- SecretumVault Logo + SecretumVault Logo
Complete documentation for SecretumVault secrets management system. @@ -9,19 +9,19 @@ Complete documentation for SecretumVault secrets management system. ## Documentation Index ### Getting Started -- **[Architecture](ARCHITECTURE.md)** - System design, components, and data flow -- **[How-To Guide](HOWOTO.md)** - Step-by-step instructions for common tasks -- **[Configuration](CONFIGURATION.md)** - Complete configuration reference and options -- **[Features Control](FEATURES_CONTROL.md)** - Build features and Justfile recipes +- **[Architecture](architecture/overview.md)** - System design, components, and data flow +- **[How-To Guide](user-guide/howto.md)** - Step-by-step instructions for common tasks +- **[Configuration](user-guide/configuration.md)** - Complete configuration reference and options +- **[Features Control](development/features-control.md)** - Build features and Justfile recipes ### Operations & Development -- **[Deployment Guide](../DEPLOYMENT.md)** - Docker, Kubernetes, and Helm deployment +- **[Deployment Guide](operations/deployment.md)** - Docker, Kubernetes, and Helm deployment - **[API Reference](API.md)** - HTTP API endpoints and request/response formats - **[Security Guidelines](SECURITY.md)** - Security best practices and hardening ### Build & Features -- **[Build Features](BUILD_FEATURES.md)** - Cargo features, compilation options, dependencies -- **[Post-Quantum Cryptography](PQC_SUPPORT.md)** - PQC algorithms, backend support, configuration +- **[Build Features](development/build-features.md)** - Cargo features, compilation options, dependencies +- **[Post-Quantum Cryptography](development/pqc-support.md)** - PQC algorithms, backend support, configuration - **[Development Guide](DEVELOPMENT.md)** - Building, testing, and contributing --- @@ -31,31 +31,31 @@ Complete documentation for SecretumVault secrets management system. ### I want to... **Deploy SecretumVault** -→ Start with [Deployment Guide](../DEPLOYMENT.md) +→ Start with [Deployment Guide](operations/deployment.md) **Understand the architecture** -→ Read [Architecture](ARCHITECTURE.md) +→ Read [Architecture](architecture/overview.md) **Configure vault for my environment** -→ See [Configuration](CONFIGURATION.md) +→ See [Configuration](user-guide/configuration.md) **Use the REST API** → Check [API Reference](API.md) **Set up authentication and policies** -→ Follow [How-To: Setup Authorization](HOWOTO.md#setup-authorization) +→ Follow [How-To: Setup Authorization](user-guide/howto.md#setup-authorization) **Integrate with Kubernetes** -→ See [How-To: Kubernetes Integration](HOWOTO.md#integrate-with-kubernetes) +→ See [How-To: Kubernetes Integration](user-guide/howto.md#integrate-with-kubernetes) **Enable post-quantum cryptography** -→ Read [PQC Support Guide](PQC_SUPPORT.md), [Configuration: Crypto Backends](CONFIGURATION.md#crypto-backends), or [Build Features: PQC](BUILD_FEATURES.md#post-quantum-cryptography) +→ Read [PQC Support Guide](development/pqc-support.md), [Configuration: Crypto Backends](user-guide/configuration.md#crypto-backends), or [Build Features: PQC](development/build-features.md#post-quantum-cryptography) **Rotate secrets automatically** -→ Check [How-To: Secret Rotation](HOWOTO.md#secret-rotation) +→ Check [How-To: Secret Rotation](user-guide/howto.md#secret-rotation) **Set up monitoring** -→ See [How-To: Monitoring](HOWOTO.md#monitor--troubleshoot) +→ See [How-To: Monitoring](user-guide/howto.md#monitor--troubleshoot) **Contribute code** → Read [Development Guide](DEVELOPMENT.md) @@ -67,17 +67,25 @@ Complete documentation for SecretumVault secrets management system. ``` docs/ ├── README.md # This file -├── ARCHITECTURE.md # System architecture and design -├── CONFIGURATION.md # Configuration reference -├── HOWOTO.md # Step-by-step how-to guides -├── API.md # REST API reference -├── BUILD_FEATURES.md # Cargo features and build options -├── PQC_SUPPORT.md # Post-quantum cryptography support -├── DEVELOPMENT.md # Development and contribution guide -├── SECURITY.md # Security guidelines and best practices +├── index.md # mdBook introduction +├── user-guide/ +│ ├── README.md +│ ├── configuration.md # Configuration reference +│ └── howto.md # Step-by-step how-to guides +├── architecture/ +│ ├── README.md +│ ├── overview.md # System architecture and design +│ └── complete-architecture.md # Detailed architecture reference +├── operations/ +│ ├── README.md +│ └── deployment.md # Deployment guide +└── development/ + ├── README.md + ├── build-features.md # Cargo features and build options + ├── features-control.md # Feature control and Justfile recipes + └── pqc-support.md # Post-quantum cryptography support └── ../ ├── README.md # Main overview - ├── DEPLOYMENT.md # Deployment guide (Docker, K8s, Helm) └── Cargo.toml # Rust manifest with all dependencies ``` @@ -295,10 +303,10 @@ See [How-To: Troubleshooting](HOWOTO.md#monitor--troubleshoot) for detailed guid ## Next Steps -1. **New to SecretumVault?** → Read [Architecture](ARCHITECTURE.md) -2. **Want to deploy?** → Follow [Deployment Guide](../DEPLOYMENT.md) -3. **Ready to use?** → Start with [How-To Guides](HOWOTO.md) -4. **Need to configure?** → Check [Configuration Reference](CONFIGURATION.md) +1. **New to SecretumVault?** → Read [Architecture](architecture/overview.md) +2. **Want to deploy?** → Follow [Deployment Guide](operations/deployment.md) +3. **Ready to use?** → Start with [How-To Guides](user-guide/howto.md) +4. **Need to configure?** → Check [Configuration Reference](user-guide/configuration.md) 5. **Building a feature?** → See [Development Guide](DEVELOPMENT.md) --- diff --git a/docs/architecture/README.md b/docs/architecture/README.md new file mode 100644 index 0000000..9ff1cb9 --- /dev/null +++ b/docs/architecture/README.md @@ -0,0 +1,14 @@ +# Architecture Documentation + +System design, components, and architectural decisions. + +## Contents + +- **[Architecture Overview](overview.md)** - High-level system design and components +- **[Complete Architecture](complete-architecture.md)** - Detailed architecture reference document + +## Quick Links + +- [Back to Documentation Index](../README.md) +- [User Guide](../user-guide/) +- [Development Guide](../development/) diff --git a/docs/secretumvault-complete-architecture.md b/docs/architecture/complete-architecture.md similarity index 99% rename from docs/secretumvault-complete-architecture.md rename to docs/architecture/complete-architecture.md index 5a5de41..e24cc95 100644 --- a/docs/secretumvault-complete-architecture.md +++ b/docs/architecture/complete-architecture.md @@ -1136,7 +1136,8 @@ prometheus_port = 9090 secretumvault/ ├── Cargo.toml ├── README.md -├── svault.toml.example +├── config/ +│ └── svault.toml.example │ ├── src/ │ ├── lib.rs diff --git a/docs/ARCHITECTURE.md b/docs/architecture/overview.md similarity index 100% rename from docs/ARCHITECTURE.md rename to docs/architecture/overview.md diff --git a/docs/development/README.md b/docs/development/README.md new file mode 100644 index 0000000..73fe972 --- /dev/null +++ b/docs/development/README.md @@ -0,0 +1,15 @@ +# Development Documentation + +Documentation for developers building and extending SecretumVault. + +## Contents + +- **[Build Features](build-features.md)** - Cargo features, compilation options, dependencies +- **[Features Control](features-control.md)** - Build features and Justfile recipes +- **[Post-Quantum Cryptography](pqc-support.md)** - PQC algorithms, backend support, configuration + +## Quick Links + +- [Back to Documentation Index](../README.md) +- [Architecture](../architecture/) +- [User Guide](../user-guide/) diff --git a/docs/BUILD_FEATURES.md b/docs/development/build-features.md similarity index 100% rename from docs/BUILD_FEATURES.md rename to docs/development/build-features.md diff --git a/docs/FEATURES_CONTROL.md b/docs/development/features-control.md similarity index 100% rename from docs/FEATURES_CONTROL.md rename to docs/development/features-control.md diff --git a/docs/PQC_SUPPORT.md b/docs/development/pqc-support.md similarity index 100% rename from docs/PQC_SUPPORT.md rename to docs/development/pqc-support.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..bd94413 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,20 @@ +# SecretumVault Documentation + +Welcome to the SecretumVault documentation. + +SecretumVault is a post-quantum cryptographic secrets vault for modern infrastructure, combining: +- Post-quantum cryptography (ML-KEM-768, ML-DSA-65) with classical crypto +- Multiple secrets engines (KV, Transit, Dynamic, PKI) +- Cedar policy-based authorization (attribute-based access control) +- Flexible storage backends (SurrealDB, filesystem, etcd, PostgreSQL) + +## Documentation Sections + +- **[User Guide](user-guide/)** - Installation, configuration, and how-to guides +- **[Architecture](architecture/)** - System design and architectural decisions +- **[Operations](operations/)** - Deployment and operational procedures +- **[Development](development/)** - Build features, development guide, and PQC support + +--- + +For a complete index, see [README.md](README.md). diff --git a/docs/operations/README.md b/docs/operations/README.md new file mode 100644 index 0000000..6f68823 --- /dev/null +++ b/docs/operations/README.md @@ -0,0 +1,13 @@ +# Operations Guide + +Documentation for operators deploying and maintaining SecretumVault in production. + +## Contents + +- **[Deployment](deployment.md)** - Docker, Kubernetes, Helm deployment guides + +## Quick Links + +- [Back to Documentation Index](../README.md) +- [User Guide](../user-guide/) +- [Architecture](../architecture/) diff --git a/DEPLOYMENT.md b/docs/operations/deployment.md similarity index 91% rename from DEPLOYMENT.md rename to docs/operations/deployment.md index bea68d0..6c19e0c 100644 --- a/DEPLOYMENT.md +++ b/docs/operations/deployment.md @@ -4,7 +4,7 @@ This guide covers deployment of SecretumVault using Docker, Docker Compose, Kube ## Table of Contents -1. [Local Development with Docker Compose](#local-development-with-docker-compose) +1. [Local Development with Docker Compose](#local-development-with-docker-compose -f deploy/docker/docker-compose.yml) 2. [Kubernetes Deployment](#kubernetes-deployment) 3. [Helm Installation](#helm-installation) 4. [Configuration](#configuration) @@ -25,21 +25,21 @@ This guide covers deployment of SecretumVault using Docker, Docker Compose, Kube ```bash # Build the vault image -docker build -t secretumvault:latest . +docker build -t secretumvault:latest -f deploy/docker/Dockerfile . # Start all services -docker-compose up -d +docker-compose -f deploy/docker/docker-compose.yml up -d # Verify services are running -docker-compose ps +docker-compose -f deploy/docker/docker-compose.yml ps # View logs -docker-compose logs -f vault +docker-compose -f deploy/docker/docker-compose.yml logs -f vault ``` ### Services Included -The docker-compose.yml includes: +The docker-compose -f deploy/docker/docker-compose.yml.yml includes: - **vault**: SecretumVault server (port 8200 API, 9090 metrics) - **etcd**: Distributed key-value store for secrets (port 2379) @@ -64,17 +64,17 @@ Configuration is mounted from `docker/config/svault.toml`. Modify this file to: curl http://localhost:8200/v1/sys/health # Check etcd health -docker-compose exec etcd etcdctl --endpoints=http://localhost:2379 endpoint health +docker-compose -f deploy/docker/docker-compose.yml exec etcd etcdctl --endpoints=http://localhost:2379 endpoint health ``` ### Cleanup ```bash # Stop all services -docker-compose down +docker-compose -f deploy/docker/docker-compose.yml down # Remove volumes (WARNING: deletes all data) -docker-compose down -v +docker-compose -f deploy/docker/docker-compose.yml down -v ``` ## Kubernetes Deployment @@ -90,15 +90,15 @@ docker-compose down -v ```bash # Deploy to 'secretumvault' namespace -kubectl apply -f k8s/01-namespace.yaml -kubectl apply -f k8s/02-configmap.yaml -kubectl apply -f k8s/03-deployment.yaml -kubectl apply -f k8s/04-service.yaml -kubectl apply -f k8s/05-etcd.yaml +kubectl apply -f deploy/k8s/01-namespace.yaml +kubectl apply -f deploy/k8s/02-configmap.yaml +kubectl apply -f deploy/k8s/03-deployment.yaml +kubectl apply -f deploy/k8s/04-service.yaml +kubectl apply -f deploy/k8s/05-etcd.yaml # Optional: Additional storage backends -kubectl apply -f k8s/06-surrealdb.yaml -kubectl apply -f k8s/07-postgresql.yaml +kubectl apply -f deploy/k8s/06-surrealdb.yaml +kubectl apply -f deploy/k8s/07-postgresql.yaml # Verify deployment kubectl -n secretumvault get pods -w @@ -177,12 +177,12 @@ kubectl delete -f k8s/ # helm repo update # Install from local chart -helm install vault helm/ \ +helm install vault deploy/helm/ \ --namespace secretumvault \ --create-namespace # Or with custom values -helm install vault helm/ \ +helm install vault deploy/helm/ \ --namespace secretumvault \ --create-namespace \ --values helm/custom-values.yaml @@ -207,22 +207,22 @@ Customize deployment via values overrides: ```bash # Enable SurrealDB backend -helm install vault helm/ -n secretumvault --create-namespace \ +helm install vault deploy/helm/ -n secretumvault --create-namespace \ --set vault.config.storageBackend=surrealdb \ --set surrealdb.enabled=true # Enable PostgreSQL for dynamic secrets -helm install vault helm/ -n secretumvault --create-namespace \ +helm install vault deploy/helm/ -n secretumvault --create-namespace \ --set postgresql.enabled=true \ --set vault.config.engines.database=true # Enable monitoring -helm install vault helm/ -n secretumvault --create-namespace \ +helm install vault deploy/helm/ -n secretumvault --create-namespace \ --set monitoring.prometheus.enabled=true \ --set monitoring.grafana.enabled=true # Change vault replicas -helm install vault helm/ -n secretumvault --create-namespace \ +helm install vault deploy/helm/ -n secretumvault --create-namespace \ --set vault.replicas=3 ``` diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md new file mode 100644 index 0000000..f4bf1ec --- /dev/null +++ b/docs/user-guide/README.md @@ -0,0 +1,14 @@ +# User Guide + +Documentation for end users configuring and using SecretumVault. + +## Contents + +- **[Configuration](configuration.md)** - Complete configuration reference and options +- **[How-To Guides](howto.md)** - Step-by-step instructions for common tasks + +## Quick Links + +- [Back to Documentation Index](../README.md) +- [Architecture Documentation](../architecture/) +- [Operations Guide](../operations/) diff --git a/docs/CONFIGURATION.md b/docs/user-guide/configuration.md similarity index 100% rename from docs/CONFIGURATION.md rename to docs/user-guide/configuration.md diff --git a/docs/HOWOTO.md b/docs/user-guide/howto.md similarity index 100% rename from docs/HOWOTO.md rename to docs/user-guide/howto.md