# vekiar/vekiar-cloud architecture

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

- Interactive diagram: https://gitdiagram.com/vekiar/vekiar-cloud
- Repository: https://github.com/vekiar/vekiar-cloud

## Overview

VKRC is a small local VM-orchestration CLI. Its implemented path parses commands, creates per-VM directories with firmware and a qcow2 disk, and can list directories with process-based status checks. QEMU command construction exists, but the start dispatch calls an undefined misspelled function, and stop/terminate handlers are absent. The README adds no further capabilities; the user-data image is only referenced in commented-out code.

Main entry points: [`vkrc.py`](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py) (VM Provisioning), [`edk2/edk2-aarch64-code.fd`](https://github.com/vekiar/vekiar-cloud/blob/main/edk2/edk2-aarch64-code.fd) (Firmware Assets)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI"]
  node_dispatch["CLI Dispatch<br/>[vkrc.py]"]
  node_arguments["Argument Parsing<br/>[vkrc.py]"]
  node_listing["Instance Listing<br/>[vkrc.py]"]
  node_process_probe["Process Probe<br/>[vkrc.py]"]
end

subgraph group_provision["VM Provisioning"]
  node_instance_dir[("Instance Directories<br/>[vkrc.py]")]
  node_provisioner["VM Provisioning<br/>[vkrc.py]"]
  node_command_runner["Command Runner<br/>[vkrc.py]"]
  node_firmware["Firmware Assets"]
  node_disk_image["Disk Image<br/>[vkrc.py]"]
end

subgraph group_runtime["VM Runtime"]
  node_vm_launcher["QEMU Command Builder<br/>[vkrc.py]"]
end

node_operator(("Operator"))
node_qemu_img["qemu-img"]
node_pgrep["pgrep"]
node_qemu["QEMU"]

node_operator -->|"runs"| node_dispatch
node_dispatch -->|"parses commands"| node_arguments
node_dispatch -->|"dispatches list"| node_listing
node_dispatch -->|"dispatches create"| node_provisioner
node_provisioner -->|"creates directory"| node_instance_dir
node_provisioner -->|"copies firmware"| node_firmware
node_provisioner -->|"runs commands"| node_command_runner
node_command_runner -->|"invokes"| node_qemu_img
node_provisioner -->|"creates disk"| node_disk_image
node_listing -->|"reads directories"| node_instance_dir
node_listing -->|"checks status"| node_process_probe
node_process_probe -->|"invokes"| node_pgrep
node_vm_launcher -->|"runs QEMU"| node_command_runner
node_command_runner -->|"invokes"| node_qemu

click node_dispatch "https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py"
click node_arguments "https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py"
click node_listing "https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py"
click node_instance_dir "https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py"
click node_provisioner "https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py"
click node_command_runner "https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py"
click node_firmware "https://github.com/vekiar/vekiar-cloud/blob/main/edk2/edk2-aarch64-code.fd"
click node_disk_image "https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py"
click node_process_probe "https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py"
click node_vm_launcher "https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py"

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_dispatch,node_arguments,node_listing,node_process_probe toneBlue
class node_instance_dir,node_provisioner,node_command_runner,node_firmware,node_disk_image toneAmber
class node_vm_launcher toneMint
class node_operator,node_qemu_img,node_pgrep,node_qemu toneIndigo
```

## Components

### CLI

- [CLI Dispatch](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py): `vkrc.py`
- [Argument Parsing](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py): `vkrc.py`
- [Instance Listing](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py): `vkrc.py`
- [Process Probe](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py): `vkrc.py`

### VM Provisioning

- [Instance Directories](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py): `vkrc.py`
- [VM Provisioning](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py): `vkrc.py`
- [Command Runner](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py): `vkrc.py`
- [Firmware Assets](https://github.com/vekiar/vekiar-cloud/blob/main/edk2/edk2-aarch64-code.fd): `edk2/edk2-aarch64-code.fd`
- [Disk Image](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py): `vkrc.py`

### VM Runtime

- [QEMU Command Builder](https://github.com/vekiar/vekiar-cloud/blob/main/vkrc.py): `vkrc.py`

### Other components

- **Operator**
- **qemu-img**
- **pgrep**
- **QEMU**

## Connections

- Operator → CLI Dispatch: runs (evidence: `vkrc.py`)
- CLI Dispatch → Argument Parsing: parses commands (evidence: `vkrc.py`)
- CLI Dispatch → Instance Listing: dispatches list (evidence: `vkrc.py`)
- CLI Dispatch → VM Provisioning: dispatches create (evidence: `vkrc.py`)
- VM Provisioning → Instance Directories: creates directory (evidence: `vkrc.py`)
- VM Provisioning → Firmware Assets: copies firmware (evidence: `vkrc.py`)
- VM Provisioning → Command Runner: runs commands (evidence: `vkrc.py`)
- Command Runner → qemu-img: invokes (evidence: `vkrc.py`)
- VM Provisioning → Disk Image: creates disk (evidence: `vkrc.py`)
- Instance Listing → Instance Directories: reads directories (evidence: `vkrc.py`)
- Instance Listing → Process Probe: checks status (evidence: `vkrc.py`)
- Process Probe → pgrep: invokes (evidence: `vkrc.py`)
- QEMU Command Builder → Command Runner: runs QEMU (evidence: `vkrc.py`)
- Command Runner → QEMU: invokes (evidence: `vkrc.py`)
