ourworld_web/docs_projectmycelium
23
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

init

Browse Source
This commit is contained in:
mik-tf
2025-11-25 15:27:56 -05:00
commit c769942374
33 changed files with 24049 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
docs/vdc/blueprints.md Normal file
View File

@@ -0,0 +1,75 @@
---
sidebar_position: 3
---
# VDC Blueprints & Example Environments
This section presents opinionated "blueprints" you can use as starting points for your own Virtual Data Centers.
## Digital Me – Personal Sovereign Cloud Workspace
Adapted from the **Cloud Blueprint** on the main Mycelium site, *Digital Me* is a personal cloud environment showcasing what’s possible on top of the Mycelium Stack.
### Goal
Provide a private, extensible workspace where:
- Your documents, files, and communication tools live on infrastructure you choose.
- You can integrate additional services or agents over time.
- Everything is reachable securely via Mycelium Network.
### Core Components
A typical Digital Me blueprint might include:
- **Cryptpad** – End‑to‑end encrypted document collaboration.
- **Gitea** – Git hosting, code review, and lightweight DevOps.
- **Nextcloud** – File storage, sync, and basic productivity apps.
- **Matrix (Elements)** – Real‑time chat and rooms.
- **Stallwart** – Mail, calendar, and contacts.
- **Video Conferencing** – LiveKit or Jitsi, optionally integrated with Matrix or Nextcloud.
- **SSO / Identity** – A unifying login layer (future iteration).
Each service runs as one or more Kubernetes workloads inside your VDC.
### How It Fits Together
```mermaid
graph TD
A[Mycelium Network] --> B[VDC (K3s Cluster)]
B --> C[Apps: Cryptpad, Gitea, Nextcloud, Matrix, Stallwart, Video]
C --> D[Your Devices]
D -. secure overlay .- A
```
- Your devices connect via Mycelium Network.
- Services are exposed only via overlay addresses or controlled gateways.
- Data can be stored on QSFS or other resilient storage options.
### Customizing the Blueprint
You can adapt Digital Me by:
- Swapping apps (e.g. another Git forge instead of Gitea).
- Adding specialized tools (design collaboration, analytics, etc.).
- Scaling vertically (larger nodes) or horizontally (more nodes) as usage grows.
- Integrating Mycelium Agents in the future to automate workflows.
## Other Blueprint Ideas
The same VDC primitives can be used for many patterns:
- **Team Collaboration Hub** – Shared docs, code, chat, CI/CD for a startup or studio.
- **Research Environment** – Compute + storage for data science, notebooks, and pipelines.
- **Edge Application Stack** – Regional VDCs running local services that sync to a core.
Blueprints are not prescriptive; they’re **starting points** that help you think in terms of composable services.
---
## Next Steps
- Learn more about **VDC capabilities** in the **[VDC Overview](/vdc)**.
- Explore concrete **[VDC Use Cases](/vdc/use-cases)**.
- When you’re ready to deploy, follow the **[Mycelium Cloud Getting Started guide](/cloud/getting-started)** to spin up your first cluster.

74
docs/vdc/overview.md Normal file
View File

@@ -0,0 +1,74 @@
---
sidebar_position: 1
slug: /vdc
---
# Virtual Data Centers (VDC)
Mycelium Virtual Data Centers (VDC) let you provision full cloud environments — compute, storage, and networking — without owning or operating physical servers.
They are built on top of **Mycelium Cloud** and the **ThreeFold Grid**, combining decentralized infrastructure with managed Kubernetes and Mycelium networking.
## What Is a VDC?
A VDC is your **dedicated environment** on the grid:
- Isolated clusters for applications, databases, and internal services.
- Customizable CPU, RAM, and storage profiles.
- Encrypted overlay networking using **Mycelium Network**.
- Integration with quantum‑safe storage (QSFS) and other Mycelium components.
Think of it as your own mini cloud region that you control, without having to run a datacenter.
## Key Capabilities
Adapted from the "Virtual Data Centers" focus in the Mycelium Cloud UI:
- **Dedicated environments** – Keep workloads, teams, and projects cleanly separated.
- **Elastic capacity** – Add or remove compute and storage on demand.
- **Migration paths** – Move workloads from public cloud or on‑prem into a VDC.
- **Compliance‑aware placement** – Choose where data and workloads reside.
- **Continuous monitoring & recovery** – Benefit from built‑in redundancy.
## How VDC Relates to Mycelium Cloud
Under the hood, a VDC is powered by **K3s Kubernetes clusters** running on the ThreeFold Grid via Mycelium Cloud:
```mermaid
graph TD
A[You] --> B[Mycelium Cloud Dashboard]
B --> C[Provision VDC / Cluster]
C --> D[ThreeFold Grid Nodes]
D --> E[Applications & Services]
A -. Mycelium Network .-> E
```
- You interact through the **Mycelium Cloud dashboard and APIs**.
- Clusters are deployed onto distributed grid nodes.
- Access happens over **Mycelium Network** using secure IPv6 overlay addresses.
## Common VDC Use Cases
- **Enterprise Kubernetes** – Multi‑service apps, APIs, back‑office systems.
- **Internal Platforms** – Developer platforms, CI/CD runners, internal tools.
- **AI / Data Workloads** – Training, inference, and data processing pipelines.
- **Hybrid & Edge** – Extend existing infrastructure into grid‑backed environments.
See **[VDC Use Cases](/vdc/use-cases)** for more detailed scenarios.
## Compared to Traditional Cloud
| Aspect | Mycelium VDC | Traditional Cloud |
|--------|--------------|-------------------|
| **Infrastructure** | Decentralized grid | Centralized datacenters |
| **Networking** | Encrypted P2P via Mycelium | Public IPs, centralized routing |
| **Sovereignty** | You choose jurisdictions & nodes | Provider‑controlled |
| **Lock‑in** | Standard Kubernetes & open tooling | Often proprietary services |
| **Cost Profile** | Competitive, usage‑based | Often complex and higher over time |
## Where to Go Next
- **New to VDC?** Start with **[VDC Use Cases](/vdc/use-cases)** to see concrete patterns.
- **Want a concrete blueprint?** Explore **[Blueprints & Example Environments](/vdc/blueprints)** such as *Digital Me*, a personal sovereign cloud workspace.
- **Need cluster details?** See **[Mycelium Cloud Overview](/cloud)** and **[Getting Started](/cloud/getting-started)**.

