# Base System Requirements

## Supported Operating Systems
- **Linux**: Ubuntu 24.04 and 22.04 LTS via .deb package installation
- **Windows**: 11 (x64 architecture) via WSL with MSI installer
- **macOS**: 12.0 or later (community edition only)

## Core Requirements
- Python 3.10 (tarball installation on MacOS and Linux) or Python 3.12 (deb installation on Linux or MSI installation on Windows WSL)
- Docker Engine with Compose v2
- Node.js 22 (installed via NVM during setup)
- Minimum disk space requirements (see Storage Requirements section)
- For GPU support: NVIDIA GPU with compute capability 7.0+ (Linux/macOS) or NVIDIA RTX/Intel Arc (Windows)

## Memory Requirements
### Linux/macOS
- Minimum: 16GB RAM
- Recommended: 32GB RAM
- GPU Workloads: 32GB RAM + GPU vRAM

### Windows (WSL-based)
- Minimum: 8GB RAM
- Recommended: 16GB+ RAM
- Optimal Performance: 32GB+ RAM for large workloads
- Memory Allocation: 50-75% of system RAM dedicated to Kamiwaza during installation

## Storage Requirements
### Linux/macOS
- Minimum: 10GB free disk space
- Enterprise Edition: Additional space for /opt/kamiwaza persistence

### Windows
- Minimum: 20GB free disk space
- Recommended: 50GB+ free space on SSD for optimal performance
- WSL will automatically manage Ubuntu 24.04 installation space

## Windows-Specific Prerequisites
- Windows Subsystem for Linux (WSL) installed and enabled
- Administrator access required for initial setup
- Windows Terminal (recommended for optimal WSL experience)

## Dependencies & Components
### Required System Packages (Linux)
```bash
# Core Python

python3.10

python3.10-dev

libpython3.10-dev

python3.10-venv

# System Tools

golang-cfssl

python-is-python3

etcd-client (v3.5+)

net-tools

# Graphics & Development Libraries

libcairo2-dev

libgirepository1.0-dev
```

### NVIDIA Components (Linux GPU Support)
- NVIDIA Driver (550-server recommended)
- NVIDIA Container Toolkit
- nvidia-docker2

### Windows Components (Automated via MSI Installer)
- Windows Subsystem for Linux (WSL 2)
- Ubuntu 24.04 LTS (automatically downloaded and configured)
- Docker Engine (configured within WSL)
- GPU drivers and runtime (automatically detected and configured)
- Node.js 22 (via NVM within WSL environment)

### Docker Configuration Requirements
- Docker Engine with Compose v2
- User must be in docker group
- Swarm mode (Enterprise Edition)
- Docker data root configuration (configurable)

### Required Directory Structure
#### Enterprise Edition
```text
/etc/kamiwaza/

├── config/

├── ssl/      # Cluster certificates

└── swarm/    # Swarm tokens

/opt/kamiwaza/

├── containers/  # Docker root (configurable)

├── logs/

├── nvm/        # Node Version Manager

└── runtime/    # Runtime files
```

#### Community Edition
```text
$KAMIWAZA_ROOT/

├── env.sh

├── runtime/

└── logs/
```

## Network Configuration
### Required Kernel Modules (Enterprise Edition Linux Only)
- overlay
- br_netfilter

### System Network Parameters (Enterprise Edition Linux Only)
```bash
# Required sysctl settings for Swarm networking

net.bridge.bridge-nf-call-iptables  = 1

net.bridge.bridge-nf-call-ip6tables = 1

net.ipv4.ip_forward                 = 1
```

### Community Edition Networking
- Uses standard Docker bridge networks
- No special kernel modules or sysctl settings required
- Simplified single-node networking configuration

## Storage Configuration
### Enterprise Edition Requirements
- Primary mountpoint for persistent storage (/opt/kamiwaza)
- Scratch/temporary storage (auto-configured)
- For Azure: Additional managed disk for persistence

### Community Edition
- Local filesystem storage
- Configurable paths via environment variables

## Important Notes
- **System Impact**: Network and kernel configurations can affect other services
- **Security**: Certificate generation and management for cluster communications
- **GPU Support**: Available on Linux (NVIDIA GPUs) and Windows (NVIDIA RTX, Intel Arc via WSL)
- **Storage**: Enterprise Edition requires specific storage configuration
- **Network**: Enterprise Edition requires specific network ports for cluster communication
- **Docker**: Custom Docker root configuration may affect other containers
- **Windows Edition**: Requires WSL 2 and will create a dedicated Ubuntu 24.04 instance
- **Administrator Access**: Windows installation requires administrator privileges for initial setup

## Additional Considerations
### Network Ports
#### Linux/macOS Enterprise Edition
- 443/tcp: HTTPS primary access
- 51100-51199/tcp: Deployment ports for model instances (will also be used for 'App Garden' in the future)

#### Windows Edition
- 443/tcp: HTTPS primary access (via WSL)
- 61100-61299/tcp: Reserved ports for Windows installation

### Version Compatibility
- Docker Engine: 20.10 or later
- NVIDIA Driver: 450.80.02 or later
- ETCD: 3.5 or later
- Node.js: 22.x (installed automatically)