Skip to content

doc(XCP-ng): Add mention of Viridian extensions #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

thomas-dkmt
Copy link
Collaborator

Following the documentation of Viridian extensions in the Xen Orchestra documentation (see this PR), this PR adds a brief mention of Viridian in the XCP-ng documentation. Additionally, a link to the Viridian section of the XO technical documentation is included for users who want to learn more.

@dinhngtu
Copy link
Member

Instead of pointing to the XO docs, I'd prefer stating that Viridian enlightenments are enabled by default on Windows VM templates included with XCP-ng, as well as having instructions on how to enable/disable Viridian with xe.

@nathanael-h
Copy link
Member

@dinhngtu maybe it should be interested to explain in XCP-ng doc the other platform args [1] needed for Windows VMs? Even if the base template set them. Don't you think?
cf. https://github.com/xenserver/guest-templates-json/blob/master/json/base-windows.json

[1]

        "device_id": "0002",
        "viridian": "true",
        "viridian_time_ref_count": "true",
        "viridian_reference_tsc": "true",
        "viridian_apic_assist": "true",
        "viridian_crash_ctl": "true",
        "viridian_stimer": "true",

@dinhngtu
Copy link
Member

@dinhngtu maybe it should be interested to explain in XCP-ng doc the other platform args [1] needed for Windows VMs? Even if the base template set them. Don't you think? cf. https://github.com/xenserver/guest-templates-json/blob/master/json/base-windows.json

An explanation of device_id would probably be helpful as it's used by various things (namely xcp-ng-tests) to detect Windows VMs.

For the individual Viridian settings, IMO they're only needed for completeness. The settings correspond to the docs here https://xenbits.xen.org/docs/unstable/man/xl.cfg.5.html#Support-for-Paravirtualisation-of-HVM-Guests (but note that many of the upstream settings are not supported in XCP-ng)

@thomas-dkmt thomas-dkmt force-pushed the doc-viridian-extensions branch 3 times, most recently from 284b4d2 to 39c358f Compare April 25, 2025 07:31
Copy link
Member

@dinhngtu dinhngtu left a comment

Choose a reason for hiding this comment

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

Thanks, it looks good to me. Just a couple changes:

Mention the importance of Viridian extensions for Windows VMs
and explain how to enable Viridian for templates not based off the
built-in Windows templates

Signed-off-by: Thomas Moraine <[email protected]>
@thomas-dkmt thomas-dkmt force-pushed the doc-viridian-extensions branch from 39c358f to de22eae Compare April 25, 2025 07:40
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.

4 participants