Doc improvements #311
Doc improvements #311
Conversation
Reviewer's GuideThis PR enriches and reorganizes the documentation by refactoring the README structure (adding Usage, Presentations, and Adopters sections), clarifying bootloader-specific kernel requirements, and extending the usage guide with networking integration details for gvisor-tap-vsock and vmnet-helper. Flow Diagram: vfkit Kernel Requirement Check on Apple Siliconflowchart TD
A["Start vfkit"] --> B{"Is hardware Apple Silicon?"};
B -- "No" --> F["Proceed with boot<br/>(no special kernel requirement)"];
B -- "Yes" --> C{"Bootloader option is 'linux'?"};
C -- "No (e.g., 'efi')" --> F;
C -- "Yes" --> D{"Is kernel uncompressed?"};
D -- "Yes" --> F;
D -- "No" --> E["Error: vfkit requires uncompressed kernel<br/>with 'linux' bootloader on Apple Silicon"];
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @cfergeau - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
|
||
| The `--device virtio-net` option adds a network interface to the virtual machine. If it gets its IP address through DHCP, its IP can be found in `/var/db/dhcpd_leases` on the host. | ||
|
|
||
| vfkit only supports NAT networking on its own. However, it integrates with [gvisor-tap-vsock](https://github.com/containers/gvisor-tap-vsock) for a user-mode networking stack, and [vmnet-helper](https://github.com/nirs/vmnet-helper) for shared/bridged/host networking through vmnet. |
There was a problem hiding this comment.
Looks good high level overview, but users will need an example to understand how to actually use this.
I have this example:
https://github.com/nirs/vmnet-helper/blob/main/examples/vfkit.sh
Maybe we can have simple examples here for vment-helper and gvproxy? This can also be in an examples/ directory.
There was a problem hiding this comment.
There is a brief gvproxy example here, but even this one could be more detailed
It makes more sense to me to add examples to https://github.com/crc-org/vfkit/tree/main/contrib/scripts as you suggested, I’ll look into it.
Clarify a few things, reorder some sections, … Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
These technical details will be easier to find at more relevant places in usage.md rather than at the end of README.md Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
This lists the higher level projects which are using vfkit. This fixes crc-org#302 Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
This fixes crc-org#291 Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
|
@nirs: changing LGTM is restricted to collaborators DetailsIn response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: nirs The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
2 participants
This adds a list of adopters (podman/minikube/…), and mentions gvisor-tap-vsock and vmnet-helper.
Summary by Sourcery
Expand project documentation with additional sections and clarifications
Documentation: