Page MenuHomeFreeBSD

Update to FreeBSD handbook: virtualization chapter
ClosedPublic

Authored by freebsd_ny-central.org on Feb 25 2024, 8:39 AM.
Tags
Referenced Files
F103000681: D44078.id135069.diff
Tue, Nov 19, 4:31 PM
F102993540: D44078.diff
Tue, Nov 19, 2:29 PM
Unknown Object (File)
Mon, Nov 4, 11:18 PM
Unknown Object (File)
Mon, Nov 4, 11:18 PM
Unknown Object (File)
Sat, Nov 2, 10:38 PM
Unknown Object (File)
Sat, Nov 2, 10:38 PM
Unknown Object (File)
Sat, Nov 2, 10:38 PM
Unknown Object (File)
Sat, Nov 2, 10:38 PM

Details

Summary

Expanding documentation around bhyve

  • snapshot feature (experimental)
  • additional notice about persisting and changing network configuration and potential for locking oneself out
  • jailing bhyve

I should probably add, that I'm more than willing to remove the part on snapshots, because it's certainly very experimental. On the other hand, this might invite more people to test and try things out.

Feedback - as usual - very welcome!

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

emaste added inline comments.
documentation/content/en/books/handbook/virtualization/_index.adoc
507–513

We mention Intel and AMD; should we reference Arm as well?

Valid point on ARM - I've added a suggestion on ARM though I ain't an expert on the topic.
I got those infos from here: https://cgit.freebsd.org/src/commit/?id=47e073941f4e

freebsd_ny-central.org added inline comments.
documentation/content/en/books/handbook/virtualization/_index.adoc
507–513

Actually, now rereading what I wrote... this makes no sense. I'll change this again.

Restructured into a bullet point list; certainly better to read - hope the content is correct though.

Bunch of small things I spotted.

documentation/content/en/books/handbook/virtualization/_index.adoc
911
916

2nd-person pronoun use is discouraged.

955
962
1006
1013
1021
1029
1037

Shouldn't it be the same as the host's?

1042

Also, with 13.3 days from expected release, maybe wait a bit and use that as an example, for future-proofing?

1075
1080
1092
1153
1154
1199
1245
1250
1252
1265

For consistency with the actual examples

1285–1287

Why not pkg -j bhyve install bhyve-firmware?

This revision now requires changes to proceed.Mar 3 2024, 3:50 AM
freebsd_ny-central.org marked 20 inline comments as done.

Updated after feedback. Thanks for the great inputs!

A few typos remain, but getting close, I think.

documentation/content/en/books/handbook/virtualization/_index.adoc
911

"additionally" and "reasonably" misspelled.

955

Spurious "if you"

Thanks for spotting those. I really need to run a spellcheck before I submit things. Apologies for the extra round.
Added additional typo and comma fixes and improvements for brevity.

This revision is now accepted and ready to land.Mar 16 2024, 5:27 PM
documentation/content/en/books/handbook/virtualization/_index.adoc
573–574
793

Does this sound clearer?

818
819–820

I removed instances of the second person as Pau Amma requested in other reviews and suggested an alternative wording.

827
868
871
876
902
910
911
931
944–954

Would it be better to link to Quick Start section of the Updating and Upgrading FreeBSD chapter? The shell source at the top is nearly the same as here.

Thanks for the feedback. I've merged all suggested changes and also

  • removed a few more "you" statements to a more neutral version
  • added a note/recommendation on using UEFI vars file w/ Linux to prevent having to rename boot files
This revision now requires review to proceed.Apr 27 2024, 1:46 PM

@freebsd_ny-central.org, this looks ready to me. Could you rebase your changes on top of the latest main after 3c1326a472ca67ff6159d644589ab5e5bfc1258c? Then we can commit.

Thanks,

Joe

What do you think about this commit log?

Handbook/Virtualization: Expand bhyve documentation

Notable changes:

- describe the experimental snapshot feature
- add notice about persisting and changing network configuration and the
  potential for locking oneself out
- describe jailing bhyve
- improve wording throughout the page

Reviewed by:    emaste, jrm, Pau Amma <pauamma@gundo.com>
Differential Revision:  https://reviews.freebsd.org/D44078

LGTM. Thanks for your help in getting this finalized!

This revision was not accepted when it landed; it landed in state Needs Review.May 29 2024, 5:21 PM
This revision was automatically updated to reflect the committed changes.