Kamiwaza Documentation 0.5.0

Version: 0.5.0

Before You Begin

Please review the System Requirements before proceeding with installation. This document covers:

• Supported operating systems and versions
• Hardware requirements (CPU, RAM, storage)
• Required system packages and dependencies
• Network and storage configuration
• GPU support requirements

Installation Workflows

Linux

Ubuntu .deb Package Installation (for Ubuntu 24.04 Noble)

1. Add Kamiwaza repository to APT sources

   echo "deb [signed-by=/usr/share/keyrings/kamiwaza-archive-keyring.gpg] https://packages.kamiwaza.ai/ubuntu/ noble main" | sudo tee /etc/apt/sources.list.d/kamiwaza.list  

2. Import and install Kamiwaza GPG signing key

   curl -fsSL https://packages.kamiwaza.ai/gpg | sudo gpg --dearmor -o /usr/share/keyrings/kamiwaza-archive-keyring.gpg  

3. Update package database and install Kamiwaza

   sudo apt update  
   sudo apt upgrade  
   sudo apt install kamiwaza  

4. Verify service starts (see Quickstart)

Other Linux Distros via Tarball

1. Follow the consolidated guide: Linux/macOS tarball installation
2. Ensure Docker Engine (with Compose v2), Python 3.10, and Node.js 22 are available (installer may configure as needed)
3. Run install.sh --community
4. Access via browser at https://localhost

Community Edition on macOS

Only Community Edition is supported on macOS.

1. Follow the consolidated guide: Linux/macOS tarball installation
2. Ensure Docker Engine (with Compose v2), Python 3.10, and Node.js 22 are available (installer may configure as needed)
3. Run install.sh --community
4. Access via browser at https://localhost

Community Edition on Windows

Use the MSI installer for a streamlined WSL2-based setup. See the Windows Installation Guide for prerequisites, GPU support, and step-by-step instructions.

Steps:

1. Download: KamiwazaInstaller-[version]-[arch].msi
2. Install: Run the MSI (reboot when prompted)
3. Launch: Start Menu → "Kamiwaza Start"

Enterprise Edition Deployment

A. Terraform Deployment (Recommended)

deply with terraform

• cloud-init
• first-boot.sh
• Service Running

Key Points:

• Terraform handles complete cluster setup
• cloud-init automatically runs first-boot.sh
• Service starts automatically via systemd

B. Manual Cluster Deployment

deply image

• cluster-manual-prep.sh --head/--worker
• first-boot.sh
• Service Running

Key Points:

• Requires manual cluster setup via cluster-manual-prep.sh
• Must specify correct role (--head or --worker --head-ip=<IP>)
• Service starts automatically via systemd

Updating Kamiwaza

Windows

• Download new MSI installer and run to update existing installation
• Restart if prompted for GPU changes

Linux/macOS

• Download new package
• Run installation script again
• Service will restart automatically

Uninstallation

Windows

• Windows Settings → Add or Remove Programs -> (three dots on side) Uninstall

Linux/macOS

• Remove package via package manager
• Clean up any remaining configuration files