Skip to content
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

doc: walkthroughs/VM.start: Update the xenguest chapter (domain build) #6272

Conversation

bernhardkaindl
Copy link
Collaborator

@bernhardkaindl bernhardkaindl commented Feb 4, 2025

Update:

  • No longer add the links to not "official" source repositories for xenguest.

Update and extend the walkthrough of VM.start:

  • Update the links to xenopsd functions from xapi-project/xenopsd.git to the current xenopsd code in xapi-project/xen-api.git
  • Add the step for storing the platform data (vCPUs, vCPU affinity, etc.) in the domain's Xenstore tree.xenguest then uses this in thebuild` phase to build the domain.
  • Convert the paragraphs about xenguest into a dedicated chapter on xenguest.
  • Add a summary of the data that xenopsd passes to xenguest for the domain build
  • Add a summary of the steps that xenguest takes to build the domain.

Copy link
Contributor

@last-genius last-genius left a comment

Choose a reason for hiding this comment

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

Great to see this, thank you very much!

@bernhardkaindl bernhardkaindl force-pushed the docs-update-VM.start-xenguest-calls branch 3 times, most recently from b31f1e4 to ba30beb Compare February 4, 2025 11:18
@bernhardkaindl bernhardkaindl force-pushed the docs-update-VM.start-xenguest-calls branch 2 times, most recently from baa3e21 to bf16439 Compare February 5, 2025 12:15
Copy link
Collaborator Author

@bernhardkaindl bernhardkaindl left a comment

Choose a reason for hiding this comment

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

@robhoes: Done as suggested: Removed the links to not "offical" source repositories.

Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
@bernhardkaindl bernhardkaindl force-pushed the docs-update-VM.start-xenguest-calls branch from bf16439 to 9ef7e19 Compare February 5, 2025 12:48
Copy link
Collaborator Author

@bernhardkaindl bernhardkaindl left a comment

Choose a reason for hiding this comment

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

This was a small update for improving the structure.
Update the chapter 3.1 title to:

3.1 Interface to xenguest for building domains

At then end of it, add a brief summary on the platform data passed to xenguest:

When called to build a domain, xenguest reads those and builds the VM accordingly.

Add a new chapter heading to describe what the content of the remaining lines:

3.2 Workflow for allocating and populating domain memory

@last-genius
Copy link
Contributor

@robhoes Can we merge this?

@robhoes
Copy link
Member

robhoes commented Feb 7, 2025

@last-genius I haven't reviewed the text myself, but if other have then I'm happy for this to get merged.

Copy link
Collaborator Author

@bernhardkaindl bernhardkaindl left a comment

Choose a reason for hiding this comment

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

Hi @last-genius and @psafont!

@robhoes wrote #6272 (comment) for merging this PR:

@last-genius I haven't reviewed the text myself, but if other have then I'm happy for this to get merged.

If you could kindly add a comment that you reviewed the text, @robhoes would be open for merging it.

For your review, please find a preview of the docs with this PR here:
https://bernhard-xapi-onrender-com-pr-7.onrender.com/xenopsd/walkthroughs/VM.start/index.html#2-create-a-xen-domain

~Bernhard


PS:

How the preview was generated:

I configured a fork of this repository for automatic Hugo previews on http://render.com using this blueprint: https://github.com/bernhard-xapi/bernhard-xapi.onrender.com/blob/main/render.yaml. After enabling previews for pull requests , I got this preview site created automatically after opening a local PR in the repository. This is the PR showing the creation of the preview site: bernhard-xapi#7 (it only supports local pull requests within the repository, so I had to create a local PR for it)


PPS:

I'm thankful that this small team created a documentation site that is accessible and well-maintained and helps newcomers to understand the miracles this software does.

I do think that this documentation is an great asset that is very helpful to understand how the individual parts work. For example, the Xen hypervisor does not have such a single integrated documentation site for all things Xen.

@last-genius
Copy link
Contributor

I am happy with the docs, so merging it.

@last-genius last-genius added this pull request to the merge queue Feb 10, 2025
Merged via the queue into xapi-project:master with commit cc8a608 Feb 10, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants