Skip to content

docs: add virt-manager realm setup guide - #538

Open
slashburygin wants to merge 3 commits into
masterfrom
realm_docs
Open

docs: add virt-manager realm setup guide#538
slashburygin wants to merge 3 commits into
masterfrom
realm_docs

Conversation

@slashburygin

@slashburygin slashburygin commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

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:

  • Expose the new virt-manager realm setup guide in the site navigation under a Realms section.

Documentation:

  • Add an English guide for creating, configuring, and testing an Exordos Realm VM using virt-manager and libvirt on KVM hosts.
  • Add a Russian translation of the virt-manager Exordos Realm setup and usage guide, including developer stand instructions.

@slashburygin
slashburygin requested a review from a team as a code owner July 29, 2026 08:19
@sourcery-ai

sourcery-ai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Reviewer's Guide

Adds 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-manager

flowchart 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
Loading

File-Level Changes

Change Details Files
Add MkDocs navigation entry for the new virt-manager realm guide.
  • Extend mkdocs.yml nav tree with a new Realms section.
  • Reference the English virt-manager realm guide markdown page in the nav.
mkdocs.yml
Introduce English virt-manager-based realm setup guide.
  • Create a new docs page explaining how to download and prepare the exordos-realm dev image.
  • Document nested KVM prerequisites and host checks.
  • Provide GUI and CLI workflows for creating and registering the VM with virt-manager/libvirt.
  • Describe verification steps using virsh and kvm-ok and how production vs DEV_ACCESS images behave.
  • Explain how to simulate a managed developer stand via realm_spec.json and relate it to existing bootstrap/spec contracts.
docs/realms/realm-virt-manager.md
Introduce Russian translation of the virt-manager-based realm setup guide.
  • Create a Russian-language docs page mirroring the English instructions for preparing the dev image.
  • Describe nested KVM requirements and VM creation via virt-manager and virt-install in Russian.
  • Document how to verify VM status and KVM availability and how to use DEV_ACCESS and production images.
  • Explain developer stand simulation and bootstrap behavior, localized for Russian readers.
docs/realms/realm-virt-manager.ru.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.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.
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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread docs/realms/realm-virt-manager.ru.md Outdated
Comment thread docs/realms/realm-virt-manager.md Outdated
Comment thread docs/realms/realm-virt-manager.md Outdated
Comment thread docs/realms/realm-virt-manager.ru.md Outdated

@phantomii phantomii left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 phantomii left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CLI shorthand is valid and the two related review threads are resolved. The documentation change is approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants