# dirkpetersen/crowd-hpc architecture

> Architecture diagram of the GitHub repository dirkpetersen/crowd-hpc, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dirkpetersen/crowd-hpc
- Repository: https://github.com/dirkpetersen/crowd-hpc

## Overview

crowd-hpc is a set of scripts and documentation for preparing a KVM hypervisor and user account, then provisioning a virtual cluster intended for Warewulf4 and Slurm evaluation. The documented path starts with host networking and account setup, proceeds through KVM cluster installation, and targets a functional Slurm cluster. The README also describes multiple cluster-node Linux distributions and optional networks. No source excerpts were provided, so relationships below are limited to those explicitly documented in the root README; script internals are not inferred.

Main entry points: [`prepare-host.sh`](https://github.com/dirkpetersen/crowd-hpc/blob/main/prepare-host.sh) (Prepare host), [`install-kvm-cluster.sh`](https://github.com/dirkpetersen/crowd-hpc/blob/main/install-kvm-cluster.sh) (Install KVM cluster), [`warewulf/install-warewulf.sh`](https://github.com/dirkpetersen/crowd-hpc/blob/main/warewulf/install-warewulf.sh) (Install Warewulf), [`prepare-user.sh`](https://github.com/dirkpetersen/crowd-hpc/blob/main/prepare-user.sh) (Prepare user)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Host setup"]
  node_host_setup["Prepare host<br/>[prepare-host.sh]"]
  node_networks["Virtual networks"]
  node_user_setup["Prepare user<br/>[prepare-user.sh]"]
end

subgraph group_provision["KVM provisioning"]
  node_kvm_install["Install KVM cluster"]
  node_kvm["KVM sandbox"]
end

subgraph group_hpc["HPC deployment"]
  node_warewulf_install["Install Warewulf"]
  node_warewulf["Warewulf4"]
  node_slurm_cluster["Slurm cluster"]
  node_node_images["Cluster node images"]
end

node_operator(("Operator"))

node_operator -->|"runs first"| node_host_setup
node_operator -->|"runs next"| node_user_setup
node_operator -->|"runs installer"| node_kvm_install
node_host_setup -->|"configures networks"| node_networks
node_kvm_install -->|"provisions cluster"| node_kvm
node_warewulf_install -.->|"installs"| node_warewulf
node_warewulf -->|"deploys"| node_slurm_cluster
node_warewulf -->|"supports"| node_node_images

click node_host_setup "https://github.com/dirkpetersen/crowd-hpc/blob/main/prepare-host.sh"
click node_user_setup "https://github.com/dirkpetersen/crowd-hpc/blob/main/prepare-user.sh"
click node_kvm_install "https://github.com/dirkpetersen/crowd-hpc/blob/main/install-kvm-cluster.sh"
click node_warewulf_install "https://github.com/dirkpetersen/crowd-hpc/blob/main/warewulf/install-warewulf.sh"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_host_setup,node_networks,node_user_setup toneBlue
class node_kvm_install,node_kvm toneAmber
class node_warewulf_install,node_warewulf,node_slurm_cluster,node_node_images toneMint
class node_operator toneIndigo
```

## Components

### Host setup

- [Prepare host](https://github.com/dirkpetersen/crowd-hpc/blob/main/prepare-host.sh): `prepare-host.sh`
- **Virtual networks**
- [Prepare user](https://github.com/dirkpetersen/crowd-hpc/blob/main/prepare-user.sh): `prepare-user.sh`

### KVM provisioning

- [Install KVM cluster](https://github.com/dirkpetersen/crowd-hpc/blob/main/install-kvm-cluster.sh): `install-kvm-cluster.sh`
- **KVM sandbox**

### HPC deployment

- [Install Warewulf](https://github.com/dirkpetersen/crowd-hpc/blob/main/warewulf/install-warewulf.sh): `warewulf/install-warewulf.sh`
- **Warewulf4**
- **Slurm cluster**
- **Cluster node images**

### Other components

- **Operator**

## Connections

- Operator → Prepare host: runs first (evidence: `README.md`)
- Operator → Prepare user: runs next (evidence: `README.md`)
- Operator → Install KVM cluster: runs installer (evidence: `README.md`)
- Prepare host → Virtual networks: configures networks (evidence: `README.md`)
- Install KVM cluster → KVM sandbox: provisions cluster (evidence: `README.md`)
- Install Warewulf → Warewulf4: installs
- Warewulf4 → Slurm cluster: deploys (evidence: `README.md`)
- Warewulf4 → Cluster node images: supports (evidence: `README.md`)
