docs: add virt-manager realm setup guide - #538
Open
slashburygin wants to merge 3 commits into
Open
Conversation
Reviewer's GuideAdds new English and Russian documentation pages describing how to run an Exordos Realm VM using virt-manager, and wires the English page into the MkDocs navigation under a new "Realms" section. Flow diagram for setting up Exordos Realm VM with virt-managerflowchart TD
User[Host admin]
HostSetup[Install KVM, libvirt, virt-manager
and enable nested KVM]
DownloadImage[Download and decompress
exordos-realm-dev.raw.zst
into /var/lib/libvirt/images]
CreateVM[Create VM in virt-manager
or via virt-install
using exordos-realm-dev.raw
with host-passthrough CPU]
TestVM[Check VM with virsh
and run kvm-ok inside guest]
ConfigureRealmSpec[Create /etc/exordos/realm_spec.json
and review exordos-realm-bootstrap logs]
User --> HostSetup --> DownloadImage --> CreateVM --> TestVM --> ConfigureRealmSpec
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 2 issues, and left some high level feedback:
- The final example command
exordos e e l.appears to include an extra trailing period and inconsistent quoting; consider standardizing all shell command snippets to be copy-pasteable (no trailing punctuation, consistently wrapped in backticks). - The term "developer stand" / "work stand" is a bit unclear in English; consider aligning this wording with existing terminology used elsewhere in the docs (e.g., "developer environment" or "developer realm") for consistency.
- You added only
realms/realm-virt-manager.mdto the mkdocs navigation; if the Russian version is meant to be directly browsable as well, double-check whetherrealm-virt-manager.ru.mdneeds a corresponding nav entry or integration in your localization setup.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The final example command `exordos e e l.` appears to include an extra trailing period and inconsistent quoting; consider standardizing all shell command snippets to be copy-pasteable (no trailing punctuation, consistently wrapped in backticks).
- The term "developer stand" / "work stand" is a bit unclear in English; consider aligning this wording with existing terminology used elsewhere in the docs (e.g., "developer environment" or "developer realm") for consistency.
- You added only `realms/realm-virt-manager.md` to the mkdocs navigation; if the Russian version is meant to be directly browsable as well, double-check whether `realm-virt-manager.ru.md` needs a corresponding nav entry or integration in your localization setup.
## Individual Comments
### Comment 1
<location path="docs/realms/realm-virt-manager.ru.md" line_range="111-113" />
<code_context>
+`exordos_core/cmd/bootstrap.py` / `exordos_core/bootstrap/defaults.py`
+(`realm_uuid`, `realm_secret`, `realm_tokens`, `ecosystem_endpoint`,
+`admin_password`, `disable_telemetry`), чтобы скрипт первой загрузки образа мог
+объедините этот файл с его готовым шаблоном спецификации с минимальным сопоставлением.
+
+Далее вы можете просмотреть логи службы bootstrap с помощью `sudo journalctl -u exordos-realm-bootstrap`.
</code_context>
<issue_to_address>
**suggestion (typo):** Используйте инфинитив "объединить" вместо императива "объедините" для согласования с конструкцией "чтобы скрипт ... мог".
Фраза должна описывать действие скрипта в инфинитиве, а не звучать как команда пользователю.
```suggestion
(`realm_uuid`, `realm_secret`, `realm_tokens`, `ecosystem_endpoint`,
`admin_password`, `disable_telemetry`), чтобы скрипт первой загрузки образа мог
объединить этот файл с его готовым шаблоном спецификации с минимальным сопоставлением.
```
</issue_to_address>
### Comment 2
<location path="docs/realms/realm-virt-manager.md" line_range="110" />
<code_context>
+`admin_password`, `disable_telemetry`), so the image's first-boot script can
+merge this file into its baked spec template with minimal mapping.
+
+Next you can see logs of bootstrap service by `sudo journalctl -u exordos-realm-bootstrap`.
+
+And after some time you can see work stand by `exordos e e l.`
</code_context>
<issue_to_address>
**nitpick (typo):** Сделать фразу более естественной на английском, заменив "see logs ... by".
Замените формулировку на более естественную, например: "view the bootstrap service logs with `sudo journalctl ...`" или "check the bootstrap service logs using ...".
```suggestion
Next you can view the bootstrap service logs with `sudo journalctl -u exordos-realm-bootstrap`.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
phantomii
reviewed
Jul 29, 2026
phantomii
reviewed
Jul 29, 2026
phantomii
requested changes
Jul 29, 2026
phantomii
left a comment
Member
There was a problem hiding this comment.
Please address the comments before merging.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
phantomii
approved these changes
Jul 30, 2026
phantomii
left a comment
Member
There was a problem hiding this comment.
The CLI shorthand is valid and the two related review threads are resolved. The documentation change is approved.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Add documentation for running an Exordos Realm VM with virt-manager, including setup, verification, and developer workflow, and link it into the docs navigation.
Enhancements:
Documentation: