# Documentation for Kamiwaza **0.3.2**

Version: 0.3.2

## Overview

Kamiwaza can be installed in three main configurations:

- Community Edition on OSX (single-node)
- Community Edition on Linux (single-node)
- Enterprise Edition (cluster-capable)

## Installation Workflows

### 1. Community Edition on OSX

Simple, single-command installation:

```bash
install.sh --community
```

Service Running

### 2. Community Edition on Linux

Two options available:

**Option B: Automated Setup**

```bash
mountlocal.sh
1.sh
2.sh
3.sh
```

Service Running

**Option A: Direct Install**

```bash
install.sh --community
```

Service Running

Note: `mountlocal.sh` is only needed for Azure deployments requiring specific disk configurations. The automated setup sequence (1.sh -> 2.sh -> 3.sh) can be used on any Linux system, but is primarily tested on Azure.

### 3. Enterprise Edition

#### A. Terraform Deployment (Recommended)

```bash
deploy 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

```bash
deploy 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

## Important Notes

1. Community Edition:
   - OSX: Simple `install.sh --community` command
   - Linux: Choose between direct install or automated setup sequence
   - Automated setup (1.sh -> 2.sh -> 3.sh) handles prerequisites and NVIDIA container testing
2. Enterprise Edition:
   - Terraform method provides fully automated deployment
   - Manual method requires explicit cluster role specification
   - Both methods result in automatically running services
3. Service Management:
   - `first-boot.sh` configures and starts the service via systemd
   - No need to manually run startup scripts