MYKOS / DOCUMENTATION · Dashboard · API

References

Documentation index

MYKOS brings together the projects below for container management, image creation, VMs, snapshots, networking, and its browser interface. Each entry explains the connection to MYKOS. The compatibility section distinguishes a credited patch source from technical documentation that explains the behavior behind a repair.

Operating system vendors and projects

MYKOS hosts run RHEL 9 or RHEL 10 on x86_64. Guest recipes have their own version list; see image builds and desktop guests.

OS family Vendor or project main site Related product or documentation
Red Hat Enterprise Linux Red Hat RHEL developer resources
Rocky Linux Rocky Linux Rocky documentation
AlmaLinux AlmaLinux OS Foundation AlmaLinux wiki
Oracle Linux Oracle Oracle Linux
CentOS Stream CentOS Project CentOS Stream
Fedora Linux Fedora Project Fedora documentation
Ubuntu Canonical Ubuntu
Windows and Windows Server Microsoft Windows · Windows Server documentation
macOS Apple macOS support

The SQL Server image family also uses Microsoft SQL Server. Debian is an upstream distribution used by desktop wrapper images; it is distinct from MYKOS's selectable guest recipes.

Containers, VMs and snapshots

Project Role in MYKOS
Podman · command documentation Rootful container lifecycle, local images, builds, and checkpoint integration
CRIU Native Linux process and RAM checkpoint/restore; the MYKOS CRIU package carries compatibility patches
QEMU · KVM Hardware-assisted desktop guests; QEMU supplies VM RAM and device-state capture
Dockur Windows Upstream Windows VM wrapper and installation assets
Dockur macOS Upstream macOS VM wrapper, recovery workflow, and installation assets
QEMUS QEMU wrapper Upstream QEMU container wrapper used for Ubuntu desktop images
noVNC Browser display for desktop VM consoles
Linux kernel · kernel documentation Namespaces, cgroups, networking, storage, and virtualization interfaces
systemd Host and guest services, sockets, timers, transient workers, and resource groups

For MYKOS's own separation of native filesystem previews and desktop RAM previews, see Snapshot Preview.

Image creation and installation

Project Role in MYKOS
Lorax and livemedia-creator Produce native Linux root filesystem archives
Anaconda installer Executes native installation workflows and Kickstart instructions
Pykickstart Kickstart command definitions and validation
libblockdev Storage plugins required by the host installer stack
RPM Build, install, and verify MYKOS host packages
DNF · createrepo_c Package retrieval, repository synchronization, and RPM metadata
GnuPG Release and RPM signing tooling
EPEL Additional Enterprise Linux packages used by optional bootstrap steps

Application and browser interface

Project Role in MYKOS
Python API services, collectors, privileged helpers, installer, and build orchestration
FastAPI Web/API routes, dependency handling, and generated API schema
Starlette · Uvicorn ASGI web framework infrastructure and application server
Pydantic Request models and validation
websockets WebSocket protocol support
SQLite Local application database
Apache HTTP Server HTTPS front end, reverse proxy, and repository delivery
xterm.js Browser terminal rendering
Leaflet Dashboard location map and markers
OpenStreetMap · CARTO Map data attribution and basemap tiles
Simple Icons · Devicon Brand icon sources; see the retained icon credits

The exact Python runtime dependency set, including transitive libraries, is recorded in services/requirements.txt in the source tree. That pinned list is the installation input; this page explains the major components.

Networking, VPNs and administration

Project or service Role in MYKOS
Libreswan IPsec/IKE VPN configuration and tunnel status
Cisco Meraki Dashboard API Organization/site information and third-party VPN peer integration
Netavark · CNI plugins Podman networking backends, depending on the host configuration
NetworkManager Host/guest network configuration and compatibility with managed interfaces
OpenSSH Remote administration and SSH-based guest access
rsync Backup transfer and synchronization
OpenSSL TLS certificates and cryptographic tooling
Certbot · Let's Encrypt Optional trusted domain certificate issuance and renewal
firewalld · SELinux Project Host firewall and mandatory-access-control infrastructure
dmidecode Physical host model, serial number, and BIOS information

Compatibility fixes and troubleshooting references

These entries connect specific MYKOS repair areas to upstream source or primary technical references. The source paths identify where the corresponding MYKOS implementation lives.

Repair area Upstream source or technical reference MYKOS connection
Overlay filesystem and inotify checkpoint restore AlmaLinux CRIU patch commit Credited source of the directory-walk patch adapted in packaging/criu/overlay-fsnotify.patch, with a MYKOS overlay-path extension
Native cgroup checkpoint compatibility Kernel cgroup v2 reference · CRIU source Background for cgroup layout handling in services/helpers/mykos_criu_cgroups.py and the local 4.2.1-subtree-control.patch
Desktop RAM restore and matching virtual devices QEMU migration framework · QMP specification Saved RAM must match the guest device configuration; implemented in services/helpers/mykos_vm.py
Installer storage-module failures libblockdev source · Anaconda troubleshooting The EL9 package dependencies and preflight in packaging/rpm/mykos.spec and pos/build_rootfs.py keep the storage plugin stack available
Legacy guest Kickstart compatibility and repository selection Pykickstart reference · Lorax documentation pos/prepare_ks.py prepares generated installer copies; the checked-in guest recipes remain the source
Image builders competing with the running app systemd resource controls Low CPU/disk priority in image workers and builder VMs; bounded read-only inventory and last-good UI data handle temporary Podman stalls
Older Meraki MX site-only tunnels Meraki Dashboard API · Libreswan Compatibility handling in pos/pos and the VPN helpers retains existing peers and supports site-only routing
DHCP across VPN-connected networks RFC 2131: DHCP · Meraki DHCP relay guide Design references retained in Performance by design

Development, documentation and testing tools

Tool Use in the project
Git · GitHub Source history, review, and release publication
OpenAI Codex Assisted development, investigation, documentation, and validation
pytest Python regression and component tests
Node.js Documentation generation and JavaScript checks
Marked GitHub-flavored Markdown rendered into the bundled HTML guides
Graphviz · Viz.js Diagram layout and generated SVG output
Mermaid Editable companion diagram notation stored with generated diagrams

For exact documentation build inputs and checks, see Documentation build. For the MYKOS implementation, start with the Developer's guide and architecture guide.

When adding a dependency or adapting an external fix, add its official project link, describe its role, and record any patch provenance beside the source.