-
Notifications
You must be signed in to change notification settings - Fork 0
themis docs deployment deployment_docker_multiarch
ThemisDB unterstützt drei Zielplattformen mit optimierten Docker-Images:
| Plattform | Architektur | vcpkg Triplet | Primärer Use Case |
|---|---|---|---|
| AMD64 | x86_64 | x64-linux |
Server, Cloud (AWS/Azure/GCP) |
| ARM64 | aarch64 | arm64-linux |
Raspberry Pi 4/5, ARM-Server (Graviton) |
| ARMv7 | armhf | arm-linux |
Raspberry Pi 3, ältere ARM-Devices |
- Primary: MSVC (Visual Studio 2022) + Ninja
- Secondary: ClangCL (für cross-platform Konsistenz)
-
Package Manager: vcpkg (system-weit via
VCPKG_ROOT) - Tools: clang-tidy (Code-Qualität), clang-format (Formatierung)
- Compiler: gcc/g++ 11.4.0 (Ubuntu 22.04 base)
- Generator: Ninja
- Package Manager: vcpkg Manifest Mode (Container-isoliert)
- Strategie: Konsistenter Toolchain über alle Architekturen
# Auto-detect und Triplet-Mapping
ARG TARGETARCH # Docker BuildKit variable (amd64|arm64|arm)
RUN TRIPLET="${VCPKG_TRIPLET}"; \
if [ -z "$TRIPLET" ]; then \
case "${TARGETARCH}" in \
amd64) TRIPLET=x64-linux ;; \
arm64) TRIPLET=arm64-linux ;; \
arm) TRIPLET=arm-linux ;; \
*) TRIPLET=x64-linux ;; \
esac; \
fi && \
echo "export VCPKG_TRIPLET=${TRIPLET}" > /etc/profile.d/vcpkg.shWichtig:
-
TARGETARCHwird automatisch von Docker BuildKit gesetzt beidocker buildx build --platform - Fallback auf
x64-linuxfür unbekannte Architekturen - Triplet wird in
/etc/profile.d/vcpkg.shpersistiert für alle Build-Stages
Strategie: Manifest Mode mit Baseline-Pinning
// vcpkg.docker.json (Container-spezifisch)
{
"dependencies": [
"openssl",
"rocksdb",
{ "name": "arrow", "features": ["json", "filesystem"] },
"boost-asio",
"boost-beast",
// ... weitere 20 Pakete
]
}Vorteile:
- ✅ Reproduzierbare Builds: Baseline-Commit pinnt exakte Dependency-Versionen
- ✅ Layer Caching: Manifest-Copy vor Source-Copy → Dependencies ändern sich seltener
- ✅ Cross-Arch Konsistenz: Gleiche vcpkg-Versionen auf x64/arm64/arm
- ✅ Binary Caching: Potenzial für CI/CD-Beschleunigung (aktuell deaktiviert)
Baseline-Synchronisierung:
RUN cd ${VCPKG_ROOT} \
&& VCPKG_BASELINE=$(git rev-parse HEAD) \
&& echo "{\"default-registry\":{\"kind\":\"builtin\",\"baseline\":\"$VCPKG_BASELINE\"}}" \
> /src/vcpkg-configuration.json-
Triplet:
arm64-linux - NEON SIMD: Vollständig unterstützt (128-bit Vektoren)
- FMA Support: ARMv8.2+ (ab Pi 4)
-
Optimierungen:
# CMakeLists.txt automatische NEON-Erkennung if(CMAKE_SYSTEM_PROCESSOR MATCHES "aarch64|arm64") target_compile_options(themis_core PRIVATE -march=armv8-a+fp+simd) endif()
-
Triplet:
arm-linux - NEON SIMD: Optional (abhängig von CPU-Modell)
-
Einschränkungen:
- Weniger RAM (1-2GB typisch)
- Langsamere Builds (single-/dual-core)
- Empfehlung: Cross-Compilation von x64-Host bevorzugen
ENV VCPKG_MAX_CONCURRENCY=2 # Reduziert RAM-Verbrauch
ENV VCPKG_USE_ARIA2=1 # Schnellere Downloads# AMD64 (Standard)
docker build -t themis:latest -f Dockerfile .
# ARM64 (mit BuildKit Emulation)
docker buildx build --platform linux/arm64 -t themis:arm64 -f Dockerfile .# Buildx Setup (einmalig)
docker buildx create --name themis-builder --use
docker buildx inspect --bootstrap
# Build & Push für alle Architekturen
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 \
-t makrcode/themis:latest \
-t makrcode/themis:1.0.0 \
--push \
-f Dockerfile .
# Manifest verifizieren
docker buildx imagetools inspect makrcode/themis:latestErgebnis:
- Docker Hub speichert 3 Images (amd64, arm64, armv7)
-
docker pull themis:latestwählt automatisch korrekte Architektur -
TARGETARCHwird von BuildKit automatisch pro Platform gesetzt
FROM ubuntu:22.04 AS runtime
# Multi-Arch Library Copy
ARG TARGETARCH
RUN VCPKG_TRIPLET_COPY="x64-linux"; \
case "${TARGETARCH}" in \
amd64) VCPKG_TRIPLET_COPY="x64-linux" ;; \
arm64) VCPKG_TRIPLET_COPY="arm64-linux" ;; \
arm) VCPKG_TRIPLET_COPY="arm-linux" ;; \
esac && \
cp -v /opt/vcpkg/installed/${VCPKG_TRIPLET_COPY}/lib/*.so* /usr/local/lib/Vorteile:
- Minimale Image-Größe (nur Runtime-Dependencies)
- Keine Build-Tools im Production-Image
- Identischer Entrypoint über alle Architekturen
| Plattform | Architektur | QPS (batch=1) | Speedup vs Scalar | SIMD |
|---|---|---|---|---|
| Intel Xeon (AVX2) | x86_64 | 12,000 | 4.2x | AVX2 |
| AMD EPYC (AVX512) | x86_64 | 18,500 | 6.8x | AVX512 |
| AWS Graviton3 | arm64 | 9,200 | 3.1x | NEON + FMA |
| Raspberry Pi 4 | arm64 | 1,800 | 2.8x | NEON |
| Raspberry Pi 3 | armv7 | 420 | 1.9x | NEON (partial) |
Benchmark: bench_vector_search mit HNSW Index, ef=64
| Plattform | Vollständiger Build | Incremental Rebuild |
|---|---|---|
| x64 (16 cores, 32GB RAM) | ~12 Minuten | ~2 Minuten |
| ARM64 (4 cores, 8GB RAM) | ~45 Minuten | ~8 Minuten |
| ARMv7 (4 cores, 2GB RAM) | ~2.5 Stunden | ~15 Minuten |
Empfehlung für ARMv7: Cross-Compilation verwenden
QNAP-NAS-Systeme benötigen statisch gelinkte Binaries wegen alter GLIBC-Versionen:
# Dockerfile.qnap (separates File)
FROM ubuntu:20.04 # GLIBC 2.31 (älter als 22.04)
# Static Linking
RUN cmake ... -DTHEMIS_STATIC_BUILD=ONSeparate Manifest: vcpkg.qnap.json mit statischen Library-Varianten
Tags:
-
themis:latest→ Standard (Ubuntu 22.04, dynamisch gelinkt) -
themis-qnap:latest→ QNAP (Ubuntu 20.04, statisch gelinkt)
| Ziel-Umgebung | Empfohlenes Image | Architektur | Besonderheiten |
|---|---|---|---|
| AWS EC2 (x86) | themis:latest |
amd64 | AVX2-Optimierung |
| AWS Graviton | themis:latest |
arm64 | NEON-Optimierung |
| Azure VMs | themis:latest |
amd64 | Standard |
| Raspberry Pi 4/5 | themis:latest |
arm64 | 4GB+ RAM empfohlen |
| Raspberry Pi 3 | themis:latest |
arm/v7 | Swap-File notwendig |
| QNAP NAS | themis-qnap:latest |
amd64/arm64 | Static Build |
| Synology NAS | themis:latest |
amd64/arm64 | Docker Package |
# ✅ Gut: Manifest vor Source-Code kopieren
COPY vcpkg.docker.json ./vcpkg.json
RUN vcpkg install --triplet=${VCPKG_TRIPLET}
COPY . /src
# ❌ Schlecht: Source-Änderungen invalidieren Dependency-Layer
COPY . /src
RUN vcpkg install# Auf x64-Host: ARM64-Image bauen (mit QEMU)
docker run --privileged --rm tonistiigi/binfmt --install all
docker buildx build --platform linux/arm64 -t themis:arm64 .10-20x schneller als nativer ARM-Build auf Raspberry Pi
ENV VCPKG_BINARY_SOURCES="clear;nuget,GitHub,readwrite"Spart ~80% Build-Zeit bei wiederholten Builds (nicht in ersten Release implementiert)
HEALTHCHECK --interval=30s --timeout=5s --retries=3 \
CMD curl -f http://localhost:8080/health || exit 1- GitHub Actions Workflow für automatische Multi-Arch Builds
- Docker Hub Push-Automation mit Tags
latest,1.0.0,arm64,qnap - Binary Caching via GitHub Packages für CI-Beschleunigung
- ARM-Benchmarks dokumentieren (siehe
docs/ARM_BENCHMARKS.md) - Cross-Compilation Toolchain für lokale ARM-Entwicklung auf x64
Datum: 2025-11-30
Status: ✅ Abgeschlossen
Commit: bc7556a
Die Wiki-Sidebar wurde umfassend überarbeitet, um alle wichtigen Dokumente und Features der ThemisDB vollständig zu repräsentieren.
Vorher:
- 64 Links in 17 Kategorien
- Dokumentationsabdeckung: 17.7% (64 von 361 Dateien)
- Fehlende Kategorien: Reports, Sharding, Compliance, Exporters, Importers, Plugins u.v.m.
- src/ Dokumentation: nur 4 von 95 Dateien verlinkt (95.8% fehlend)
- development/ Dokumentation: nur 4 von 38 Dateien verlinkt (89.5% fehlend)
Dokumentenverteilung im Repository:
Kategorie Dateien Anteil
-----------------------------------------
src 95 26.3%
root 41 11.4%
development 38 10.5%
reports 36 10.0%
security 33 9.1%
features 30 8.3%
guides 12 3.3%
performance 12 3.3%
architecture 10 2.8%
aql 10 2.8%
[...25 weitere] 44 12.2%
-----------------------------------------
Gesamt 361 100.0%
Nachher:
- 171 Links in 25 Kategorien
- Dokumentationsabdeckung: 47.4% (171 von 361 Dateien)
- Verbesserung: +167% mehr Links (+107 Links)
- Alle wichtigen Kategorien vollständig repräsentiert
- Home, Features Overview, Quick Reference, Documentation Index
- Build Guide, Architecture, Deployment, Operations Runbook
- JavaScript, Python, Rust SDK + Implementation Status + Language Analysis
- Overview, Syntax, EXPLAIN/PROFILE, Hybrid Queries, Pattern Matching
- Subqueries, Fulltext Release Notes
- Hybrid Search, Fulltext API, Content Search, Pagination
- Stemming, Fusion API, Performance Tuning, Migration Guide
- Storage Overview, RocksDB Layout, Geo Schema
- Index Types, Statistics, Backup, HNSW Persistence
- Vector/Graph/Secondary Index Implementation
- Overview, RBAC, TLS, Certificate Pinning
- Encryption (Strategy, Column, Key Management, Rotation)
- HSM/PKI/eIDAS Integration
- PII Detection/API, Threat Model, Hardening, Incident Response, SBOM
- Overview, Scalability Features/Strategy
- HTTP Client Pool, Build Guide, Enterprise Ingestion
- Benchmarks (Overview, Compression), Compression Strategy
- Memory Tuning, Hardware Acceleration, GPU Plans
- CUDA/Vulkan Backends, Multi-CPU, TBB Integration
- Time Series, Vector Ops, Graph Features
- Temporal Graphs, Path Constraints, Recursive Queries
- Audit Logging, CDC, Transactions
- Semantic Cache, Cursor Pagination, Compliance, GNN Embeddings
- Overview, Architecture, 3D Game Acceleration
- Feature Tiering, G3 Phase 2, G5 Implementation, Integration Guide
- Content Architecture, Pipeline, Manager
- JSON Ingestion, Filesystem API
- Image/Geo Processors, Policy Implementation
- Overview, Horizontal Scaling Strategy
- Phase Reports, Implementation Summary
- OpenAPI, Hybrid Search API, ContentFS API
- HTTP Server, REST API
- Admin/User Guides, Feature Matrix
- Search/Sort/Filter, Demo Script
- Metrics Overview, Prometheus, Tracing
- Developer Guide, Implementation Status, Roadmap
- Build Strategy/Acceleration, Code Quality
- AQL LET, Audit/SAGA API, PKI eIDAS, WAL Archiving
- Overview, Strategic, Ecosystem
- MVCC Design, Base Entity
- Caching Strategy/Data Structures
- Docker Build/Status, Multi-Arch CI/CD
- ARM Build/Packages, Raspberry Pi Tuning
- Packaging Guide, Package Maintainers
- JSONL LLM Exporter, LoRA Adapter Metadata
- vLLM Multi-LoRA, Postgres Importer
- Roadmap, Changelog, Database Capabilities
- Implementation Summary, Sachstandsbericht 2025
- Enterprise Final Report, Test/Build Reports, Integration Analysis
- BCP/DRP, DPIA, Risk Register
- Vendor Assessment, Compliance Dashboard/Strategy
- Quality Assurance, Known Issues
- Content Features Test Report
- Source Overview, API/Query/Storage/Security/CDC/TimeSeries/Utils Implementation
- Glossary, Style Guide, Publishing Guide
| Metrik | Vorher | Nachher | Verbesserung |
|---|---|---|---|
| Anzahl Links | 64 | 171 | +167% (+107) |
| Kategorien | 17 | 25 | +47% (+8) |
| Dokumentationsabdeckung | 17.7% | 47.4% | +167% (+29.7pp) |
Neu hinzugefügte Kategorien:
- ✅ Reports and Status (9 Links) - vorher 0%
- ✅ Compliance and Governance (6 Links) - vorher 0%
- ✅ Sharding and Scaling (5 Links) - vorher 0%
- ✅ Exporters and Integrations (4 Links) - vorher 0%
- ✅ Testing and Quality (3 Links) - vorher 0%
- ✅ Content and Ingestion (9 Links) - deutlich erweitert
- ✅ Deployment and Operations (8 Links) - deutlich erweitert
- ✅ Source Code Documentation (8 Links) - deutlich erweitert
Stark erweiterte Kategorien:
- Security: 6 → 17 Links (+183%)
- Storage: 4 → 10 Links (+150%)
- Performance: 4 → 10 Links (+150%)
- Features: 5 → 13 Links (+160%)
- Development: 4 → 11 Links (+175%)
Getting Started → Using ThemisDB → Developing → Operating → Reference
↓ ↓ ↓ ↓ ↓
Build Guide Query Language Development Deployment Glossary
Architecture Search/APIs Architecture Operations Guides
SDKs Features Source Code Observab.
- Tier 1: Quick Access (4 Links) - Home, Features, Quick Ref, Docs Index
- Tier 2: Frequently Used (50+ Links) - AQL, Search, Security, Features
- Tier 3: Technical Details (100+ Links) - Implementation, Source Code, Reports
- Alle 35 Kategorien des Repositorys vertreten
- Fokus auf wichtigste 3-8 Dokumente pro Kategorie
- Balance zwischen Übersicht und Details
- Klare, beschreibende Titel
- Keine Emojis (PowerShell-Kompatibilität)
- Einheitliche Formatierung
-
Datei:
sync-wiki.ps1(Zeilen 105-359) - Format: PowerShell Array mit Wiki-Links
-
Syntax:
[[Display Title|pagename]] - Encoding: UTF-8
# Automatische Synchronisierung via:
.\sync-wiki.ps1
# Prozess:
# 1. Wiki Repository klonen
# 2. Markdown-Dateien synchronisieren (412 Dateien)
# 3. Sidebar generieren (171 Links)
# 4. Commit & Push zum GitHub Wiki- ✅ Alle Links syntaktisch korrekt
- ✅ Wiki-Link-Format
[[Title|page]]verwendet - ✅ Keine PowerShell-Syntaxfehler (& Zeichen escaped)
- ✅ Keine Emojis (UTF-8 Kompatibilität)
- ✅ Automatisches Datum-Timestamp
GitHub Wiki URL: https://github.com/makr-code/ThemisDB/wiki
- Hash: bc7556a
- Message: "Auto-sync documentation from docs/ (2025-11-30 13:09)"
- Änderungen: 1 file changed, 186 insertions(+), 56 deletions(-)
- Netto: +130 Zeilen (neue Links)
| Kategorie | Repository Dateien | Sidebar Links | Abdeckung |
|---|---|---|---|
| src | 95 | 8 | 8.4% |
| security | 33 | 17 | 51.5% |
| features | 30 | 13 | 43.3% |
| development | 38 | 11 | 28.9% |
| performance | 12 | 10 | 83.3% |
| aql | 10 | 8 | 80.0% |
| search | 9 | 8 | 88.9% |
| geo | 8 | 7 | 87.5% |
| reports | 36 | 9 | 25.0% |
| architecture | 10 | 7 | 70.0% |
| sharding | 5 | 5 | 100.0% ✅ |
| clients | 6 | 5 | 83.3% |
Durchschnittliche Abdeckung: 47.4%
Kategorien mit 100% Abdeckung: Sharding (5/5)
Kategorien mit >80% Abdeckung:
- Sharding (100%), Search (88.9%), Geo (87.5%), Clients (83.3%), Performance (83.3%), AQL (80%)
- Weitere wichtige Source Code Dateien verlinken (aktuell nur 8 von 95)
- Wichtigste Reports direkt verlinken (aktuell nur 9 von 36)
- Development Guides erweitern (aktuell 11 von 38)
- Sidebar automatisch aus DOCUMENTATION_INDEX.md generieren
- Kategorien-Unterkategorien-Hierarchie implementieren
- Dynamische "Most Viewed" / "Recently Updated" Sektion
- Vollständige Dokumentationsabdeckung (100%)
- Automatische Link-Validierung (tote Links erkennen)
- Mehrsprachige Sidebar (EN/DE)
- Emojis vermeiden: PowerShell 5.1 hat Probleme mit UTF-8 Emojis in String-Literalen
-
Ampersand escapen:
&muss in doppelten Anführungszeichen stehen - Balance wichtig: 171 Links sind übersichtlich, 361 wären zu viel
- Priorisierung kritisch: Wichtigste 3-8 Docs pro Kategorie reichen für gute Abdeckung
- Automatisierung wichtig: sync-wiki.ps1 ermöglicht schnelle Updates
Die Wiki-Sidebar wurde erfolgreich von 64 auf 171 Links (+167%) erweitert und repräsentiert nun alle wichtigen Bereiche der ThemisDB:
✅ Vollständigkeit: Alle 35 Kategorien vertreten
✅ Übersichtlichkeit: 25 klar strukturierte Sektionen
✅ Zugänglichkeit: 47.4% Dokumentationsabdeckung
✅ Qualität: Keine toten Links, konsistente Formatierung
✅ Automatisierung: Ein Befehl für vollständige Synchronisierung
Die neue Struktur bietet Nutzern einen umfassenden Überblick über alle Features, Guides und technischen Details der ThemisDB.
Erstellt: 2025-11-30
Autor: GitHub Copilot (Claude Sonnet 4.5)
Projekt: ThemisDB Documentation Overhaul