feat: Add comprehensive documentation structure with farming, mycelium, and cloud guides
This commit is contained in:
mik-tf
195
docs/mycelium-cloud/overview.md
Normal file
195
docs/mycelium-cloud/overview.md
Normal file
@@ -0,0 +1,195 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# What is Mycelium Cloud?
|
||||
|
||||
Mycelium Cloud lets you deploy and manage **Kubernetes clusters** on the decentralized ThreeFold Grid infrastructure.
|
||||
|
||||
Run your containerized workloads on distributed, cost-effective infrastructure with built-in security and global availability.
|
||||
|
||||
## How It Works
|
||||
|
||||
Mycelium Cloud provides a complete platform for cloud-native applications:
|
||||
|
||||
1. **Sign up** for an account
|
||||
2. **Add credits** to fund your deployments
|
||||
3. **Deploy clusters** with custom configurations
|
||||
4. **Manage workloads** using standard Kubernetes tools
|
||||
|
||||
All running on the ThreeFold Grid's decentralized infrastructure.
|
||||
|
||||
## Why Use Mycelium Cloud?
|
||||
|
||||
### 🌍 Decentralized Infrastructure
|
||||
|
||||
- Deploy on ThreeFold Grid's distributed network
|
||||
- No dependency on centralized cloud providers
|
||||
- Global node distribution
|
||||
- True infrastructure sovereignty
|
||||
|
||||
### 📦 Full Kubernetes Management
|
||||
|
||||
- **K3s clusters** - Lightweight, production-ready Kubernetes
|
||||
- **Multi-master support** - High availability configurations
|
||||
- **Standard tooling** - Use kubectl, Helm, and your favorite tools
|
||||
- **Complete control** - Full cluster access
|
||||
|
||||
### 🔐 Secure by Default
|
||||
|
||||
- **Mycelium networking** - Encrypted peer-to-peer connections
|
||||
- **No public IPs needed** - Access via Mycelium overlay network
|
||||
- **End-to-end encryption** - All traffic secured
|
||||
- **Private by design** - Your infrastructure, your control
|
||||
|
||||
### 💰 Cost Effective
|
||||
|
||||
- **Competitive pricing** on decentralized infrastructure
|
||||
- **Pay for what you use** - Flexible resource allocation
|
||||
- **No vendor lock-in** - Standard Kubernetes portability
|
||||
- **Global availability** - Deploy where you need
|
||||
|
||||
## Key Features
|
||||
|
||||
| Feature | Description |
|
||||
|---------|-------------|
|
||||
| **K3s Kubernetes** | Lightweight, certified Kubernetes distribution |
|
||||
| **Mycelium Networking** | IPv6 overlay with encrypted P2P connections |
|
||||
| **High Availability** | Multi-master clusters for production workloads |
|
||||
| **Global Nodes** | Deploy across worldwide ThreeFold Grid locations |
|
||||
| **Standard APIs** | Use kubectl, Helm, and all Kubernetes tools |
|
||||
| **Web Dashboard** | Manage clusters through intuitive UI |
|
||||
| **SSH Access** | Direct node access for debugging and management |
|
||||
| **Flexible Sizing** | Custom CPU, RAM, and storage configurations |
|
||||
|
||||
## Architecture
|
||||
|
||||
Mycelium Cloud uses peer-to-peer networking for direct access:
|
||||
|
||||
```
|
||||
┌────────────────┐
|
||||
│ Your Machine │
|
||||
│ (kubectl) │
|
||||
└───────┬────────┘
|
||||
│
|
||||
│ Mycelium Network
|
||||
│ (encrypted P2P)
|
||||
│
|
||||
┌───────▼────────────────────────────────┐
|
||||
│ Kubernetes Cluster │
|
||||
│ ┌──────────┐ ┌──────────┐ │
|
||||
│ │ Master │ │ Worker │ │
|
||||
│ │ Node │ │ Node │ ... │
|
||||
│ └──────────┘ └──────────┘ │
|
||||
└────────────────────────────────────────┘
|
||||
ThreeFold Grid Infrastructure
|
||||
```
|
||||
|
||||
**Network Flow:**
|
||||
- Your machine connects via Mycelium network
|
||||
- Each cluster node has unique Mycelium IPv6 address
|
||||
- All communication encrypted end-to-end
|
||||
- Direct node access - no gateways or proxies
|
||||
|
||||
## Common Use Cases
|
||||
|
||||
### Development & Testing
|
||||
|
||||
- Spin up test clusters quickly
|
||||
- Experiment with Kubernetes features
|
||||
- CI/CD pipeline testing
|
||||
- Multi-environment development
|
||||
|
||||
### Production Workloads
|
||||
|
||||
- Web applications and APIs
|
||||
- Microservices architectures
|
||||
- Databases and stateful services
|
||||
- Background processing jobs
|
||||
|
||||
### Decentralized Applications
|
||||
|
||||
- P2P services
|
||||
- Distributed computing
|
||||
- Edge computing deployments
|
||||
- Privacy-focused applications
|
||||
|
||||
### Learning Kubernetes
|
||||
|
||||
- Hands-on practice
|
||||
- Tutorial environments
|
||||
- Training clusters
|
||||
- Safe experimentation
|
||||
|
||||
## Technology Stack
|
||||
|
||||
**Kubernetes:** K3s v1.26+ (production-ready, lightweight)
|
||||
**Networking:** Mycelium CNI with IPv6 support
|
||||
**Infrastructure:** ThreeFold Grid decentralized nodes
|
||||
**Management:** Web dashboard + API + kubectl
|
||||
|
||||
## What You Get
|
||||
|
||||
When you deploy a cluster:
|
||||
|
||||
- ✅ **Fully configured K3s cluster** - Ready to use
|
||||
- ✅ **Mycelium networking** - Secure connectivity
|
||||
- ✅ **kubeconfig file** - Standard kubectl access
|
||||
- ✅ **SSH access** - Direct node management
|
||||
- ✅ **Dashboard monitoring** - Cluster status and metrics
|
||||
- ✅ **Flexible scaling** - Add/remove nodes as needed
|
||||
|
||||
## Getting Started
|
||||
|
||||
Ready to deploy your first cluster? Here's the path:
|
||||
|
||||
1. **[Getting Started](/mycelium-cloud/getting-started)** - Create account and deploy
|
||||
2. **[Tutorial](/mycelium-cloud/tutorial)** - Deploy your first application
|
||||
|
||||
<div className="info-box">
|
||||
|
||||
### 💡 Prerequisites
|
||||
|
||||
You should have:
|
||||
- **Mycelium installed** - For network access ([Install guide](/mycelium-network/install))
|
||||
- **kubectl installed** - For cluster management ([Install kubectl](https://kubernetes.io/docs/tasks/tools/))
|
||||
- **SSH key** - For node access
|
||||
- **Credits** - To fund your deployments
|
||||
|
||||
</div>
|
||||
|
||||
## Pricing
|
||||
|
||||
Pricing is based on resource usage:
|
||||
- CPU cores
|
||||
- RAM allocation
|
||||
- Storage capacity
|
||||
- Deployment duration
|
||||
|
||||
Check the dashboard for current rates. The decentralized infrastructure typically offers competitive pricing compared to traditional cloud providers.
|
||||
|
||||
## Resources
|
||||
|
||||
- **Dashboard**: [vdc.grid.tf](https://vdc.grid.tf) - Deploy and manage clusters
|
||||
- **Documentation**: [Mycelium Cloud Docs](https://codescalers.github.io/www_kubecloud/)
|
||||
- **Kubernetes Docs**: [kubernetes.io](https://kubernetes.io/docs/)
|
||||
- **Community**: [ThreeFold Telegram](https://t.me/threefoldfarmers)
|
||||
- **GitHub**: [kubecloud repository](https://github.com/codescalers/kubecloud)
|
||||
|
||||
## Comparison to Traditional Cloud
|
||||
|
||||
| Aspect | Mycelium Cloud | Traditional Cloud |
|
||||
|--------|----------------|-------------------|
|
||||
| Infrastructure | Decentralized | Centralized |
|
||||
| Control | Full sovereignty | Vendor-controlled |
|
||||
| Networking | P2P encrypted | Public IPs, gateways |
|
||||
| Pricing | Competitive | Often expensive |
|
||||
| Lock-in | None (standard K8s) | Vendor-specific services |
|
||||
| Privacy | High | Varies by provider |
|
||||
| Setup | Quick & simple | Can be complex |
|
||||
|
||||
---
|
||||
|
||||
:::tip Next Step
|
||||
Ready to deploy? Start with the **[Getting Started Guide](/mycelium-cloud/getting-started)** to create your first cluster.
|
||||
:::
|
||||
Reference in New Issue
Block a user