91
docs/vdc/use-cases.md Normal file
View File

@@ -0,0 +1,91 @@
---
sidebar_position: 2
---
# VDC Use Cases
Virtual Data Centers give you flexible building blocks for many types of workloads. This page highlights some of the most relevant patterns.
## 1. Enterprise Kubernetes
Run production workloads with full control and no hyperscaler lock‑in:
- Multi‑service applications and APIs.
- Internal tools, back‑office systems, and shared services.
- Microservice architectures using standard Kubernetes, Helm, and operators.
- Policy‑driven placement to keep data in specific regions or jurisdictions.
**Why use a VDC here?**
- Control over where clusters run and how they’re connected.
- Encrypted overlay networking via Mycelium instead of exposed public IPs.
- Compatibility with existing Kubernetes tooling and CI/CD chains.
## 2. AI & Machine Learning
Run training and inference close to your data while keeping it private.
- GPU‑accelerated training on dedicated clusters.
- Model serving endpoints behind Mycelium Network.
- Pipelines that combine **QSFS** (quantum‑safe storage) with compute.
- Future‑ready environments for **Mycelium Agents**.
**Key benefits**
- Data stays on hardware you or your partners select.
- Secure east‑west traffic via Mycelium overlays.
- Ability to burst across multiple nodes or sites.
## 3. Edge & IoT
Leverage the grid’s geographic spread to deploy workloads closer to users, sensors, and devices.
- Run latency‑sensitive services near where events occur.
- Ingest, process, and filter data at the edge before sending summaries upstream.
- Coordinate fleets of devices and gateways over Mycelium Network.
**Examples**
- Local analytics near industrial sites.
- Regional micro‑datacenters serving communities or campuses.
- Smart‑city workloads combining many distributed nodes.
## 4. Personal & Team Clouds
VDCs can back **personal sovereign environments** where your apps and data live entirely on infrastructure you choose.
- Self‑hosted collaboration suites (documents, chat, mail, files).
- Private developer environments and CI runners.
- Long‑term personal archives on QSFS.
The **Digital Me** blueprint (see below) is one concrete example of this pattern.
## 5. Hybrid & Migration Scenarios
Move workloads from traditional cloud or on‑prem into a VDC, or straddle both worlds.
- Gradual migration from centralized providers.
- Burst or spill‑over capacity into the grid.
- Disaster‑recovery clusters that can be spun up on demand.
## Example: Digital Me on Mycelium
The *Digital Me* concept shows what a personal sovereign cloud workspace can look like:
- **Cryptpad** – Encrypted document collaboration.
- **Elements (Matrix)** – Secure chat and communication.
- **Stallwart** – Mail, calendar, and contacts.
- **Gitea** – Git hosting and code collaboration.
- **Nextcloud** – File storage and sync.
- **LiveKit / Jitsi** – Video conferencing integrated with chat / files.
- **SSO** (future) – Single Sign‑On across the stack.
All of this can be orchestrated inside a VDC and surfaced via Mycelium networking.
---
## Related Documentation
- **[VDC Overview](/vdc)** – Concepts and architecture.
- **[Blueprints & Example Environments](/vdc/blueprints)** – How to assemble real‑world stacks.
- **[Mycelium Cloud for Developers](/cloud/for-developers)** – Deeper dive into the underlying platform.